1 #ifndef ERF_PROBCOMMON_H_
2 #define ERF_PROBCOMMON_H_
4 #include <AMReX_ParmParse.H>
5 #include <AMReX_Geometry.H>
6 #include <AMReX_FArrayBox.H>
7 #include <AMReX_MultiFab.H>
24 if (std::getline(is, line)) {
25 std::stringstream ss(line);
28 amrex::Abort(
"Failed to read");
31 amrex::Print() <<
"Trying to read line " << n <<
" in this file " << std::endl;
32 amrex::Abort(
"Wrong format: more than one number in this line");
35 amrex::Abort(
"Unable to read this line");
42 amrex::FArrayBox& terrain_fab,
67 std::unique_ptr<amrex::MultiFab>& ,
68 std::unique_ptr<amrex::MultiFab>& ,
69 amrex::Geometry
const& )
71 amrex::Print() <<
"Hydrostatically balanced density was NOT set"
72 <<
" -- an appropriate init_type should probably have been specified"
73 <<
" (e.g., input_sounding, WRFInput, or Metgrid)"
75 amrex::Error(
"Should never call erf_init_dens_hse for "+
name()+
" problem");
80 std::unique_ptr<amrex::MultiFab>& ,
81 amrex::Geometry
const& )
114 amrex::Array4<amrex::Real const>
const& ,
115 amrex::Array4<amrex::Real >
const& ,
116 amrex::Array4<amrex::Real >
const& ,
117 amrex::Array4<amrex::Real >
const& ,
118 amrex::Array4<amrex::Real >
const& ,
119 amrex::Array4<amrex::Real >
const& ,
120 amrex::Array4<amrex::Real >
const& ,
121 amrex::Array4<amrex::Real const>
const& ,
122 amrex::Array4<amrex::Real const>
const& ,
123 amrex::GeometryData
const& ,
124 amrex::Array4<amrex::Real const>
const& ,
125 amrex::Array4<amrex::Real const>
const& ,
126 amrex::Array4<amrex::Real const>
const& ,
130 amrex::Print() <<
"No perturbation to background fields supplied for "
131 <<
name() <<
" problem" << std::endl;
145 amrex::MultiFab* src,
146 const amrex::Geometry& ,
147 std::unique_ptr<amrex::MultiFab>& )
149 if (src->empty())
return;
151 amrex::Warning(
"Temperature forcing not defined for "+
name()+
" problem");
152 for ( amrex::MFIter mfi(*src, amrex::TilingIfNotGPU()); mfi.isValid(); ++mfi )
154 const auto &box = mfi.tilebox();
155 const amrex::Array4<amrex::Real>& src_arr = src->array(mfi);
158 ParallelFor(box, [=] AMREX_GPU_DEVICE (
int i,
int j,
int k) noexcept {
161 src_arr(i, j, k) = 0.0;
177 amrex::MultiFab* qsrc,
178 const amrex::Geometry& ,
179 std::unique_ptr<amrex::MultiFab>& )
181 if (qsrc->empty())
return;
183 amrex::Warning(
"Moisture forcing not defined for "+
name()+
" problem");
184 for ( amrex::MFIter mfi(*qsrc, amrex::TilingIfNotGPU()); mfi.isValid(); ++mfi )
186 const auto &box = mfi.tilebox();
187 const amrex::Array4<amrex::Real>& qsrc_arr = qsrc->array(mfi);
190 ParallelFor(box, [=] AMREX_GPU_DEVICE (
int i,
int j,
int k) noexcept {
193 qsrc_arr(i, j, k) = 0.0;
212 amrex::Vector<amrex::Real>&
wbar,
213 amrex::Gpu::DeviceVector<amrex::Real>& d_wbar,
214 const amrex::MultiFab& ,
215 const amrex::Geometry& geom,
216 std::unique_ptr<amrex::MultiFab>& )
218 if (
wbar.empty())
return;
220 amrex::Warning(
"Moisture forcing not defined for "+
name()+
" problem");
222 const int khi = geom.Domain().bigEnd()[2];
225 for (
int k = 0; k <= khi; k++)
233 amrex::Gpu::copy(amrex::Gpu::hostToDevice,
wbar.begin(),
wbar.end(), d_wbar.begin());
247 amrex::Vector<amrex::Real>& u_geos,
248 amrex::Gpu::DeviceVector<amrex::Real>& d_u_geos,
249 amrex::Vector<amrex::Real>& v_geos,
250 amrex::Gpu::DeviceVector<amrex::Real>& d_v_geos,
251 const amrex::Geometry& geom,
252 std::unique_ptr<amrex::MultiFab>& )
254 if (u_geos.empty())
return;
256 amrex::Warning(
"Geostrophic wind profile not defined for "+
name()+
" problem");
258 const int khi = geom.Domain().bigEnd()[2];
261 for (
int k = 0; k <= khi; k++)
270 amrex::Gpu::copy(amrex::Gpu::hostToDevice, u_geos.begin(), u_geos.end(), d_u_geos.begin());
271 amrex::Gpu::copy(amrex::Gpu::hostToDevice, v_geos.begin(), v_geos.end(), d_v_geos.begin());
283 amrex::FArrayBox& buildings_fab,
288 amrex::ParmParse
pp(
"erf");
289 auto valid_fname =
pp.query(
"buildings_file_name",fname);
308 amrex::FArrayBox& terrain_fab,
312 std::string fname, fname_usgs;
313 amrex::ParmParse
pp(
"erf");
314 auto valid_fname =
pp.query(
"terrain_file_name",fname);
315 auto valid_fname_USGS =
pp.query(
"terrain_file_name_USGS",fname_usgs);
323 }
else if (valid_fname_USGS) {
335 const amrex::Geometry& geom,
336 amrex::FArrayBox& terrain_fab,
339 amrex::Vector<amrex::Real> m_xterrain,m_yterrain,m_zterrain;
341 int nx = 0;
int ny = 0;
343 if (amrex::ParallelDescriptor::IOProcessor()) {
345 amrex::Print()<<
"Reading terrain file: "<< fname<< std::endl;
346 std::ifstream file(fname);
348 if (!file.is_open()) {
349 amrex::Abort(
"Error: Could not open the file " + fname+
"\n");
353 if (file.peek() == std::ifstream::traits_type::eof()) {
354 amrex::Abort(
"Error: The file " + fname+
" is empty.\n");
362 file >> lon_min >> lat_min;
363 if(std::fabs(lon_min) > 180.0) {
364 amrex::Error(
"The value of longitude for entry in the first line in " + fname
365 +
" should not exceed 180. It is " + std::to_string(lon_min));
367 if(std::fabs(lat_min) > 90.0) {
368 amrex::Error(
"The value of latitude for entry in the first line in " + fname
369 +
" should not exceed 90. It is " + std::to_string(lat_min));
375 while (file >> value1 >> value2 >> value3) {
376 m_xterrain.push_back(value1);
378 m_yterrain.push_back(value2);
380 m_zterrain.push_back(value3);
383 AMREX_ASSERT(m_xterrain.size() ==
static_cast<long int>(nx*ny));
384 AMREX_ASSERT(m_yterrain.size() ==
static_cast<long int>(ny));
385 AMREX_ASSERT(m_zterrain.size() ==
static_cast<long int>(nx*ny));
389 nx = erf_get_single_value<int>(file,cnt); cnt++;
390 ny = erf_get_single_value<int>(file,cnt); cnt++;
391 amrex::Print()<<
"Expecting " << nx <<
" values of x, " <<
392 ny <<
" values of y, and " <<
393 nx*ny <<
" values of z" << std::endl;
394 AMREX_ALWAYS_ASSERT(nx > 0);
395 AMREX_ALWAYS_ASSERT(ny > 0);
396 m_xterrain.resize(nx);
397 m_yterrain.resize(ny);
398 m_zterrain.resize(nx * ny);
399 for (
int n = 0; n < nx; n++) {
400 m_xterrain[n] = erf_get_single_value<amrex::Real>(file,cnt);
403 for (
int n = 0; n < ny; n++) {
404 m_yterrain[n] = erf_get_single_value<amrex::Real>(file,cnt);
407 for (
int n = 0; n < nx * ny; n++) {
408 m_zterrain[n] = erf_get_single_value<amrex::Real>(file,cnt);
417 amrex::ParallelDescriptor::Bcast(&nx,1,amrex::ParallelDescriptor::IOProcessorNumber());
418 amrex::ParallelDescriptor::Bcast(&ny,1,amrex::ParallelDescriptor::IOProcessorNumber());
422 m_xterrain.resize(nx);
423 m_yterrain.resize(ny);
424 m_zterrain.resize(nz);
426 amrex::ParallelDescriptor::Bcast(m_xterrain.data(),nx,amrex::ParallelDescriptor::IOProcessorNumber());
427 amrex::ParallelDescriptor::Bcast(m_yterrain.data(),ny,amrex::ParallelDescriptor::IOProcessorNumber());
428 amrex::ParallelDescriptor::Bcast(m_zterrain.data(),nz,amrex::ParallelDescriptor::IOProcessorNumber());
431 amrex::Gpu::DeviceVector<amrex::Real> d_xterrain(nx),d_yterrain(ny),d_zterrain(nz);
432 amrex::Gpu::copy(amrex::Gpu::hostToDevice, m_xterrain.begin(), m_xterrain.end(), d_xterrain.begin());
433 amrex::Gpu::copy(amrex::Gpu::hostToDevice, m_yterrain.begin(), m_yterrain.end(), d_yterrain.begin());
434 amrex::Gpu::copy(amrex::Gpu::hostToDevice, m_zterrain.begin(), m_zterrain.end(), d_zterrain.begin());
440 auto dx = geom.CellSizeArray();
441 auto ProbLoArr = geom.ProbLoArray();
443 int ilo = geom.Domain().smallEnd(0);
444 int jlo = geom.Domain().smallEnd(1);
445 int klo = geom.Domain().smallEnd(2);
446 int ihi = geom.Domain().bigEnd(0) + 1;
447 int jhi = geom.Domain().bigEnd(1) + 1;
449 amrex::Box
zbx = terrain_fab.box();
450 amrex::Array4<amrex::Real>
const& z_arr = terrain_fab.array();
452 amrex::ParallelFor(
zbx, [=] AMREX_GPU_DEVICE (
int i,
int j,
int )
455 int ii = amrex::min(amrex::max(i,ilo),ihi);
456 int jj = amrex::min(amrex::max(j,jlo),jhi);
462 int ind11, ind12, ind21, ind22;
465 int iindex_terrain=-1;
466 int jindex_terrain=-1;
472 for (
int it = 0; it < ny && jindex_terrain == -1; it++) {
474 jindex_terrain = it-1;
477 if (jindex_terrain == -1) {
478 jindex_terrain = ny-1;
481 int gstart = (jindex_terrain )*nx;
482 int gend = (jindex_terrain+1)*nx-1;
483 for (
int it = gstart; it <= gend && iindex_terrain == -1; it++) {
485 iindex_terrain = it-gstart;
490 ind11 = jindex_terrain*nx + iindex_terrain;
497 y1 = d_yt[jindex_terrain];
498 y2 = d_yt[jindex_terrain+1];
507 z_arr(i,j,klo) = w_11*d_zt[ind11] + w_12*d_zt[ind12] + w_21*d_zt[ind21] + w_22*d_zt[ind22];
511 for (
int it = 0; it < ny && jindex_terrain == -1; it++) {
513 jindex_terrain = it-1;
516 if (jindex_terrain == -1) {
517 jindex_terrain = ny-1;
520 for (
int it = 0; it < nx && iindex_terrain == -1; it++) {
522 iindex_terrain = it-1;
525 if (iindex_terrain == -1) {
526 iindex_terrain = nx-1;
530 x1 = d_xt[iindex_terrain];
531 x2 = d_xt[iindex_terrain+1];
532 y1 = d_yt[jindex_terrain];
533 y2 = d_yt[jindex_terrain+1];
539 ind11 = iindex_terrain * ny + jindex_terrain;
540 ind21 = std::min(iindex_terrain+1,nx-1) * ny + jindex_terrain;
542 ind12 = iindex_terrain * ny + std::min(jindex_terrain+1,ny-1);
543 ind22 = std::min(iindex_terrain+1,nx-1) * ny + std::min(jindex_terrain+1,ny-1);
549 ind11 = jindex_terrain * nx + iindex_terrain;
550 ind12 = std::min(jindex_terrain+1,ny-1) * nx + iindex_terrain;
552 ind21 = jindex_terrain * nx + std::min(iindex_terrain+1,nx-1);
553 ind22 = std::min(jindex_terrain+1,ny-1) * nx + std::min(iindex_terrain+1,nx-1);
556 if (iindex_terrain == nx-1 && jindex_terrain == ny-1)
558 z_arr(i,j,klo) = d_zt[ind11];
560 else if (iindex_terrain != nx-1 && jindex_terrain == ny-1)
565 z_arr(i,j,klo) = (w_11*d_zt[ind11] + w_21*d_zt[ind21])/denom;
567 else if (iindex_terrain == nx-1 && jindex_terrain != ny-1)
572 z_arr(i,j,klo) = (w_11*d_zt[ind11] + w_12*d_zt[ind12])/denom;
581 z_arr(i,j,klo) = (w_11*d_zt[ind11] + w_12*d_zt[ind12] + w_21*d_zt[ind21] + w_22*d_zt[ind22]) / denom;
598 amrex::FArrayBox& terrain_fab,
601 std::string custom_terrain_type =
"None";
602 amrex::ParmParse pp_prob(
"prob"); pp_prob.query(
"custom_terrain_type",custom_terrain_type);
604 if (custom_terrain_type !=
"None")
606 amrex::Print() <<
"Calling custom terrain initialization" << std::endl;
610 amrex::Print() <<
"Initializing flat terrain" << std::endl;
611 terrain_fab.template setVal<amrex::RunOn::Device>(0.0);
615 amrex::Print() <<
"Resetting mesh type to StretchedDz" << std::endl;
620 #ifdef ERF_USE_TERRAIN_VELOCITY
623 amrex::Error(
"Should never call compute_terrain_velocity for "+
name()+
" problem");
636 amrex::Geometry
const& ,
637 std::unique_ptr<amrex::MultiFab>& ,
640 amrex::Error(
"Should never call erf_init_rayleigh for "+
name()+
" problem");
647 init_uniform (
const amrex::Box& bx, amrex::Array4<amrex::Real>
const& state)
651 amrex::Print() <<
"Initializing uniform fields"
652 <<
" rho=" << rho_0 <<
" theta=" << T_0
655 ParallelFor(bx, [=] AMREX_GPU_DEVICE (
int i,
int j,
int k) noexcept
675 std::string
name() { std::string prob_name; amrex::ParmParse
pp(
"erf");
pp.query(
"prob_name",prob_name);
return prob_name; }
684 const amrex_real* probhi) AMREX_ATTRIBUTE_WEAK;
@ wbar
Definition: ERF_DataStruct.H:97
#define Rho_comp
Definition: ERF_IndexDefines.H:36
#define RhoTheta_comp
Definition: ERF_IndexDefines.H:37
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real pp(amrex::Real y)
Definition: ERF_MicrophysicsUtils.H:233
T erf_get_single_value(std::istream &is, int n)
Definition: ERF_ProbCommon.H:20
void init_my_custom_terrain(const amrex::Geometry &geom, amrex::FArrayBox &terrain_fab, const amrex::Real &time)
std::unique_ptr< ProblemBase > amrex_probinit(const amrex_real *problo, const amrex_real *probhi) AMREX_ATTRIBUTE_WEAK
const Box zbx
Definition: ERF_SetupDiff.H:9
amrex::Real Real
Definition: ERF_ShocInterface.H:19
Definition: ERF_ProbCommon.H:49
virtual void init_custom_terrain(const amrex::Geometry &geom, amrex::FArrayBox &terrain_fab, const amrex::Real &time)
Definition: ERF_ProbCommon.H:597
virtual void update_w_subsidence(const amrex::Real &, amrex::Vector< amrex::Real > &wbar, amrex::Gpu::DeviceVector< amrex::Real > &d_wbar, const amrex::MultiFab &, const amrex::Geometry &geom, std::unique_ptr< amrex::MultiFab > &)
Definition: ERF_ProbCommon.H:211
virtual void update_rhoqt_sources(const amrex::Real &, amrex::MultiFab *qsrc, const amrex::Geometry &, std::unique_ptr< amrex::MultiFab > &)
Definition: ERF_ProbCommon.H:176
void init_uniform(const amrex::Box &bx, amrex::Array4< amrex::Real > const &state)
Definition: ERF_ProbCommon.H:647
void init_terrain_surface(const amrex::Geometry &geom, amrex::FArrayBox &terrain_fab, const amrex::Real &time)
Definition: ERF_ProbCommon.H:307
void read_custom_terrain(const std::string &fname, const bool is_usgs, const amrex::Geometry &geom, amrex::FArrayBox &terrain_fab, const amrex::Real &)
Definition: ERF_ProbCommon.H:333
void init_buildings_surface(const amrex::Geometry &geom, amrex::FArrayBox &buildings_fab, const amrex::Real &time)
Definition: ERF_ProbCommon.H:282
virtual void erf_init_rayleigh(amrex::Vector< amrex::Vector< amrex::Real > > &, amrex::Geometry const &, std::unique_ptr< amrex::MultiFab > &, amrex::Real)
Definition: ERF_ProbCommon.H:635
void init_base_parms(amrex::Real rho_0, amrex::Real T_0)
Definition: ERF_ProbCommon.H:670
virtual void update_rhotheta_sources(const amrex::Real &, amrex::MultiFab *src, const amrex::Geometry &, std::unique_ptr< amrex::MultiFab > &)
Definition: ERF_ProbCommon.H:144
virtual ~ProblemBase()=default
virtual void erf_init_dens_hse_moist(amrex::MultiFab &, std::unique_ptr< amrex::MultiFab > &, amrex::Geometry const &)
Definition: ERF_ProbCommon.H:79
std::string name()
Definition: ERF_ProbCommon.H:675
ProbParmDefaults base_parms
Definition: ERF_ProbCommon.H:664
virtual void init_custom_pert(const amrex::Box &, const amrex::Box &, const amrex::Box &, const amrex::Box &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real > const &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real const > const &, amrex::GeometryData const &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real const > const &, amrex::Array4< amrex::Real const > const &, const SolverChoice &, const int)
Definition: ERF_ProbCommon.H:110
virtual void erf_init_dens_hse(amrex::MultiFab &, std::unique_ptr< amrex::MultiFab > &, std::unique_ptr< amrex::MultiFab > &, amrex::Geometry const &)
Definition: ERF_ProbCommon.H:66
virtual void update_geostrophic_profile(const amrex::Real &, amrex::Vector< amrex::Real > &u_geos, amrex::Gpu::DeviceVector< amrex::Real > &d_u_geos, amrex::Vector< amrex::Real > &v_geos, amrex::Gpu::DeviceVector< amrex::Real > &d_v_geos, const amrex::Geometry &geom, std::unique_ptr< amrex::MultiFab > &)
Definition: ERF_ProbCommon.H:246
@ T
Definition: ERF_IndexDefines.H:110
Definition: ERF_ProbCommon.H:14
amrex::Real T_0
Definition: ERF_ProbCommon.H:16
amrex::Real rho_0
Definition: ERF_ProbCommon.H:15
Definition: ERF_DataStruct.H:129
static MeshType mesh_type
Definition: ERF_DataStruct.H:1048
static void set_mesh_type(MeshType new_mesh_type)
Definition: ERF_DataStruct.H:1051