ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ERF.H
Go to the documentation of this file.
1 #ifndef ERF_H_
2 #define ERF_H_
3 
4 #include <string>
5 #include <limits>
6 #include <memory>
7 
8 #ifdef _OPENMP
9 #include <omp.h>
10 #endif
11 
12 #include <AMReX_AmrCore.H>
13 #include <AMReX_BCRec.H>
14 #include <AMReX_Print.H>
15 
16 #include <AMReX_ParallelDescriptor.H>
17 #include <AMReX_ParmParse.H>
18 #include <AMReX_MultiFabUtil.H>
19 #include <AMReX_FillPatchUtil.H>
20 #include <AMReX_VisMF.H>
21 #include <AMReX_PhysBCFunct.H>
22 #include <AMReX_YAFluxRegister.H>
23 #include <AMReX_ErrorList.H>
24 #include <AMReX_EBFabFactory.H>
25 #include <AMReX_EBMultiFabUtil.H>
26 
27 #include <ERF_EB.H>
28 
29 #ifdef ERF_USE_FFT
30 #include <AMReX_FFT_Poisson.H>
31 #endif
32 
33 #ifdef AMREX_MEM_PROFILING
34 #include <AMReX_MemProfiler.H>
35 #endif
36 
37 #include "ERF_ProbCommon.H"
38 
39 #include <ERF_IndexDefines.H>
40 #include <ERF_DataStruct.H>
41 #include <ERF_TurbPertStruct.H>
42 #include <ERF_InputSoundingData.H>
43 #include <ERF_InputSpongeData.H>
44 #include <ERF_SurfaceLayer.H>
45 #include <ERF_Derive.H>
46 #include <ERF_ReadBndryPlanes.H>
47 #include <ERF_WriteBndryPlanes.H>
48 #include <ERF_MRI.H>
49 #include <ERF_PhysBCFunct.H>
50 #include <ERF_FillPatcher.H>
51 #include <ERF_SampleData.H>
52 #include <ERF_ForestDrag.H>
53 
54 #ifdef ERF_USE_PARTICLES
55 #include "ERF_ParticleData.H"
56 #endif
57 
60 #include "ERF_LandSurface.H"
61 #ifdef ERF_USE_WINDFARM
62 #include "ERF_WindFarm.H"
63 #endif
64 
65 #ifdef ERF_USE_RRTMGP
66 #include "ERF_Radiation.H"
67 #endif
68 
69 #include <iostream>
70 
71 #ifdef AMREX_LAZY
72 #include <AMReX_Lazy.H>
73 #endif
74 
75 #ifndef AMREX_USE_MPI
76 using amrex::MPI_COMM_WORLD;
77 using amrex::MPI_Comm;
78 #endif
79 
80 #ifdef ERF_USE_MULTIBLOCK
81 class MultiBlockContainer;
82 #endif
83 
84 /**
85  * Enum of possible interpolation types between coarse/fine
86 */
87 AMREX_ENUM(StateInterpType,
88  FullState, Perturbational
89 );
90 
91 /**
92  * Enum of possible plotfile types
93 */
94 AMREX_ENUM(PlotFileType,
95  None, Amrex, Netcdf
96 );
97 
98 /**
99  * Main class in ERF code, instantiated from main.cpp
100 */
101 
102 class ERF
103  : public amrex::AmrCore
104 {
105 public:
106 
107  ////////////////
108  // public member functions
109 
110  // constructor - reads in parameters from inputs file
111  // - sizes multilevel arrays and data structures
112  ERF ();
113  ~ERF () override;
114 
115  void ERF_shared ();
116 
117  // Declare a default move constructor so we ensure the destructor is
118  // not called when we return an object of this class by value
119  ERF (ERF&&) noexcept = delete;
120 
121  // Declare a default move assignment operator
122  ERF& operator=(ERF&& other) noexcept = delete;
123 
124  // Delete the copy constructor
125  ERF (const ERF& other) = delete;
126  //
127  // Delete the copy assignment operator
128  ERF& operator=(const ERF& other) = delete;
129 
130  // Advance solution to final time
131  void Evolve ();
132 
133  // Tag cells for refinement
134  void ErrorEst (int lev, amrex::TagBoxArray& tags, amrex::Real time, int ngrow) override;
135 
136  // Refinement criteria for hurricanes
137  void HurricaneTracker(int lev,
138  const amrex::MultiFab& U_new,
139  const amrex::MultiFab& V_new,
140  const amrex::MultiFab& W_new,
141  const amrex::Real velmag_threshold,
142  const bool is_track_io,
143  amrex::TagBoxArray* tags = nullptr);
144 
145  // Hurricane track line output as VTKPolyline
146  amrex::Vector<std::array<amrex::Real, 2>> hurricane_track_xy;
147  std::string MakeVTKFilename(int nstep);
148  void WriteVTKPolyline(const std::string& filename,
149  amrex::Vector<std::array<amrex::Real, 2>>& points_xy);
150 
151  // Initialize multilevel data
152  void InitData ();
153 
154  // Initialize multilevel data before MultiBlock
155  void InitData_pre ();
156 
157  // Initialize multilevel data after MultiBlock
158  void InitData_post ();
159 
160  void WriteMyEBSurface ();
161 
162  // Compute the divergence -- whether EB, no-terrain, flat terrain or general terrain
163  void compute_divergence (int lev, amrex::MultiFab& rhs, amrex::Array<amrex::MultiFab const*,AMREX_SPACEDIM> rho0_u_const,
164  amrex::Geometry const& geom_at_lev);
165 
166  // Project the velocities to be divergence-free -- this is only relevant if anelastic == 1
167  void project_velocities (int lev, amrex::Real dt, amrex::Vector<amrex::MultiFab >& vars);
168 
169  // Project the velocities to be divergence-free with a thin body
170  void project_velocities_tb (int lev, amrex::Real dt, amrex::Vector<amrex::MultiFab >& vars);
171 
172  // Calculate wall distance by solving a Poisson equation
173  void poisson_wall_dist (int lev);
174 
175 #ifdef ERF_USE_FFT
176  void solve_with_fft (int lev, amrex::MultiFab& rhs, amrex::MultiFab& p,
177  amrex::Array<amrex::MultiFab,AMREX_SPACEDIM>& fluxes);
178 #endif
179  void solve_with_EB_mlmg (int lev, amrex::Vector<amrex::MultiFab>& rhs, amrex::Vector<amrex::MultiFab>& p,
180  amrex::Vector<amrex::Array<amrex::MultiFab,AMREX_SPACEDIM>>& fluxes);
181 
182  void solve_with_gmres (int lev, amrex::Vector<amrex::MultiFab>& rhs, amrex::Vector<amrex::MultiFab>& p,
183  amrex::Vector<amrex::Array<amrex::MultiFab,AMREX_SPACEDIM>>& fluxes);
184  void solve_with_mlmg (int lev, amrex::Vector<amrex::MultiFab>& rhs, amrex::Vector<amrex::MultiFab>& p,
185  amrex::Vector<amrex::Array<amrex::MultiFab,AMREX_SPACEDIM>>& fluxes);
186 
187  void ImposeBCsOnPhi (int lev, amrex::MultiFab& phi);
188 
189  // Define the projection bc's based on the domain bc types
190  amrex::Array<amrex::LinOpBCType,AMREX_SPACEDIM>
191  get_projection_bc (amrex::Orientation::Side side) const noexcept;
192  bool projection_has_dirichlet (amrex::Array<amrex::LinOpBCType,AMREX_SPACEDIM> bcs) const;
193 
194  // Init (NOT restart or regrid)
195  void init_only (int lev, amrex::Real time);
196 
197  // Restart
198  void restart ();
199 
200  // Is it time to write a plotfile or checkpoint?
201  bool writeNow (const amrex::Real cur_time, const amrex::Real dt, const int nstep,
202  const int plot_int, const amrex::Real plot_per);
203 
204  // Called after every level 0 timestep
205  void post_timestep (int nstep, amrex::Real time, amrex::Real dt_lev);
206 
207  // Diagnostics
208  void sum_integrated_quantities (amrex::Real time);
209  void sum_derived_quantities (amrex::Real time);
210  void sum_energy_quantities (amrex::Real time);
211 
212  void write_1D_profiles (amrex::Real time);
213  void write_1D_profiles_stag (amrex::Real time);
214 
215  amrex::Real cloud_fraction (amrex::Real time);
216 
217  // Fill the physical boundary conditions for cell-centered velocity (diagnostic only)
218  void FillBdyCCVels (amrex::Vector<amrex::MultiFab>& mf_cc_vel, int levc=0);
219 
220  void sample_points (int lev, amrex::Real time, amrex::IntVect cell, amrex::MultiFab& mf);
221  void sample_lines (int lev, amrex::Real time, amrex::IntVect cell, amrex::MultiFab& mf);
222 
223  void derive_diag_profiles (amrex::Real time,
224  amrex::Gpu::HostVector<amrex::Real>& h_avg_u , amrex::Gpu::HostVector<amrex::Real>& h_avg_v,
225  amrex::Gpu::HostVector<amrex::Real>& h_avg_w , amrex::Gpu::HostVector<amrex::Real>& h_avg_rho,
226  amrex::Gpu::HostVector<amrex::Real>& h_avg_th , amrex::Gpu::HostVector<amrex::Real>& h_avg_ksgs,
227  amrex::Gpu::HostVector<amrex::Real>& h_avg_Kmv , amrex::Gpu::HostVector<amrex::Real>& h_avg_Khv,
228  amrex::Gpu::HostVector<amrex::Real>& h_avg_qv , amrex::Gpu::HostVector<amrex::Real>& h_avg_qc,
229  amrex::Gpu::HostVector<amrex::Real>& h_avg_qr ,
230  amrex::Gpu::HostVector<amrex::Real>& h_avg_wqv , amrex::Gpu::HostVector<amrex::Real>& h_avg_wqc,
231  amrex::Gpu::HostVector<amrex::Real>& h_avg_wqr ,
232  amrex::Gpu::HostVector<amrex::Real>& h_avg_qi , amrex::Gpu::HostVector<amrex::Real>& h_avg_qs,
233  amrex::Gpu::HostVector<amrex::Real>& h_avg_qg ,
234  amrex::Gpu::HostVector<amrex::Real>& h_avg_uu , amrex::Gpu::HostVector<amrex::Real>& h_avg_uv,
235  amrex::Gpu::HostVector<amrex::Real>& h_avg_uw,
236  amrex::Gpu::HostVector<amrex::Real>& h_avg_vv , amrex::Gpu::HostVector<amrex::Real>& h_avg_vw,
237  amrex::Gpu::HostVector<amrex::Real>& h_avg_ww,
238  amrex::Gpu::HostVector<amrex::Real>& h_avg_uth , amrex::Gpu::HostVector<amrex::Real>& h_avg_vth,
239  amrex::Gpu::HostVector<amrex::Real>& h_avg_wth, amrex::Gpu::HostVector<amrex::Real>& h_avg_thth,
240  amrex::Gpu::HostVector<amrex::Real>& h_avg_ku, amrex::Gpu::HostVector<amrex::Real>& h_avg_kv,
241  amrex::Gpu::HostVector<amrex::Real>& h_avg_kw,
242  amrex::Gpu::HostVector<amrex::Real>& h_avg_p,
243  amrex::Gpu::HostVector<amrex::Real>& h_avg_pu, amrex::Gpu::HostVector<amrex::Real>& h_avg_pv,
244  amrex::Gpu::HostVector<amrex::Real>& h_avg_pw, amrex::Gpu::HostVector<amrex::Real>& h_avg_wthv);
245  void derive_diag_profiles_stag (amrex::Real time,
246  amrex::Gpu::HostVector<amrex::Real>& h_avg_u , amrex::Gpu::HostVector<amrex::Real>& h_avg_v,
247  amrex::Gpu::HostVector<amrex::Real>& h_avg_w , amrex::Gpu::HostVector<amrex::Real>& h_avg_rho,
248  amrex::Gpu::HostVector<amrex::Real>& h_avg_th , amrex::Gpu::HostVector<amrex::Real>& h_avg_ksgs,
249  amrex::Gpu::HostVector<amrex::Real>& h_avg_Kmv , amrex::Gpu::HostVector<amrex::Real>& h_avg_Khv,
250  amrex::Gpu::HostVector<amrex::Real>& h_avg_qv , amrex::Gpu::HostVector<amrex::Real>& h_avg_qc,
251  amrex::Gpu::HostVector<amrex::Real>& h_avg_qr ,
252  amrex::Gpu::HostVector<amrex::Real>& h_avg_wqv , amrex::Gpu::HostVector<amrex::Real>& h_avg_wqc,
253  amrex::Gpu::HostVector<amrex::Real>& h_avg_wqr ,
254  amrex::Gpu::HostVector<amrex::Real>& h_avg_qi , amrex::Gpu::HostVector<amrex::Real>& h_avg_qs,
255  amrex::Gpu::HostVector<amrex::Real>& h_avg_qg ,
256  amrex::Gpu::HostVector<amrex::Real>& h_avg_uu , amrex::Gpu::HostVector<amrex::Real>& h_avg_uv,
257  amrex::Gpu::HostVector<amrex::Real>& h_avg_uw,
258  amrex::Gpu::HostVector<amrex::Real>& h_avg_vv , amrex::Gpu::HostVector<amrex::Real>& h_avg_vw,
259  amrex::Gpu::HostVector<amrex::Real>& h_avg_ww,
260  amrex::Gpu::HostVector<amrex::Real>& h_avg_uth , amrex::Gpu::HostVector<amrex::Real>& h_avg_vth,
261  amrex::Gpu::HostVector<amrex::Real>& h_avg_wth, amrex::Gpu::HostVector<amrex::Real>& h_avg_thth,
262  amrex::Gpu::HostVector<amrex::Real>& h_avg_ku, amrex::Gpu::HostVector<amrex::Real>& h_avg_kv,
263  amrex::Gpu::HostVector<amrex::Real>& h_avg_kw,
264  amrex::Gpu::HostVector<amrex::Real>& h_avg_p,
265  amrex::Gpu::HostVector<amrex::Real>& h_avg_pu, amrex::Gpu::HostVector<amrex::Real>& h_avg_pv,
266  amrex::Gpu::HostVector<amrex::Real>& h_avg_pw, amrex::Gpu::HostVector<amrex::Real>& h_avg_wthv);
267 
268  void derive_stress_profiles (amrex::Gpu::HostVector<amrex::Real>& h_avg_tau11, amrex::Gpu::HostVector<amrex::Real>& h_avg_tau12,
269  amrex::Gpu::HostVector<amrex::Real>& h_avg_tau13, amrex::Gpu::HostVector<amrex::Real>& h_avg_tau22,
270  amrex::Gpu::HostVector<amrex::Real>& h_avg_tau23, amrex::Gpu::HostVector<amrex::Real>& h_avg_tau33,
271  amrex::Gpu::HostVector<amrex::Real>& h_avg_hfx3, amrex::Gpu::HostVector<amrex::Real>& h_avg_q1fx3,
272  amrex::Gpu::HostVector<amrex::Real>& h_avg_q2fx3, amrex::Gpu::HostVector<amrex::Real>& h_avg_diss);
273  void derive_stress_profiles_stag (amrex::Gpu::HostVector<amrex::Real>& h_avg_tau11, amrex::Gpu::HostVector<amrex::Real>& h_avg_tau12,
274  amrex::Gpu::HostVector<amrex::Real>& h_avg_tau13, amrex::Gpu::HostVector<amrex::Real>& h_avg_tau22,
275  amrex::Gpu::HostVector<amrex::Real>& h_avg_tau23, amrex::Gpu::HostVector<amrex::Real>& h_avg_tau33,
276  amrex::Gpu::HostVector<amrex::Real>& h_avg_hfx3, amrex::Gpu::HostVector<amrex::Real>& h_avg_q1fx3,
277  amrex::Gpu::HostVector<amrex::Real>& h_avg_q2fx3, amrex::Gpu::HostVector<amrex::Real>& h_avg_diss);
278 
279  // Perform the volume-weighted sum
280  amrex::Real
281  volWgtSumMF (int lev, const amrex::MultiFab& mf, int comp,
282  const amrex::MultiFab& mapfac, bool finemask);
283 
284  // Decide if it is time to take an action
285  static bool is_it_time_for_action (int nstep, amrex::Real time, amrex::Real dt,
286  int action_interval, amrex::Real action_per);
287 
288  // Make a new level using provided BoxArray and DistributionMapping and
289  // fill with interpolated coarse level data.
290  // overrides the pure virtual function in AmrCore
291  void MakeNewLevelFromCoarse (int lev, amrex::Real time, const amrex::BoxArray& ba,
292  const amrex::DistributionMapping& dm) override;
293 
294  // Remake an existing level using provided BoxArray and DistributionMapping and
295  // fill with existing fine and coarse data.
296  // overrides the pure virtual function in AmrCore
297  void RemakeLevel (int lev, amrex::Real time, const amrex::BoxArray& ba,
298  const amrex::DistributionMapping& dm) override;
299 
300  // Delete level data
301  // overrides the pure virtual function in AmrCore
302  void ClearLevel (int lev) override;
303 
304  // Make a new level from scratch using provided BoxArray and DistributionMapping.
305  // Only used during initialization.
306  // overrides the pure virtual function in AmrCore
307  void MakeNewLevelFromScratch (int lev, amrex::Real time, const amrex::BoxArray& ba,
308  const amrex::DistributionMapping& dm) override;
309 
310  // compute dt from CFL considerations
311  amrex::Real estTimeStep (int lev, long& dt_fast_ratio) const;
312 
313 #ifdef ERF_USE_WW3_COUPLING
314  //amrex::Print() << " About to call send_to_ww3 from ERF.H" << std::endl;
315  void send_to_ww3(int lev);
316  //amrex::Print() << " About to call read_waves from ERF.H" << std::endl;
317  void read_waves(int lev);
318  //void send_to_ww3 (int lev);
319  //void read_waves (int lev);
320 
321  //void send_to_ww3 (int lev);
322 #endif
323 
324  // Interface for advancing the data at one level by one "slow" timestep
325  void advance_dycore (int level,
326  amrex::Vector<amrex::MultiFab>& state_old,
327  amrex::Vector<amrex::MultiFab>& state_new,
328  amrex::MultiFab& xvel_old, amrex::MultiFab& yvel_old, amrex::MultiFab& zvel_old,
329  amrex::MultiFab& xvel_new, amrex::MultiFab& yvel_new, amrex::MultiFab& zvel_new,
330  amrex::MultiFab& source, amrex::MultiFab& xmom_src,
331  amrex::MultiFab& ymom_src, amrex::MultiFab& zmom_src,
332  amrex::MultiFab& buoyancy, amrex::Geometry fine_geom,
333  amrex::Real dt, amrex::Real time);
334 
335  void advance_microphysics (int lev,
336  amrex::MultiFab& cons_in,
337  const amrex::Real& dt_advance,
338  const int& iteration,
339  const amrex::Real& time);
340 
341  void advance_lsm (int lev,
342  amrex::MultiFab& cons_in,
343  amrex::MultiFab& xvel_in,
344  amrex::MultiFab& yvel_in,
345  const amrex::Real& dt_advance);
346 
347 #if defined(ERF_USE_RRTMGP)
348  void advance_radiation (int lev,
349  amrex::MultiFab& cons_in,
350  const amrex::Real& dt_advance);
351 #endif
352 
353  amrex::MultiFab& build_fine_mask (int lev);
354 
355  void MakeHorizontalAverages ();
356  void MakeDiagnosticAverage (amrex::Vector<amrex::Real>& h_havg, amrex::MultiFab& S, int n);
357  void derive_upwp (amrex::Vector<amrex::Real>& h_havg);
358 
359  // Write plotfile to disk
360  void WritePlotFile (int which, PlotFileType plotfile_type, amrex::Vector<std::string> plot_var_names);
361 
362  // Write subvolume of data into a different "plotfile"
363  void WriteSubvolume ();
364 
365  void WriteMultiLevelPlotfileWithTerrain (const std::string &plotfilename,
366  int nlevels,
367  const amrex::Vector<const amrex::MultiFab*> &mf,
368  const amrex::Vector<const amrex::MultiFab*> &mf_nd,
369  const amrex::Vector<std::string> &varnames,
370  const amrex::Vector<amrex::Geometry>& my_geom,
371  amrex::Real time,
372  const amrex::Vector<int> &level_steps,
373  const amrex::Vector<amrex::IntVect>& my_ref_ratio,
374  const std::string &versionName = "HyperCLaw-V1.1",
375  const std::string &levelPrefix = "Level_",
376  const std::string &mfPrefix = "Cell",
377  const amrex::Vector<std::string>& extra_dirs = amrex::Vector<std::string>()) const;
378 
379 
380  void WriteGenericPlotfileHeaderWithTerrain (std::ostream &HeaderFile,
381  int nlevels,
382  const amrex::Vector<amrex::BoxArray> &bArray,
383  const amrex::Vector<std::string> &varnames,
384  const amrex::Vector<amrex::Geometry>& my_geom,
385  amrex::Real time,
386  const amrex::Vector<int> &level_steps,
387  const amrex::Vector<amrex::IntVect>& my_ref_ratio,
388  const std::string &versionName,
389  const std::string &levelPrefix,
390  const std::string &mfPrefix) const;
391 
392  void erf_enforce_hse (int lev,
393  amrex::MultiFab& dens, amrex::MultiFab& pres, amrex::MultiFab& pi,
394  amrex::MultiFab& th, amrex::MultiFab& qv,
395  std::unique_ptr<amrex::MultiFab>& z_cc);
396 
397 #ifdef ERF_USE_NETCDF
398  //! Write a timestep to 1D vertical column output for coupling
399  void writeToNCColumnFile (int lev,
400  const std::string& colfile_name, amrex::Real xloc, amrex::Real yloc,
401  amrex::Real time);
402 #endif //ERF_USE_NETCDF
403 
404  void init_from_input_sounding (int lev);
405 
406  void input_sponge (int lev);
407 
408  void init_from_hse (int lev);
409 
410  void init_thin_body (int lev, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm);
411 
412 #ifdef ERF_USE_MULTIBLOCK
413  // constructor used when ERF is created by a multiblock driver
414  // calls AmrCore constructor -> AmrMesh constructor
415  ERF (const amrex::RealBox& rb, int max_level_in,
416  const amrex::Vector<int>& n_cell_in, int coord,
417  const amrex::Vector<amrex::IntVect>& ref_ratio,
418  const amrex::Array<int,AMREX_SPACEDIM>& is_per,
419  std::string prefix);
420 
421  // Advance a block specified number of time steps
422  void Evolve_MB (int MBstep, int max_block_step);
423 
424  // get the current time values and dt
425  amrex::Real get_t_old (int lev) { return t_old[lev]; }
426  amrex::Real get_t_new (int lev) { return t_new[lev]; }
427  amrex::Real get_dt (int lev) { return dt[lev]; }
428 
429  // Set parmparse prefix for MultiBlock
430  void SetParmParsePrefix (std::string name) { pp_prefix = name; }
431 
432  // Set 'this' from multiblock container
433  void SetMultiBlockPointer (MultiBlockContainer *mbc) { m_mbc = mbc; }
434 
435  // Public data copy for MB
436  std::vector<amrex::Box> domain_p;
437 
438  // Primary solution data data containers
439  amrex::Vector<amrex::Vector<amrex::MultiFab> > vars_new;
440  amrex::Vector<amrex::Vector<amrex::MultiFab> > vars_old;
441 
442  // Velocity time averaged field
443  amrex::Vector<std::unique_ptr<amrex::MultiFab>> vel_t_avg;
444  amrex::Vector<amrex::Real> t_avg_cnt;
445 #endif
446 
447  std::string pp_prefix {"erf"};
448 
449  void fill_from_bndryregs (const amrex::Vector<amrex::MultiFab*>& mfs,
450  amrex::Real time);
451 
452 #ifdef ERF_USE_NETCDF
453  void fill_from_realbdy (const amrex::Vector<amrex::MultiFab*>& mfs,
454  amrex::Real time,
455  bool cons_only,
456  int icomp_cons,
457  int ncomp_cons,
458  amrex::IntVect ngvect_cons,
459  amrex::IntVect ngvect_vels);
460 #endif
461 
462 #ifdef ERF_USE_NETCDF
463  void init_from_wrfinput (int lev, amrex::MultiFab& mu_C1H, amrex::MultiFab& mu_C2H, amrex::MultiFab& mu_MUB);
464  void init_from_metgrid (int lev);
465  void init_from_ncfile (int lev);
466 #endif // ERF_USE_NETCDF
467 
468 #ifdef ERF_USE_WINDFARM
469  void init_windfarm(int lev);
470  void advance_windfarm (const amrex::Geometry& a_geom,
471  const amrex::Real& dt_advance,
472  amrex::MultiFab& cons_in,
473  amrex::MultiFab& U_old, amrex::MultiFab& V_old, amrex::MultiFab& W_old,
474  amrex::MultiFab& mf_vars_windfarm,
475  const amrex::MultiFab& mf_Nturb,
476  const amrex::MultiFab& mf_SMark,
477  const amrex::Real& time);
478 #endif
479 
480  void MakeEBGeometry ();
481  void make_eb_box ();
483 
484  // more flexible version of AverageDown() that lets you average down across multiple levels
485  void AverageDownTo (int crse_lev, int scomp, int ncomp); // NOLINT
486 
487  // write checkpoint file to disk
488  void WriteCheckpointFile () const;
489 
490  // read checkpoint file from disk
491  void ReadCheckpointFile ();
492 
493  // read checkpoint file from disk -- called after instantiating m_SurfaceLayer
495 
496  void init_zphys (int lev, amrex::Real time);
497  void remake_zphys (int lev, amrex::Real time, std::unique_ptr<amrex::MultiFab>& temp_zphys_nd);
498  void update_terrain_arrays (int lev);
499 
500 private:
501 
502  ///////////////////////////
503  // private member functions
504  ///////////////////////////
505 
506  // read in some parameters from inputs file
507  void ReadParameters ();
508  void ParameterSanityChecks ();
509 
510  // set covered coarse cells/faces to be the average of overlying fine cells/faces
511  void AverageDown ();
512 
513  void update_diffusive_arrays (int lev, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm);
514 
515  void Construct_ERFFillPatchers (int lev);
516 
517  void Define_ERFFillPatchers (int lev);
518 
519  void init1DArrays ();
520 
521  void init_bcs ();
522 
523  void init_custom (int lev);
524 
525  void init_uniform (int lev);
526 
527  void init_stuff (int lev, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm,
528  amrex::Vector<amrex::MultiFab>& lev_new, amrex::Vector<amrex::MultiFab>& lev_old,
529  amrex::MultiFab& tmp_base_state,
530  std::unique_ptr<amrex::MultiFab>& tmp_zphys_nd);
531 
532  // Initialize the Turbulent perturbation
533  void turbPert_update (const int lev, const amrex::Real dt);
534  void turbPert_amplitude (const int lev);
535 
536  // Initialize the integrator object
537  void initialize_integrator (int lev, amrex::MultiFab& cons_mf, amrex::MultiFab& vel_mf);
538 
539  // Create the physbcs objects
540  void make_physbcs (int lev);
541 
542  // Initialize the microphysics object
543  void initializeMicrophysics (const int&);
544 
545 #ifdef ERF_USE_WINDFARM
546  // Initialize the windfarm object
547  void initializeWindFarm (const int&);
548 #endif
549 
550  // Compute a vector of new MultiFabs by copying from valid region and filling ghost cells
551  //
552  // NOTE: FillPatch takes in an empty MF, and returns cell-centered + velocities (not momenta)
553  //
554  // This one works only at level = 0 (base state does not change)
555  void FillPatch (int lev, amrex::Real time,
556  const amrex::Vector<amrex::MultiFab*>& mfs_vel,
557  bool cons_only=false);
558 
559  // This one works only at level > 0 (base state does change)
560  void FillPatch (int lev, amrex::Real time,
561  const amrex::Vector<amrex::MultiFab*>& mfs_vel,
562  const amrex::Vector<amrex::MultiFab*>& mfs_mom,
563  const amrex::MultiFab& old_base_state,
564  const amrex::MultiFab& new_base_state,
565  bool fillset=true, bool cons_only=false);
566 
567  // Compute new multifabs by copying data from valid region and filling ghost cells.
568  // Unlike FillPatch, FillIntermediatePatch will use the supplied multifabs instead of fine level data.
569  // This is to support filling boundary cells at an intermediate time between old/new times
570  // on the fine level when valid data at a specific time is already available (such as
571  // at each RK stage when integrating between initial and final times at a given level).
572  //
573  // NOTE: FillIntermediatePatch takes in updated momenta, and returns both updated velocity and momenta
574  //
575  void FillIntermediatePatch (int lev, amrex::Real time,
576  const amrex::Vector<amrex::MultiFab*>& mfs_vel,
577  const amrex::Vector<amrex::MultiFab*>& mfs_mom,
578  int ng_cons, int ng_vel, bool cons_only, int icomp_cons, int ncomp_cons);
579 
580  // Fill all multifabs (and all components) in a vector of multifabs corresponding to the
581  // grid variables defined in vars_old and vars_new just as FillCoarsePatch.
582  void FillCoarsePatch (int lev, amrex::Real time);
583 
584  // advance a level by dt
585  // includes a recursive call for finer levels
586  void timeStep (int lev, amrex::Real time, int iteration);
587 
588  // advance a single level for a single time step
589  void Advance (int lev, amrex::Real time, amrex::Real dt_lev, int iteration, int ncycle);
590 
591  //! Initialize HSE
592  void initHSE ();
593  void initHSE (int lev);
594 
595  //! Initialize Rayleigh damping profiles
596  void initRayleigh ();
597 
598  //! Initialize sponge profiles
599  void initSponge ();
600 
601  //! Set Rayleigh mean profiles from input sounding
602  void setRayleighRefFromSounding (bool restarting);
603 
604  //! Set sponge mean profiles from input sounding
605  void setSpongeRefFromSounding (bool restarting);
606 
607  // a wrapper for estTimeStep()
608  void ComputeDt (int step = -1);
609 
610  // get plotfile name
611  [[nodiscard]] std::string PlotFileName (int lev) const;
612 
613  // set plotfile variables names
614  static amrex::Vector<std::string> PlotFileVarNames (amrex::Vector<std::string> plot_var_names) ;
615 
616  // set which variables and derived quantities go into plotfiles
617  void setPlotVariables (const std::string& pp_plot_var_names, amrex::Vector<std::string>& plot_var_names);
618  // append variables to plot
619  void appendPlotVariables (const std::string& pp_plot_var_names, amrex::Vector<std::string>& plot_var_names);
620 
621 #ifdef ERF_USE_NETCDF
622  //! Write plotfile using NETCDF
623  void writeNCPlotFile (int lev, int which, const std::string& dir,
624  const amrex::Vector<const amrex::MultiFab*> &mf,
625  const amrex::Vector<std::string> &plot_var_names,
626  const amrex::Vector<int>& level_steps, amrex::Real time) const;
627 
628  //! Write MultiFab in NetCDF format
629  static void WriteNCMultiFab (const amrex::FabArray<amrex::FArrayBox> &fab,
630  const std::string& name,
631  bool set_ghost = false) ;
632 
633  //! Create 1D vertical column output for coupling
634  void createNCColumnFile (int lev,
635  const std::string& colfile_name, amrex::Real xloc, amrex::Real yloc);
636 
637  // Copy from the NC*fabs into the MultiFabs holding the boundary data
638  void init_from_wrfbdy (amrex::Vector<amrex::FArrayBox*> x_vel_lateral,
639  amrex::Vector<amrex::FArrayBox*> y_vel_lateral,
640  amrex::Vector<amrex::FArrayBox*> z_vel_lateral,
641  amrex::Vector<amrex::FArrayBox*> T_lateral);
642 
643  amrex::Real start_bdy_time;
644  amrex::Real start_low_time;
645 
646  amrex::Real bdy_time_interval;
647  amrex::Real low_time_interval;
648 
649  // *** *** FArrayBox's for holding the SURFACE data
650  // amrex::IArrayBox NC_IVGTYP_fab; // Vegetation type (IVGTYP); Discrete numbers;
651  // amrex::FArrayBox NC_z0_fab; // Surface Roughness, z0 = z0 (IVGTYP)
652  // amrex::FArrayBox NC_PSFC_fab; // Surface pressure
653 
654  // TODO: Clarify the relation between SST and TSK
655  // amrex::FArrayBox NC_SST_fab; // Sea Surface Temperature; Defined even for land area
656  // amrex::FArrayBox NC_TSK_fab; // Surface Skin Temperature; Appears to be same as SST...
657 
658  // Vectors (over time) of Vector (over variables) of FArrayBoxs for holding the data read from the wrfbdy NetCDF file
659  amrex::Vector<amrex::Vector<amrex::FArrayBox>> bdy_data_xlo;
660  amrex::Vector<amrex::Vector<amrex::FArrayBox>> bdy_data_xhi;
661  amrex::Vector<amrex::Vector<amrex::FArrayBox>> bdy_data_ylo;
662  amrex::Vector<amrex::Vector<amrex::FArrayBox>> bdy_data_yhi;
663 
664  amrex::Vector<amrex::FArrayBox> low_data_zlo;
665 
666  amrex::Vector<std::unique_ptr<amrex::MultiFab>> lat_m, lon_m; // Latitude and Longitude on the grid
667 #endif // ERF_USE_NETCDF
668 
669  amrex::Vector<std::unique_ptr<amrex::MultiFab>> sinPhi_m, cosPhi_m; // Coriolis factors on the grid
670 
671  // Struct for working with the sounding data we take as an input
673 
674  // Struct for working with the sponge data we take as an input
676 
677  // Vector (6 planes) of DeviceVectors (ncell in plane) for Dirichlet BC data
678  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real>> xvel_bc_data;
679  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real>> yvel_bc_data;
680  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real>> zvel_bc_data;
681  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real>> th_bc_data;
682 
683  // Function to read and populate above vectors (if input file exists)
684  void init_Dirichlet_bc_data (const std::string input_file);
685 
686  // Read the file passed to amr.restart and use it as an initial condition for
687  // the current simulation. Supports a different number of components and
688  // ghost cells.
690 
691  // Initialize the new-time data at a level from the initial_data MultiFab
692  void InitializeLevelFromData (int lev, const amrex::MultiFab& initial_data);
693 
694  // utility to skip to next line in Header
695  static void GotoNextLine (std::istream& is);
696 
697  // Single level functions called by advance()
698  void post_update (amrex::MultiFab& state_mf, amrex::Real time, const amrex::Geometry& geom);
699  void fill_rhs (amrex::MultiFab& rhs_mf, const amrex::MultiFab& state_mf, amrex::Real time, const amrex::Geometry& geom);
700 
701  ////////////////
702  // private data members
703 
704  std::unique_ptr<ProblemBase> prob = nullptr; // problem-specific functions
705 
706  amrex::Vector<int> num_boxes_at_level; // how many boxes specified at each level by tagging criteria
707  amrex::Vector<int> num_files_at_level; // how many wrfinput files specified at each level
708  amrex::Vector<amrex::Vector<amrex::Box>> boxes_at_level; // the boxes specified at each level by tagging criteria
709 
710  amrex::Vector<int> istep; // which step?
711  amrex::Vector<int> nsubsteps; // how many substeps on each level?
712 
713  // keep track of old time, new time, and time step at each level
714  amrex::Vector<amrex::Real> t_new;
715  amrex::Vector<amrex::Real> t_old;
716  amrex::Vector<amrex::Real> dt;
717  amrex::Vector<long> dt_mri_ratio;
718 
719 #ifndef ERF_USE_MULTIBLOCK
720  // Array of multifabs to store the solution at each level of refinement;
721  // after advancing a level we use "swap".
722  amrex::Vector<amrex::Vector<amrex::MultiFab> > vars_new;
723  amrex::Vector<amrex::Vector<amrex::MultiFab> > vars_old;
724 
725  // Pressure gradient at each level
726  amrex::Vector<amrex::Vector<amrex::MultiFab> > gradp;
727 
728  // Velocity time averaged field
729  amrex::Vector<std::unique_ptr<amrex::MultiFab>> vel_t_avg;
730  amrex::Vector<amrex::Real> t_avg_cnt;
731 #endif
732  amrex::Vector<std::unique_ptr<MRISplitIntegrator<amrex::Vector<amrex::MultiFab> > > > mri_integrator_mem;
733 
734  amrex::Vector<amrex::MultiFab> pp_inc;
735 
736  // Vector over levels of routines to impose physical boundary conditions
737  amrex::Vector<std::unique_ptr<ERFPhysBCFunct_cons>> physbcs_cons;
738  amrex::Vector<std::unique_ptr<ERFPhysBCFunct_u>> physbcs_u;
739  amrex::Vector<std::unique_ptr<ERFPhysBCFunct_v>> physbcs_v;
740  amrex::Vector<std::unique_ptr<ERFPhysBCFunct_w>> physbcs_w;
741  amrex::Vector<std::unique_ptr<ERFPhysBCFunct_base>> physbcs_base;
742 
743  // Store primitive variable for MOST BC
744  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Theta_prim;
745  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Qv_prim;
746  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Qr_prim;
747 
748  // Scratch space for time integrator
749  amrex::Vector<amrex::MultiFab> rU_old;
750  amrex::Vector<amrex::MultiFab> rU_new;
751  amrex::Vector<amrex::MultiFab> rV_old;
752  amrex::Vector<amrex::MultiFab> rV_new;
753  amrex::Vector<amrex::MultiFab> rW_old;
754  amrex::Vector<amrex::MultiFab> rW_new;
755 
756  // amrex::Vector<amrex::MultiFab> xmom_crse_rhs;
757  // amrex::Vector<amrex::MultiFab> ymom_crse_rhs;
758  amrex::Vector<amrex::MultiFab> zmom_crse_rhs;
759 
760  std::unique_ptr<Microphysics> micro;
761  amrex::Vector<amrex::Vector<amrex::MultiFab*>> qmoist; // (lev,ncomp) rain_accum, snow_accum, graup_accum
762 
763  // Variables for wind farm parametrization models
764 
765 #ifdef ERF_USE_WINDFARM
766  std::unique_ptr<WindFarm> windfarm;
767  amrex::Vector<amrex::MultiFab> Nturb;
768  amrex::Vector<amrex::MultiFab> vars_windfarm; // Fitch: Vabs, Vabsdt, dudt, dvdt, dTKEdt
769  // EWP: dudt, dvdt, dTKEdt
770 
771  amrex::Vector<amrex::MultiFab> SMark; // A multifab that holds an integer corresponding
772  // to the number of the wind turbine to sample
773  // velocity upstream of the turbine
774 #endif
775 
777  amrex::Vector<amrex::Vector<amrex::MultiFab*>> lsm_data; // (lev,ncomp) Components: theta, q1, q2
778  amrex::Vector<amrex::Vector<amrex::MultiFab*>> lsm_flux; // (lev,ncomp) Components: theta, q1, q2
779 
780 #if defined(ERF_USE_RRTMGP)
781  amrex::Vector<std::unique_ptr<Radiation>> rad;
782  amrex::Vector<std::unique_ptr<amrex::MultiFab>> qheating_rates; // radiation heating rate source terms
783 
784  // Containers for additional SLM inputs
785  amrex::Vector<std::unique_ptr<amrex::MultiFab>> sw_lw_fluxes; // Direct SW (visible, NIR), Diffuse SW (visible, NIR), LW flux
786  amrex::Vector<std::unique_ptr<amrex::MultiFab>> solar_zenith; // Solar zenith angle
787 
788  bool plot_rad = false;
789 #endif
790 
791  // Fillpatcher classes for coarse-fine boundaries
792  int cf_width{0};
793  int cf_set_width{0};
794  amrex::Vector<ERFFillPatcher> FPr_c;
795  amrex::Vector<ERFFillPatcher> FPr_u;
796  amrex::Vector<ERFFillPatcher> FPr_v;
797  amrex::Vector<ERFFillPatcher> FPr_w;
798 
799  // Diffusive stresses and Smag
800  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>> Tau;
801  amrex::Vector<std::unique_ptr<amrex::MultiFab>> eddyDiffs_lev;
802  amrex::Vector<std::unique_ptr<amrex::MultiFab>> SmnSmn_lev;
803 
804  // Sea Surface Temps, Skin Temperature and Land Masks (lev, ntimes)
805  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>> sst_lev;
806  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>> tsk_lev;
807  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::iMultiFab>>> lmask_lev;
808 
809  // Other SFS terms
810  amrex::Vector<std::unique_ptr<amrex::MultiFab>> SFS_hfx1_lev, SFS_hfx2_lev, SFS_hfx3_lev;
811  amrex::Vector<std::unique_ptr<amrex::MultiFab>> SFS_diss_lev;
812  amrex::Vector<std::unique_ptr<amrex::MultiFab>> SFS_q1fx1_lev, SFS_q1fx2_lev, SFS_q1fx3_lev;
813  amrex::Vector<std::unique_ptr<amrex::MultiFab>> SFS_q2fx3_lev;
814 
815  // Grid stretching
816  amrex::Vector<amrex::Vector<amrex::Real>> zlevels_stag; // nominal height levels
817 
818  // Data structures for terrain-fitted coordinates
819  amrex::Vector<std::unique_ptr<amrex::MultiFab>> z_phys_nd;
820  amrex::Vector<std::unique_ptr<amrex::MultiFab>> z_phys_cc;
821 
822  amrex::Vector<std::unique_ptr<amrex::MultiFab>> detJ_cc;
823  amrex::Vector<std::unique_ptr<amrex::MultiFab>> ax;
824  amrex::Vector<std::unique_ptr<amrex::MultiFab>> ay;
825  amrex::Vector<std::unique_ptr<amrex::MultiFab>> az;
826 
827  amrex::Vector<std::unique_ptr<amrex::MultiFab>> z_phys_nd_src;
828  amrex::Vector<std::unique_ptr<amrex::MultiFab>> detJ_cc_src;
829  amrex::Vector<std::unique_ptr<amrex::MultiFab>> ax_src;
830  amrex::Vector<std::unique_ptr<amrex::MultiFab>> ay_src;
831  amrex::Vector<std::unique_ptr<amrex::MultiFab>> az_src;
832 
833  amrex::Vector<std::unique_ptr<amrex::MultiFab>> z_phys_nd_new;
834  amrex::Vector<std::unique_ptr<amrex::MultiFab>> detJ_cc_new;
835 
836  amrex::Vector<std::unique_ptr<amrex::MultiFab>> z_t_rk;
837 
838  // Data structures for terrain immersed forcing
839  amrex::Vector<std::unique_ptr<amrex::MultiFab>> terrain_blanking;
840 
841  // Wall distance function
842  amrex::Vector<std::unique_ptr<amrex::MultiFab>> walldist;
843 
844  // Map scale factors -- vector across levels of vector across types
845  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>> mapfac;
846 
847  amrex::Vector<amrex::Vector<amrex::Real>> stretched_dz_h;
848  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real>> stretched_dz_d;
849 
850  amrex::Vector<amrex::MultiFab> base_state;
851  amrex::Vector<amrex::MultiFab> base_state_new;
852 
853  // Wave coupling data
854  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Hwave;
855  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Lwave;
856  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Hwave_onegrid;
857  amrex::Vector<std::unique_ptr<amrex::MultiFab>> Lwave_onegrid;
858  bool finished_wave = false;
859 
860  // array of flux registers
861  amrex::Vector<amrex::YAFluxRegister*> advflux_reg;
862 
863  // A BCRec is essentially a 2*DIM integer array storing the boundary
864  // condition type at each lo/hi walls in each direction. We have one BCRec
865  // for each component of the cell-centered variables and each velocity component.
866  amrex::Vector <amrex::BCRec> domain_bcs_type;
867  amrex::Gpu::DeviceVector<amrex::BCRec> domain_bcs_type_d;
868 
869  // We store these so that we can print them out in the job_info file
870  amrex::Array<std::string,2*AMREX_SPACEDIM> domain_bc_type;
871 
872  // These hold the Dirichlet values at walls which need them ...
873  amrex::Array<amrex::Array<amrex::Real, AMREX_SPACEDIM*2>, AMREX_SPACEDIM+NBCVAR_max> m_bc_extdir_vals;
874 
875  // These hold the Neumann values at walls which need them ...
876  amrex::Array<amrex::Array<amrex::Real, AMREX_SPACEDIM*2>, AMREX_SPACEDIM+NBCVAR_max> m_bc_neumann_vals;
877 
878  // These are the "physical" boundary condition types (e.g. "inflow")
879  amrex::GpuArray<ERF_BC, AMREX_SPACEDIM*2> phys_bc_type;
880 
881  // These are the masks for the thin immersed body
882  amrex::Vector<std::unique_ptr<amrex::iMultiFab>> xflux_imask;
883  amrex::Vector<std::unique_ptr<amrex::iMultiFab>> yflux_imask;
884  amrex::Vector<std::unique_ptr<amrex::iMultiFab>> zflux_imask;
885  //amrex::Vector<std::unique_ptr<amrex::iMultiFab>> overset_imask;
886 
887  // These are the body forces that result from the thin immersed body
888  amrex::Vector<std::unique_ptr<amrex::MultiFab>> thin_xforce;
889  amrex::Vector<std::unique_ptr<amrex::MultiFab>> thin_yforce;
890  amrex::Vector<std::unique_ptr<amrex::MultiFab>> thin_zforce;
891 
895 
898 
899  // Output control
900  const int datwidth = 14;
901  const int datprecision = 6;
902  const int timeprecision = 13; // e.g., 1-yr LES: 31,536,000 s with dt ~ 0.01 ==> min prec = 10
903  // epoch time for 2030-01-01 00:00:00 is 1,893,456,000 s with dt ~ 0.01 ==> min prec = 12
904 
905  ////////////////
906  // runtime parameters
907 
908  // maximum number of steps and stop time
909  int max_step = std::numeric_limits<int>::max();
910  amrex::Real start_time = 0.0;
911  amrex::Real stop_time = std::numeric_limits<amrex::Real>::max();
912 
913  bool use_datetime = false;
914  const std::string datetime_format = "%Y-%m-%d %H:%M:%S";
915 
916  // if >= 0 we restart from a checkpoint
917  std::string restart_chkfile = "";
918 
919  // Time step controls
920  static amrex::Real cfl;
921  static amrex::Real sub_cfl;
922  static amrex::Real init_shrink;
923  static amrex::Real change_max;
924  static amrex::Real dt_max_initial;
925  static amrex::Real dt_max;
926 
927  // Fixed dt for level 0 timesteps (only used if positive)
928  amrex::Vector<amrex::Real> fixed_dt;
929  amrex::Vector<amrex::Real> fixed_fast_dt;
930  static int fixed_mri_dt_ratio;
931 
932  // how often each level regrids the higher levels of refinement
933  // (after a level advances that many time steps)
934  int regrid_int = -1;
935 
936  // Should we regrid level 0 after restart if Ngrids < Nprocs or
937  // max_grid_size has changed?
939 
940  // plotfile prefix and frequency
941  std::string plot_file_1 {"plt_1_"};
942  std::string plot_file_2 {"plt_2_"};
943  std::string subvol_file {"subvol"};
945  int m_plot_int_1 = -1;
946  int m_plot_int_2 = -1;
947  int m_subvol_int = -1;
948  amrex::Real m_plot_per_1 = -1.0;
949  amrex::Real m_plot_per_2 = -1.0;
950  amrex::Real m_subvol_per = -1.0;
951  bool m_plot_face_vels = false;
952 
953  bool plot_lsm = false;
954 
955  // other sampling output control
956  int profile_int = -1;
957  bool destag_profiles = true;
958 
959  // Checkpoint type, prefix and frequency
960  std::string check_file {"chk"};
961  int m_check_int = -1;
962  amrex::Real m_check_per = -1.0;
963 
964  amrex::Vector<std::string> plot_var_names_1;
965  amrex::Vector<std::string> plot_var_names_2;
966  const amrex::Vector<std::string> cons_names {"density", "rhotheta", "rhoKE", "rhoadv_0",
967  "rhoQ1", "rhoQ2", "rhoQ3",
968  "rhoQ4", "rhoQ5", "rhoQ6"};
969 
970  // Note that the order of variable names here must match the order in ERF_Derive.cpp
971  const amrex::Vector<std::string> derived_names {"soundspeed", "temp", "theta", "KE", "scalar",
972  "vorticity_x","vorticity_y","vorticity_z",
973  "magvel", "divU",
974  "pres_hse", "dens_hse", "theta_hse", "pressure", "pert_pres", "pert_dens",
975  "eq_pot_temp", "num_turb", "SMark0", "SMark1",
976  "dpdx", "dpdy", "dpdz", "pres_hse_x", "pres_hse_y",
977  "z_phys", "detJ" , "mapfac", "lat_m", "lon_m",
978  // Time averaged velocity
979  "u_t_avg", "v_t_avg", "w_t_avg", "umag_t_avg",
980  // eddy viscosity
981  "nut",
982  // eddy diffusivity of momentum
983  "Kmv","Kmh",
984  // eddy diffusivity of heat
985  "Khv","Khh",
986  // turbulence lengthscale
987  "Lturb",
988  // wall distance
989  "walldist",
990  // dissipation
991  "diss",
992  // moisture vars
993  "moist_density", "qt", "qv", "qc", "qi", "qp", "qrain", "qsnow", "qgraup", "qsat",
994  "rain_accum", "snow_accum", "graup_accum",
995  // Terrain IB mask
996  "terrain_IB_mask",
997  // EB variables
998  "volfrac"
999 #ifdef ERF_COMPUTE_ERROR
1000  // error vars
1001  ,"xvel_err", "yvel_err", "zvel_err", "pp_err"
1002 #endif
1003 #ifdef ERF_USE_RRTMGP
1004  ,"qsrc_sw", "qsrc_lw"
1005 #endif
1006  };
1007 
1008  // algorithm choices
1010 
1011  // Turbulent perturbation structure
1013 
1014 #ifdef ERF_USE_PARTICLES
1015  // Particle container with all particle species
1016  ParticleData particleData;
1017 
1018  // variables and functions for tracers particles
1019  bool m_use_tracer_particles; /*!< tracer particles that advect with flow */
1020  bool m_use_hydro_particles; /*!< tracer particles that fall with gravity */
1021 
1022  /*! Read tracer and hydro particles parameters */
1023  void readTracersParams();
1024 
1025  /*! Initialize tracer and hydro particles */
1026  void initializeTracers ( amrex::ParGDBBase*,
1027  const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& );
1028 
1029  /*! Restart tracer and hydro particles */
1030  void restartTracers ( amrex::ParGDBBase*, const std::string& );
1031 
1032  /*! Evolve tracers and hydro particles */
1033  void evolveTracers( int,
1034  amrex::Real,
1035  amrex::Vector<amrex::Vector<amrex::MultiFab>>&,
1036  const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& );
1037 
1038 #endif
1039 
1040 #ifdef ERF_USE_MULTIBLOCK
1041  MultiBlockContainer *m_mbc = nullptr;
1042 #endif
1043 
1044  static int verbose;
1045  static int mg_verbose;
1046  static bool use_fft;
1047 
1048  // Diagnostic output interval
1049  static int sum_interval;
1050  static int pert_interval;
1051  static amrex::Real sum_per;
1052 
1053  // Write in native AMReX or NetCDF format for each plotfile
1054  static PlotFileType plotfile_type_1;
1055  static PlotFileType plotfile_type_2;
1056 
1057  static StateInterpType interpolation_type;
1058 
1059  // sponge_type: "input_sponge"
1060  static std::string sponge_type;
1061 
1062  // NetCDF initialization (wrfinput) file
1063  static amrex::Vector<amrex::Vector<std::string>> nc_init_file;
1064 
1065  // NetCDF initialization (wrfbdy/met_em) file
1066  static std::string nc_bdy_file;
1067  int real_width{0};
1069 
1070  // NetCDF initialization of zlo boundary values
1071  static std::string nc_low_file;
1072 
1073  // Flag to trigger initialization from input_sounding like WRF's ideal.exe
1074  // used with init_type == InitType::Input_Sounding
1075  static bool init_sounding_ideal;
1076 
1077  // Options for vertical interpolation of met_em*.nc data.
1080  bool metgrid_debug_dry{false};
1081  bool metgrid_debug_psfc{false};
1082  bool metgrid_debug_msf{false};
1086  bool metgrid_use_sfc{true};
1087  bool metgrid_retain_sfc{false};
1088  amrex::Real metgrid_proximity{500.0};
1091 
1092  amrex::Vector<amrex::BoxArray> ba1d;
1093  amrex::Vector<amrex::BoxArray> ba2d;
1094  amrex::Vector<std::unique_ptr<amrex::MultiFab>> mf_C1H;
1095  amrex::Vector<std::unique_ptr<amrex::MultiFab>> mf_C2H;
1096  amrex::Vector<std::unique_ptr<amrex::MultiFab>> mf_MUB;
1097 
1098  // 1D CDF output (for ingestion in AMR-Wind)
1099  static int output_1d_column;
1100  static int column_interval;
1101  static amrex::Real column_per;
1102  static amrex::Real column_loc_x;
1103  static amrex::Real column_loc_y;
1104  static std::string column_file_name;
1105 
1106  // 2D BndryRegister output (for ingestion in AMR-Wind)
1109  static amrex::Real bndry_output_planes_per;
1111 
1112  // 2D BndryRegister input
1114 
1115  static int ng_dens_hse;
1116  static int ng_pres_hse;
1117 
1118  // Custom source terms
1119  amrex::Vector< amrex::Vector<amrex::Real> > h_rhotheta_src;
1120  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > d_rhotheta_src;
1121 
1122  amrex::Vector< amrex::Vector<amrex::Real> > h_rhoqt_src;
1123  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > d_rhoqt_src;
1124 
1125  amrex::Vector< amrex::Vector<amrex::Real> > h_w_subsid;
1126  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > d_w_subsid;
1127 
1128  amrex::Vector< amrex::Vector<amrex::Real> > h_u_geos;
1129  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > d_u_geos;
1130 
1131  amrex::Vector< amrex::Vector<amrex::Real> > h_v_geos;
1132  amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > d_v_geos;
1133 
1134  // Function to read and populate above host vectors (if input file exists)
1135  void init_geo_wind_profile (const std::string input_file,
1136  amrex::Vector<amrex::Real>& u_geos,
1137  amrex::Gpu::DeviceVector<amrex::Real>& u_geos_d,
1138  amrex::Vector<amrex::Real>& v_geos,
1139  amrex::Gpu::DeviceVector<amrex::Real>& v_geos_d,
1140  const amrex::Geometry& lgeom,
1141  const amrex::Vector<amrex::Real>& zlev_stag);
1142 
1143  // This is a vector over levels of vectors across quantities of Vectors
1144  amrex::Vector<amrex::Vector< amrex::Vector<amrex::Real> > > h_rayleigh_ptrs;
1145 
1146  // This is a vector over levels of vectors across quantities of Vectors
1147  amrex::Vector<amrex::Vector< amrex::Vector<amrex::Real> > > h_sponge_ptrs;
1148 
1149  // This is a vector over levels of vectors across quantities of DeviceVectors
1150  amrex::Vector<amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > > d_rayleigh_ptrs;
1151 
1152  // This is a vector over levels of vectors across quantities of DeviceVectors
1153  amrex::Vector<amrex::Vector<amrex::Gpu::DeviceVector<amrex::Real> > > d_sponge_ptrs;
1154 
1155  amrex::Vector<amrex::Real> h_havg_density;
1156  amrex::Vector<amrex::Real> h_havg_temperature;
1157  amrex::Vector<amrex::Real> h_havg_pressure;
1158  amrex::Vector<amrex::Real> h_havg_qv;
1159  amrex::Vector<amrex::Real> h_havg_qc;
1160 
1161  amrex::Gpu::DeviceVector<amrex::Real> d_havg_density;
1162  amrex::Gpu::DeviceVector<amrex::Real> d_havg_temperature;
1163  amrex::Gpu::DeviceVector<amrex::Real> d_havg_pressure;
1164  amrex::Gpu::DeviceVector<amrex::Real> d_havg_qv;
1165  amrex::Gpu::DeviceVector<amrex::Real> d_havg_qc;
1166 
1167  void refinement_criteria_setup ();
1168 
1169  std::unique_ptr<WriteBndryPlanes> m_w2d = nullptr;
1170  std::unique_ptr<ReadBndryPlanes> m_r2d = nullptr;
1171  std::unique_ptr<SurfaceLayer> m_SurfaceLayer = nullptr;
1172  amrex::Vector<std::unique_ptr<ForestDrag>> m_forest_drag;
1173 
1174  //
1175  // Holds info for dynamically generated tagging criteria
1176  //
1177  static amrex::Vector<amrex::AMRErrorTag> ref_tags;
1178 
1179  //
1180  // Build a mask that zeroes out values on a coarse level underlying
1181  // grids on the next finest level
1182  //
1183  amrex::MultiFab fine_mask;
1184 
1185  amrex::Vector<amrex::Real> dz_min;
1186 
1187  static AMREX_FORCE_INLINE
1188  int
1190  {
1191  int ngrow = 0;
1192 
1193  if (sc.use_num_diff)
1194  {
1195  ngrow = 3;
1196  } else {
1197  if (
1204  { ngrow = 3; }
1205  else if (
1212  { ngrow = 3; }
1213  else if (
1222  { ngrow = 3; }
1223  else if (
1232  { ngrow = 4; }
1233  else
1234  {
1235  if (sc.terrain_type == TerrainType::EB){
1236  ngrow = 3;
1237  } else {
1238  ngrow = 2;
1239  }
1240  }
1241  }
1242 
1243  return ngrow;
1244  }
1245 
1246  AMREX_FORCE_INLINE
1247  amrex::YAFluxRegister* getAdvFluxReg (int lev)
1248  {
1249  return advflux_reg[lev];
1250  }
1251 
1252  AMREX_FORCE_INLINE
1253  std::ostream&
1254  DataLog (int i)
1255  {
1256  return *datalog[i];
1257  }
1258 
1259  AMREX_FORCE_INLINE
1260  std::ostream&
1261  DerDataLog (int i)
1262  {
1263  return *der_datalog[i];
1264  }
1265 
1266  AMREX_FORCE_INLINE
1267  int
1268  NumDataLogs () noexcept
1269  {
1270  return datalog.size();
1271  }
1272 
1273  AMREX_FORCE_INLINE
1274  int
1275  NumDerDataLogs () noexcept
1276  {
1277  return der_datalog.size();
1278  }
1279 
1280 
1281  AMREX_FORCE_INLINE
1282  std::ostream&
1284  {
1285  return *sampleptlog[i];
1286  }
1287 
1288  AMREX_FORCE_INLINE
1289  int
1291  {
1292  return sampleptlog.size();
1293  }
1294 
1295  AMREX_FORCE_INLINE
1296  std::ostream&
1298  {
1299  return *samplelinelog[i];
1300  }
1301 
1302  AMREX_FORCE_INLINE
1303  int
1304  NumSampleLineLogs () noexcept
1305  {
1306  return samplelinelog.size();
1307  }
1308 
1309  amrex::IntVect&
1310  SamplePoint (int i)
1311  {
1312  return samplepoint[i];
1313  }
1314 
1315  AMREX_FORCE_INLINE
1316  int
1317  NumSamplePoints () noexcept
1318  {
1319  return samplepoint.size();
1320  }
1321 
1322  amrex::IntVect&
1323  SampleLine (int i)
1324  {
1325  return sampleline[i];
1326  }
1327 
1328  AMREX_FORCE_INLINE
1329  int
1330  NumSampleLines () noexcept
1331  {
1332  return sampleline.size();
1333  }
1334 
1335  static amrex::Real startCPUTime;
1336  static amrex::Real previousCPUTimeUsed;
1337 
1338  static amrex::Real
1340  {
1341  int numCores = amrex::ParallelDescriptor::NProcs();
1342 #ifdef _OPENMP
1343  numCores = numCores * omp_get_max_threads();
1344 #endif
1345 
1346  amrex::Real T =
1347  numCores * (amrex::ParallelDescriptor::second() - startCPUTime) +
1349 
1350  return T;
1351  }
1352 
1353  void setRecordDataInfo (int i, const std::string& filename) // NOLINT
1354  {
1355  if (amrex::ParallelDescriptor::IOProcessor())
1356  {
1357  datalog[i] = std::make_unique<std::fstream>();
1358  datalog[i]->open(filename.c_str(),std::ios::out|std::ios::app);
1359  if (!datalog[i]->good()) {
1360  amrex::FileOpenFailed(filename);
1361  }
1362  }
1363  amrex::ParallelDescriptor::Barrier("ERF::setRecordDataInfo");
1364  }
1365 
1366  void setRecordDerDataInfo (int i, const std::string& filename) // NOLINT
1367  {
1368  if (amrex::ParallelDescriptor::IOProcessor())
1369  {
1370  der_datalog[i] = std::make_unique<std::fstream>();
1371  der_datalog[i]->open(filename.c_str(),std::ios::out|std::ios::app);
1372  if (!der_datalog[i]->good()) {
1373  amrex::FileOpenFailed(filename);
1374  }
1375  }
1376  amrex::ParallelDescriptor::Barrier("ERF::setRecordDerDataInfo");
1377  }
1378 
1379  void setRecordEnergyDataInfo (int i, const std::string& filename) // NOLINT
1380  {
1381  if (amrex::ParallelDescriptor::IOProcessor())
1382  {
1383  tot_e_datalog[i] = std::make_unique<std::fstream>();
1384  tot_e_datalog[i]->open(filename.c_str(),std::ios::out|std::ios::app);
1385  if (!tot_e_datalog[i]->good()) {
1386  amrex::FileOpenFailed(filename);
1387  }
1388  }
1389  amrex::ParallelDescriptor::Barrier("ERF::setRecordEnergyDataInfo");
1390  }
1391 
1392  void setRecordSamplePointInfo (int i, int lev, amrex::IntVect& cell, const std::string& filename) // NOLINT
1393  {
1394  amrex::MultiFab dummy(grids[lev],dmap[lev],1,0);
1395  for (amrex::MFIter mfi(dummy); mfi.isValid(); ++mfi)
1396  {
1397  const amrex::Box& bx = mfi.validbox();
1398  if (bx.contains(cell)) {
1399  sampleptlog[i] = std::make_unique<std::fstream>();
1400  sampleptlog[i]->open(filename.c_str(),std::ios::out|std::ios::app);
1401  if (!sampleptlog[i]->good()) {
1402  amrex::FileOpenFailed(filename);
1403  }
1404  }
1405  }
1406  amrex::ParallelDescriptor::Barrier("ERF::setRecordSamplePointInfo");
1407  }
1408 
1409  void setRecordSampleLineInfo (int i, int lev, amrex::IntVect& cell, const std::string& filename) // NOLINT
1410  {
1411  amrex::MultiFab dummy(grids[lev],dmap[lev],1,0);
1412  for (amrex::MFIter mfi(dummy); mfi.isValid(); ++mfi)
1413  {
1414  const amrex::Box& bx = mfi.validbox();
1415  if (bx.contains(cell)) {
1416  samplelinelog[i] = std::make_unique<std::fstream>();
1417  samplelinelog[i]->open(filename.c_str(),std::ios::out|std::ios::app);
1418  if (!samplelinelog[i]->good()) {
1419  amrex::FileOpenFailed(filename);
1420  }
1421  }
1422  }
1423  amrex::ParallelDescriptor::Barrier("ERF::setRecordSampleLineInfo");
1424  }
1425 
1426  // Data sampler for line and plane output
1428  amrex::Real sampler_per = -1.0;
1429  std::unique_ptr<SampleData> data_sampler = nullptr;
1430 
1431  amrex::Vector<std::unique_ptr<std::fstream> > datalog;
1432  amrex::Vector<std::unique_ptr<std::fstream> > der_datalog;
1433  amrex::Vector<std::unique_ptr<std::fstream> > tot_e_datalog;
1434  amrex::Vector<std::string> datalogname;
1435  amrex::Vector<std::string> der_datalogname;
1436  amrex::Vector<std::string> tot_e_datalogname;
1437 
1438  amrex::Vector<std::unique_ptr<std::fstream> > sampleptlog;
1439  amrex::Vector<std::string> sampleptlogname;
1440  amrex::Vector<amrex::IntVect> samplepoint;
1441 
1442  amrex::Vector<std::unique_ptr<std::fstream> > samplelinelog;
1443  amrex::Vector<std::string> samplelinelogname;
1444  amrex::Vector<amrex::IntVect> sampleline;
1445 
1446  //! The filename of the ith datalog file.
1447  [[nodiscard]] std::string DataLogName (int i) const noexcept { return datalogname[i]; }
1448  [[nodiscard]] std::string DerDataLogName (int i) const noexcept { return der_datalogname[i]; }
1449 
1450  //! The filename of the ith sampleptlog file.
1451  [[nodiscard]] std::string SamplePointLogName (int i) const noexcept { return sampleptlogname[i]; }
1452 
1453  //! The filename of the ith samplelinelog file.
1454  [[nodiscard]] std::string SampleLineLogName (int i) const noexcept { return samplelinelogname[i]; }
1455 
1456  // array of EB objects
1457  amrex::Vector<std::unique_ptr<eb_>> eb;
1458 
1459  [[nodiscard]] eb_ const& get_eb (int lev) const noexcept {
1460  AMREX_ASSERT(lev >= 0 && lev < eb.size() && eb[lev] != nullptr);
1461  return *eb[lev];
1462  }
1463 
1464  [[nodiscard]] amrex::EBFArrayBoxFactory const&
1465  EBFactory (int lev) const noexcept {
1466  return *(eb[lev]->get_const_factory());
1467  }
1468 
1469  [[nodiscard]] static int nghost_eb_basic ()
1470  { return 5; }
1471 
1472  // We need 5 for doing StateRedistribution; otherwise 4 would be enough
1473  [[nodiscard]] static int nghost_eb_volume ()
1474  { return 5; }
1475 
1476  [[nodiscard]] static int nghost_eb_full ()
1477  { return 4; }
1478 
1479 #ifdef ERF_USE_FFT
1480  amrex::Vector<std::unique_ptr<amrex::FFT::Poisson<amrex::MultiFab>>> m_3D_poisson;
1481  amrex::Vector<std::unique_ptr<amrex::FFT::PoissonHybrid<amrex::MultiFab>>> m_2D_poisson;
1482 #endif
1483 
1484 public:
1485  void writeJobInfo (const std::string& dir) const;
1486  static void writeBuildInfo (std::ostream& os);
1487 
1488  static void print_banner(MPI_Comm /*comm*/, std::ostream& /*out*/);
1489  static void print_usage(MPI_Comm /*comm*/, std::ostream& /*out*/);
1490  static void print_error(MPI_Comm /*comm*/, const std::string& msg);
1491  static void print_summary(std::ostream&);
1492  static void print_tpls(std::ostream& /*out*/);
1493 };
1494 
1495 #endif
AMREX_ENUM(StateInterpType, FullState, Perturbational)
Contains the Eulerian microphysics class.
#define NBCVAR_max
Definition: ERF_IndexDefines.H:29
@ Centered_6th
Contains the Lagrangian microphysics class.
Definition: ERF.H:104
void MakeHorizontalAverages()
Definition: ERF.cpp:1933
amrex::Vector< amrex::MultiFab > rU_new
Definition: ERF.H:750
int last_check_file_step
Definition: ERF.H:896
amrex::Vector< std::unique_ptr< amrex::MultiFab > > walldist
Definition: ERF.H:842
void initRayleigh()
Initialize Rayleigh damping profiles.
Definition: ERF_InitRayleigh.cpp:14
bool metgrid_basic_linear
Definition: ERF.H:1084
amrex::Vector< amrex::Vector< amrex::Box > > boxes_at_level
Definition: ERF.H:708
amrex::Vector< std::string > samplelinelogname
Definition: ERF.H:1443
void MakeEBGeometry()
int max_step
Definition: ERF.H:909
bool metgrid_debug_msf
Definition: ERF.H:1082
AMREX_FORCE_INLINE std::ostream & DerDataLog(int i)
Definition: ERF.H:1261
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab > > > mapfac
Definition: ERF.H:845
void FillBdyCCVels(amrex::Vector< amrex::MultiFab > &mf_cc_vel, int levc=0)
Definition: ERF_FillBdyCCVels.cpp:11
void setRayleighRefFromSounding(bool restarting)
Set Rayleigh mean profiles from input sounding.
Definition: ERF_InitRayleigh.cpp:55
int last_plot_file_step_2
Definition: ERF.H:893
amrex::Vector< std::unique_ptr< MRISplitIntegrator< amrex::Vector< amrex::MultiFab > > > > mri_integrator_mem
Definition: ERF.H:732
void Evolve()
Definition: ERF.cpp:412
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > d_rhotheta_src
Definition: ERF.H:1120
amrex::Vector< amrex::MultiFab > pp_inc
Definition: ERF.H:734
void make_eb_box()
amrex::Vector< ERFFillPatcher > FPr_u
Definition: ERF.H:795
amrex::Real cloud_fraction(amrex::Real time)
Definition: ERF_WriteScalarProfiles.cpp:395
amrex::Vector< amrex::IntVect > sampleline
Definition: ERF.H:1444
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_q1fx3_lev
Definition: ERF.H:812
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Hwave_onegrid
Definition: ERF.H:856
amrex::Vector< amrex::Vector< amrex::MultiFab > > vars_new
Definition: ERF.H:722
ERF(ERF &&) noexcept=delete
AMREX_FORCE_INLINE int NumSampleLineLogs() noexcept
Definition: ERF.H:1304
static void print_tpls(std::ostream &)
Definition: ERF_ConsoleIO.cpp:137
amrex::Vector< amrex::Real > dz_min
Definition: ERF.H:1185
std::string DataLogName(int i) const noexcept
The filename of the ith datalog file.
Definition: ERF.H:1447
static PlotFileType plotfile_type_1
Definition: ERF.H:1054
amrex::Vector< std::unique_ptr< amrex::MultiFab > > thin_yforce
Definition: ERF.H:889
void ErrorEst(int lev, amrex::TagBoxArray &tags, amrex::Real time, int ngrow) override
Definition: ERF_Tagging.cpp:15
std::string plot_file_2
Definition: ERF.H:942
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_hfx3_lev
Definition: ERF.H:810
amrex::Vector< amrex::Vector< amrex::Real > > h_w_subsid
Definition: ERF.H:1125
static void print_banner(MPI_Comm, std::ostream &)
Definition: ERF_ConsoleIO.cpp:60
amrex::Vector< std::unique_ptr< std::fstream > > datalog
Definition: ERF.H:1431
static amrex::Real sum_per
Definition: ERF.H:1051
amrex::Vector< ERFFillPatcher > FPr_v
Definition: ERF.H:796
int cf_set_width
Definition: ERF.H:793
static amrex::Real previousCPUTimeUsed
Definition: ERF.H:1336
void setPlotVariables(const std::string &pp_plot_var_names, amrex::Vector< std::string > &plot_var_names)
Definition: ERF_Plotfile.cpp:14
amrex::Gpu::DeviceVector< amrex::Real > d_havg_temperature
Definition: ERF.H:1162
amrex::Vector< amrex::Vector< amrex::Vector< amrex::Real > > > h_sponge_ptrs
Definition: ERF.H:1147
void fill_from_bndryregs(const amrex::Vector< amrex::MultiFab * > &mfs, amrex::Real time)
Definition: ERF_BoundaryConditionsBndryReg.cpp:13
const int timeprecision
Definition: ERF.H:902
int m_subvol_int
Definition: ERF.H:947
void setRecordDataInfo(int i, const std::string &filename)
Definition: ERF.H:1353
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_hfx1_lev
Definition: ERF.H:810
amrex::Vector< amrex::BoxArray > ba2d
Definition: ERF.H:1093
void HurricaneTracker(int lev, const amrex::MultiFab &U_new, const amrex::MultiFab &V_new, const amrex::MultiFab &W_new, const amrex::Real velmag_threshold, const bool is_track_io, amrex::TagBoxArray *tags=nullptr)
Definition: ERF_Tagging.cpp:391
amrex::Array< amrex::Array< amrex::Real, AMREX_SPACEDIM *2 >, AMREX_SPACEDIM+NBCVAR_max > m_bc_extdir_vals
Definition: ERF.H:873
void init_from_input_sounding(int lev)
Definition: ERF_InitFromInputSounding.cpp:51
void erf_enforce_hse(int lev, amrex::MultiFab &dens, amrex::MultiFab &pres, amrex::MultiFab &pi, amrex::MultiFab &th, amrex::MultiFab &qv, std::unique_ptr< amrex::MultiFab > &z_cc)
Definition: ERF_Init1D.cpp:161
amrex::Vector< amrex::Vector< amrex::MultiFab > > gradp
Definition: ERF.H:726
eb_ const & get_eb(int lev) const noexcept
Definition: ERF.H:1459
amrex::Gpu::DeviceVector< amrex::Real > d_havg_qv
Definition: ERF.H:1164
static amrex::Real column_loc_y
Definition: ERF.H:1103
static int mg_verbose
Definition: ERF.H:1045
void ReadParameters()
Definition: ERF.cpp:1565
static amrex::Vector< std::string > PlotFileVarNames(amrex::Vector< std::string > plot_var_names)
Definition: ERF_Plotfile.cpp:241
void InitializeFromFile()
amrex::Vector< std::unique_ptr< ERFPhysBCFunct_cons > > physbcs_cons
Definition: ERF.H:737
static bool init_sounding_ideal
Definition: ERF.H:1075
ERF()
Definition: ERF.cpp:92
void init_Dirichlet_bc_data(const std::string input_file)
Definition: ERF_InitBCs.cpp:652
~ERF() override
amrex::Vector< std::unique_ptr< amrex::MultiFab > > z_phys_nd_src
Definition: ERF.H:827
amrex::Vector< std::unique_ptr< amrex::MultiFab > > detJ_cc
Definition: ERF.H:822
amrex::Real m_plot_per_1
Definition: ERF.H:948
void WriteMyEBSurface()
Definition: ERF_EBWriteSurface.cpp:5
amrex::Vector< std::unique_ptr< amrex::MultiFab > > z_phys_cc
Definition: ERF.H:820
amrex::Vector< std::unique_ptr< eb_ > > eb
Definition: ERF.H:1457
amrex::Vector< std::unique_ptr< amrex::MultiFab > > eddyDiffs_lev
Definition: ERF.H:801
static SolverChoice solverChoice
Definition: ERF.H:1009
amrex::Vector< ERFFillPatcher > FPr_c
Definition: ERF.H:794
static bool use_fft
Definition: ERF.H:1046
bool m_plot_face_vels
Definition: ERF.H:951
amrex::Real volWgtSumMF(int lev, const amrex::MultiFab &mf, int comp, const amrex::MultiFab &mapfac, bool finemask)
Definition: ERF_WriteScalarProfiles.cpp:595
amrex::Vector< amrex::MultiFab > base_state_new
Definition: ERF.H:851
void WriteSubvolume()
Definition: ERF_WriteSubvolume.cpp:9
amrex::Vector< std::unique_ptr< amrex::MultiFab > > az
Definition: ERF.H:825
int regrid_int
Definition: ERF.H:934
amrex::Vector< amrex::Real > fixed_dt
Definition: ERF.H:928
void write_1D_profiles_stag(amrex::Real time)
Definition: ERF_Write1DProfiles_stag.cpp:25
void WriteGenericPlotfileHeaderWithTerrain(std::ostream &HeaderFile, int nlevels, const amrex::Vector< amrex::BoxArray > &bArray, const amrex::Vector< std::string > &varnames, const amrex::Vector< amrex::Geometry > &my_geom, amrex::Real time, const amrex::Vector< int > &level_steps, const amrex::Vector< amrex::IntVect > &my_ref_ratio, const std::string &versionName, const std::string &levelPrefix, const std::string &mfPrefix) const
Definition: ERF_Plotfile.cpp:1618
amrex::Vector< amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > > d_sponge_ptrs
Definition: ERF.H:1153
amrex::Vector< amrex::Vector< amrex::Real > > h_rhoqt_src
Definition: ERF.H:1122
amrex::Vector< long > dt_mri_ratio
Definition: ERF.H:717
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab > > > Tau
Definition: ERF.H:800
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vel_t_avg
Definition: ERF.H:729
void sum_energy_quantities(amrex::Real time)
Definition: ERF_WriteScalarProfiles.cpp:275
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_q2fx3_lev
Definition: ERF.H:813
static amrex::Real dt_max
Definition: ERF.H:925
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::iMultiFab > > > lmask_lev
Definition: ERF.H:807
amrex::Real stop_time
Definition: ERF.H:911
AMREX_FORCE_INLINE int NumSamplePointLogs() noexcept
Definition: ERF.H:1290
amrex::Vector< amrex::Real > h_havg_pressure
Definition: ERF.H:1157
void update_diffusive_arrays(int lev, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm)
Definition: ERF_MakeNewArrays.cpp:418
static int verbose
Definition: ERF.H:1044
amrex::Vector< amrex::Real > h_havg_qc
Definition: ERF.H:1159
amrex::Vector< std::unique_ptr< ERFPhysBCFunct_w > > physbcs_w
Definition: ERF.H:740
static int nghost_eb_basic()
Definition: ERF.H:1469
void Advance(int lev, amrex::Real time, amrex::Real dt_lev, int iteration, int ncycle)
Definition: ERF_Advance.cpp:23
static std::string column_file_name
Definition: ERF.H:1104
amrex::Vector< std::unique_ptr< std::fstream > > samplelinelog
Definition: ERF.H:1442
amrex::Vector< std::unique_ptr< amrex::MultiFab > > terrain_blanking
Definition: ERF.H:839
std::unique_ptr< Microphysics > micro
Definition: ERF.H:760
void ImposeBCsOnPhi(int lev, amrex::MultiFab &phi)
Definition: ERF_ImposeBCsOnPhi.cpp:12
amrex::Vector< amrex::MultiFab > base_state
Definition: ERF.H:850
AMREX_FORCE_INLINE amrex::YAFluxRegister * getAdvFluxReg(int lev)
Definition: ERF.H:1247
amrex::Vector< amrex::Real > h_havg_density
Definition: ERF.H:1155
amrex::Vector< std::unique_ptr< amrex::MultiFab > > z_phys_nd_new
Definition: ERF.H:833
amrex::Vector< amrex::Real > fixed_fast_dt
Definition: ERF.H:929
bool metgrid_retain_sfc
Definition: ERF.H:1087
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Qv_prim
Definition: ERF.H:745
static int sum_interval
Definition: ERF.H:1049
static int pert_interval
Definition: ERF.H:1050
void restart()
Definition: ERF.cpp:1402
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_q1fx2_lev
Definition: ERF.H:812
amrex::IntVect & SampleLine(int i)
Definition: ERF.H:1323
amrex::Vector< amrex::MultiFab > rV_new
Definition: ERF.H:752
std::string PlotFileName(int lev) const
void write_1D_profiles(amrex::Real time)
Definition: ERF_Write1DProfiles.cpp:17
void initialize_integrator(int lev, amrex::MultiFab &cons_mf, amrex::MultiFab &vel_mf)
Definition: ERF_MakeNewArrays.cpp:624
amrex::Vector< std::unique_ptr< amrex::MultiFab > > thin_zforce
Definition: ERF.H:890
amrex::Vector< amrex::BCRec > domain_bcs_type
Definition: ERF.H:866
amrex::Array< amrex::LinOpBCType, AMREX_SPACEDIM > get_projection_bc(amrex::Orientation::Side side) const noexcept
Definition: ERF_SolveWithMLMG.cpp:17
int m_plot_int_1
Definition: ERF.H:945
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Qr_prim
Definition: ERF.H:746
void post_timestep(int nstep, amrex::Real time, amrex::Real dt_lev)
Definition: ERF.cpp:497
amrex::Real m_subvol_per
Definition: ERF.H:950
std::string pp_prefix
Definition: ERF.H:447
std::string SampleLineLogName(int i) const noexcept
The filename of the ith samplelinelog file.
Definition: ERF.H:1454
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab > > > sst_lev
Definition: ERF.H:805
amrex::Vector< std::unique_ptr< amrex::MultiFab > > thin_xforce
Definition: ERF.H:888
AMREX_FORCE_INLINE int NumSamplePoints() noexcept
Definition: ERF.H:1317
bool metgrid_use_sfc
Definition: ERF.H:1086
static amrex::Real bndry_output_planes_per
Definition: ERF.H:1109
amrex::Real m_check_per
Definition: ERF.H:962
void init_custom(int lev)
Definition: ERF_InitCustom.cpp:26
std::unique_ptr< ProblemBase > prob
Definition: ERF.H:704
amrex::Vector< int > num_files_at_level
Definition: ERF.H:707
void WriteMultiLevelPlotfileWithTerrain(const std::string &plotfilename, int nlevels, const amrex::Vector< const amrex::MultiFab * > &mf, const amrex::Vector< const amrex::MultiFab * > &mf_nd, const amrex::Vector< std::string > &varnames, const amrex::Vector< amrex::Geometry > &my_geom, amrex::Real time, const amrex::Vector< int > &level_steps, const amrex::Vector< amrex::IntVect > &my_ref_ratio, const std::string &versionName="HyperCLaw-V1.1", const std::string &levelPrefix="Level_", const std::string &mfPrefix="Cell", const amrex::Vector< std::string > &extra_dirs=amrex::Vector< std::string >()) const
Definition: ERF_Plotfile.cpp:1531
void init_bcs()
Definition: ERF_InitBCs.cpp:20
int profile_int
Definition: ERF.H:956
bool metgrid_debug_quiescent
Definition: ERF.H:1078
amrex::Vector< std::unique_ptr< ERFPhysBCFunct_u > > physbcs_u
Definition: ERF.H:738
amrex::Vector< amrex::Real > t_new
Definition: ERF.H:714
bool destag_profiles
Definition: ERF.H:957
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > stretched_dz_d
Definition: ERF.H:848
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > th_bc_data
Definition: ERF.H:681
amrex::Vector< amrex::Real > t_avg_cnt
Definition: ERF.H:730
amrex::Vector< std::string > plot_var_names_1
Definition: ERF.H:964
std::string DerDataLogName(int i) const noexcept
Definition: ERF.H:1448
void remake_zphys(int lev, amrex::Real time, std::unique_ptr< amrex::MultiFab > &temp_zphys_nd)
Definition: ERF_MakeNewArrays.cpp:579
int m_check_int
Definition: ERF.H:961
amrex::Real estTimeStep(int lev, long &dt_fast_ratio) const
Definition: ERF_ComputeTimestep.cpp:54
static std::string sponge_type
Definition: ERF.H:1060
static amrex::Real startCPUTime
Definition: ERF.H:1335
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_diss_lev
Definition: ERF.H:811
amrex::Vector< amrex::MultiFab > rU_old
Definition: ERF.H:749
void FillIntermediatePatch(int lev, amrex::Real time, const amrex::Vector< amrex::MultiFab * > &mfs_vel, const amrex::Vector< amrex::MultiFab * > &mfs_mom, int ng_cons, int ng_vel, bool cons_only, int icomp_cons, int ncomp_cons)
Definition: ERF_FillIntermediatePatch.cpp:28
amrex::Vector< amrex::Real > t_old
Definition: ERF.H:715
AMREX_FORCE_INLINE int NumSampleLines() noexcept
Definition: ERF.H:1330
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Theta_prim
Definition: ERF.H:744
void init1DArrays()
amrex::Vector< std::unique_ptr< amrex::MultiFab > > z_t_rk
Definition: ERF.H:836
void compute_divergence(int lev, amrex::MultiFab &rhs, amrex::Array< amrex::MultiFab const *, AMREX_SPACEDIM > rho0_u_const, amrex::Geometry const &geom_at_lev)
Definition: ERF_ComputeDivergence.cpp:10
std::string MakeVTKFilename(int nstep)
Definition: ERF_Write1DProfiles.cpp:574
void fill_rhs(amrex::MultiFab &rhs_mf, const amrex::MultiFab &state_mf, amrex::Real time, const amrex::Geometry &geom)
void appendPlotVariables(const std::string &pp_plot_var_names, amrex::Vector< std::string > &plot_var_names)
Definition: ERF_Plotfile.cpp:174
amrex::Vector< std::unique_ptr< ERFPhysBCFunct_v > > physbcs_v
Definition: ERF.H:739
amrex::Vector< std::string > plot_var_names_2
Definition: ERF.H:965
static amrex::Real column_per
Definition: ERF.H:1101
amrex::Vector< std::string > tot_e_datalogname
Definition: ERF.H:1436
static int output_bndry_planes
Definition: ERF.H:1107
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > d_v_geos
Definition: ERF.H:1132
int last_plot_file_step_1
Definition: ERF.H:892
void update_terrain_arrays(int lev)
Definition: ERF_MakeNewArrays.cpp:613
static std::string nc_bdy_file
Definition: ERF.H:1066
bool metgrid_interp_theta
Definition: ERF.H:1083
static amrex::Vector< amrex::Vector< std::string > > nc_init_file
Definition: ERF.H:1063
void init_only(int lev, amrex::Real time)
Definition: ERF.cpp:1440
static int input_bndry_planes
Definition: ERF.H:1113
static StateInterpType interpolation_type
Definition: ERF.H:1057
amrex::Gpu::DeviceVector< amrex::Real > d_havg_qc
Definition: ERF.H:1165
void AverageDown()
Definition: ERF_AverageDown.cpp:16
amrex::Vector< amrex::Vector< amrex::Real > > h_v_geos
Definition: ERF.H:1131
bool projection_has_dirichlet(amrex::Array< amrex::LinOpBCType, AMREX_SPACEDIM > bcs) const
Definition: ERF_PoissonSolve_tb.cpp:8
bool regrid_level_0_on_restart
Definition: ERF.H:938
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Lwave_onegrid
Definition: ERF.H:857
InputSoundingData input_sounding_data
Definition: ERF.H:672
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > d_rhoqt_src
Definition: ERF.H:1123
std::unique_ptr< SampleData > data_sampler
Definition: ERF.H:1429
amrex::MultiFab fine_mask
Definition: ERF.H:1183
amrex::Gpu::DeviceVector< amrex::Real > d_havg_density
Definition: ERF.H:1161
int last_subvol
Definition: ERF.H:894
void init_from_hse(int lev)
Definition: ERF_InitFromHSE.cpp:32
const std::string datetime_format
Definition: ERF.H:914
amrex::Vector< amrex::YAFluxRegister * > advflux_reg
Definition: ERF.H:861
int metgrid_force_sfc_k
Definition: ERF.H:1090
amrex::Vector< amrex::Vector< amrex::Real > > h_rhotheta_src
Definition: ERF.H:1119
static int ng_pres_hse
Definition: ERF.H:1116
static amrex::Real bndry_output_planes_start_time
Definition: ERF.H:1110
amrex::Vector< std::unique_ptr< amrex::MultiFab > > mf_C1H
Definition: ERF.H:1094
static amrex::Real cfl
Definition: ERF.H:920
void solve_with_mlmg(int lev, amrex::Vector< amrex::MultiFab > &rhs, amrex::Vector< amrex::MultiFab > &p, amrex::Vector< amrex::Array< amrex::MultiFab, AMREX_SPACEDIM >> &fluxes)
Definition: ERF_SolveWithMLMG.cpp:40
amrex::Gpu::DeviceVector< amrex::BCRec > domain_bcs_type_d
Definition: ERF.H:867
amrex::Vector< std::unique_ptr< ForestDrag > > m_forest_drag
Definition: ERF.H:1172
const int datwidth
Definition: ERF.H:900
void derive_diag_profiles_stag(amrex::Real time, amrex::Gpu::HostVector< amrex::Real > &h_avg_u, amrex::Gpu::HostVector< amrex::Real > &h_avg_v, amrex::Gpu::HostVector< amrex::Real > &h_avg_w, amrex::Gpu::HostVector< amrex::Real > &h_avg_rho, amrex::Gpu::HostVector< amrex::Real > &h_avg_th, amrex::Gpu::HostVector< amrex::Real > &h_avg_ksgs, amrex::Gpu::HostVector< amrex::Real > &h_avg_Kmv, amrex::Gpu::HostVector< amrex::Real > &h_avg_Khv, amrex::Gpu::HostVector< amrex::Real > &h_avg_qv, amrex::Gpu::HostVector< amrex::Real > &h_avg_qc, amrex::Gpu::HostVector< amrex::Real > &h_avg_qr, amrex::Gpu::HostVector< amrex::Real > &h_avg_wqv, amrex::Gpu::HostVector< amrex::Real > &h_avg_wqc, amrex::Gpu::HostVector< amrex::Real > &h_avg_wqr, amrex::Gpu::HostVector< amrex::Real > &h_avg_qi, amrex::Gpu::HostVector< amrex::Real > &h_avg_qs, amrex::Gpu::HostVector< amrex::Real > &h_avg_qg, amrex::Gpu::HostVector< amrex::Real > &h_avg_uu, amrex::Gpu::HostVector< amrex::Real > &h_avg_uv, amrex::Gpu::HostVector< amrex::Real > &h_avg_uw, amrex::Gpu::HostVector< amrex::Real > &h_avg_vv, amrex::Gpu::HostVector< amrex::Real > &h_avg_vw, amrex::Gpu::HostVector< amrex::Real > &h_avg_ww, amrex::Gpu::HostVector< amrex::Real > &h_avg_uth, amrex::Gpu::HostVector< amrex::Real > &h_avg_vth, amrex::Gpu::HostVector< amrex::Real > &h_avg_wth, amrex::Gpu::HostVector< amrex::Real > &h_avg_thth, amrex::Gpu::HostVector< amrex::Real > &h_avg_ku, amrex::Gpu::HostVector< amrex::Real > &h_avg_kv, amrex::Gpu::HostVector< amrex::Real > &h_avg_kw, amrex::Gpu::HostVector< amrex::Real > &h_avg_p, amrex::Gpu::HostVector< amrex::Real > &h_avg_pu, amrex::Gpu::HostVector< amrex::Real > &h_avg_pv, amrex::Gpu::HostVector< amrex::Real > &h_avg_pw, amrex::Gpu::HostVector< amrex::Real > &h_avg_wthv)
Definition: ERF_Write1DProfiles_stag.cpp:296
amrex::Real sampler_per
Definition: ERF.H:1428
amrex::Vector< amrex::BoxArray > ba1d
Definition: ERF.H:1092
InputSpongeData input_sponge_data
Definition: ERF.H:675
std::string restart_chkfile
Definition: ERF.H:917
bool metgrid_use_below_sfc
Definition: ERF.H:1085
void init_zphys(int lev, amrex::Real time)
Definition: ERF_MakeNewArrays.cpp:508
amrex::Vector< std::string > sampleptlogname
Definition: ERF.H:1439
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > xvel_bc_data
Definition: ERF.H:678
void project_velocities(int lev, amrex::Real dt, amrex::Vector< amrex::MultiFab > &vars)
Definition: ERF_PoissonSolve.cpp:10
void InitData_pre()
Definition: ERF.cpp:682
amrex::IntVect & SamplePoint(int i)
Definition: ERF.H:1310
bool use_datetime
Definition: ERF.H:913
amrex::Vector< std::array< amrex::Real, 2 > > hurricane_track_xy
Definition: ERF.H:146
amrex::Vector< amrex::Vector< amrex::Real > > h_u_geos
Definition: ERF.H:1128
void InitializeLevelFromData(int lev, const amrex::MultiFab &initial_data)
std::string subvol_file
Definition: ERF.H:943
void sum_derived_quantities(amrex::Real time)
Definition: ERF_WriteScalarProfiles.cpp:169
void sum_integrated_quantities(amrex::Real time)
Definition: ERF_WriteScalarProfiles.cpp:15
amrex::Vector< std::string > datalogname
Definition: ERF.H:1434
void initHSE()
Initialize HSE.
Definition: ERF_Init1D.cpp:142
static amrex::Real column_loc_x
Definition: ERF.H:1102
amrex::Vector< std::unique_ptr< amrex::MultiFab > > ax
Definition: ERF.H:823
amrex::Vector< std::unique_ptr< amrex::MultiFab > > z_phys_nd
Definition: ERF.H:819
void MakeDiagnosticAverage(amrex::Vector< amrex::Real > &h_havg, amrex::MultiFab &S, int n)
Definition: ERF.cpp:2039
amrex::Real metgrid_proximity
Definition: ERF.H:1088
void setRecordDerDataInfo(int i, const std::string &filename)
Definition: ERF.H:1366
amrex::Vector< amrex::Real > h_havg_temperature
Definition: ERF.H:1156
void advance_dycore(int level, amrex::Vector< amrex::MultiFab > &state_old, amrex::Vector< amrex::MultiFab > &state_new, amrex::MultiFab &xvel_old, amrex::MultiFab &yvel_old, amrex::MultiFab &zvel_old, amrex::MultiFab &xvel_new, amrex::MultiFab &yvel_new, amrex::MultiFab &zvel_new, amrex::MultiFab &source, amrex::MultiFab &xmom_src, amrex::MultiFab &ymom_src, amrex::MultiFab &zmom_src, amrex::MultiFab &buoyancy, amrex::Geometry fine_geom, amrex::Real dt, amrex::Real time)
Definition: ERF_AdvanceDycore.cpp:38
amrex::Vector< std::unique_ptr< std::fstream > > sampleptlog
Definition: ERF.H:1438
static PlotFileType plotfile_type_2
Definition: ERF.H:1055
void poisson_wall_dist(int lev)
Definition: ERF_PoissonWallDist.cpp:20
void solve_with_gmres(int lev, amrex::Vector< amrex::MultiFab > &rhs, amrex::Vector< amrex::MultiFab > &p, amrex::Vector< amrex::Array< amrex::MultiFab, AMREX_SPACEDIM >> &fluxes)
Definition: ERF_SolveWithGMRES.cpp:12
void WritePlotFile(int which, PlotFileType plotfile_type, amrex::Vector< std::string > plot_var_names)
Definition: ERF_Plotfile.cpp:253
amrex::Vector< std::unique_ptr< amrex::MultiFab > > detJ_cc_src
Definition: ERF.H:828
amrex::Gpu::DeviceVector< amrex::Real > d_havg_pressure
Definition: ERF.H:1163
amrex::Vector< std::string > der_datalogname
Definition: ERF.H:1435
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SmnSmn_lev
Definition: ERF.H:802
const amrex::Vector< std::string > derived_names
Definition: ERF.H:971
amrex::Real start_time
Definition: ERF.H:910
amrex::Vector< std::unique_ptr< amrex::MultiFab > > ay_src
Definition: ERF.H:830
void sample_points(int lev, amrex::Real time, amrex::IntVect cell, amrex::MultiFab &mf)
Definition: ERF_WriteScalarProfiles.cpp:471
AMREX_FORCE_INLINE std::ostream & DataLog(int i)
Definition: ERF.H:1254
void writeJobInfo(const std::string &dir) const
Definition: ERF_WriteJobInfo.cpp:9
void solve_with_EB_mlmg(int lev, amrex::Vector< amrex::MultiFab > &rhs, amrex::Vector< amrex::MultiFab > &p, amrex::Vector< amrex::Array< amrex::MultiFab, AMREX_SPACEDIM >> &fluxes)
Definition: ERF_SolveWithEBMLMG.cpp:19
void ComputeDt(int step=-1)
Definition: ERF_ComputeTimestep.cpp:11
amrex::Vector< int > nsubsteps
Definition: ERF.H:711
amrex::Vector< std::unique_ptr< amrex::iMultiFab > > yflux_imask
Definition: ERF.H:883
amrex::Vector< amrex::MultiFab > rW_new
Definition: ERF.H:754
std::unique_ptr< WriteBndryPlanes > m_w2d
Definition: ERF.H:1169
std::string plot_file_1
Definition: ERF.H:941
AMREX_FORCE_INLINE std::ostream & SampleLineLog(int i)
Definition: ERF.H:1297
amrex::Vector< amrex::Vector< amrex::MultiFab * > > lsm_flux
Definition: ERF.H:778
std::string SamplePointLogName(int i) const noexcept
The filename of the ith sampleptlog file.
Definition: ERF.H:1451
void turbPert_update(const int lev, const amrex::Real dt)
Definition: ERF_InitTurbPert.cpp:12
void InitData_post()
Definition: ERF.cpp:740
void refinement_criteria_setup()
Definition: ERF_Tagging.cpp:165
static int nghost_eb_volume()
Definition: ERF.H:1473
bool metgrid_debug_dry
Definition: ERF.H:1080
static AMREX_FORCE_INLINE int ComputeGhostCells(const SolverChoice &sc)
Definition: ERF.H:1189
static int bndry_output_planes_interval
Definition: ERF.H:1108
void init_geo_wind_profile(const std::string input_file, amrex::Vector< amrex::Real > &u_geos, amrex::Gpu::DeviceVector< amrex::Real > &u_geos_d, amrex::Vector< amrex::Real > &v_geos, amrex::Gpu::DeviceVector< amrex::Real > &v_geos_d, const amrex::Geometry &lgeom, const amrex::Vector< amrex::Real > &zlev_stag)
Definition: ERF_InitGeowind.cpp:10
void ERF_shared()
Definition: ERF.cpp:107
static int nghost_eb_full()
Definition: ERF.H:1476
void project_velocities_tb(int lev, amrex::Real dt, amrex::Vector< amrex::MultiFab > &vars)
Definition: ERF_PoissonSolve_tb.cpp:20
void RemakeLevel(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
Definition: ERF_MakeNewLevel.cpp:365
static void GotoNextLine(std::istream &is)
Definition: ERF_Checkpoint.cpp:16
void MakeNewLevelFromScratch(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
Definition: ERF_MakeNewLevel.cpp:25
void init_stuff(int lev, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm, amrex::Vector< amrex::MultiFab > &lev_new, amrex::Vector< amrex::MultiFab > &lev_old, amrex::MultiFab &tmp_base_state, std::unique_ptr< amrex::MultiFab > &tmp_zphys_nd)
Definition: ERF_MakeNewArrays.cpp:24
amrex::Vector< amrex::MultiFab > zmom_crse_rhs
Definition: ERF.H:758
bool metgrid_debug_isothermal
Definition: ERF.H:1079
void initSponge()
Initialize sponge profiles.
Definition: ERF_InitSponge.cpp:35
amrex::Vector< std::unique_ptr< std::fstream > > der_datalog
Definition: ERF.H:1432
void advance_lsm(int lev, amrex::MultiFab &cons_in, amrex::MultiFab &xvel_in, amrex::MultiFab &yvel_in, const amrex::Real &dt_advance)
Definition: ERF_AdvanceLSM.cpp:5
amrex::Vector< std::unique_ptr< std::fstream > > tot_e_datalog
Definition: ERF.H:1433
amrex::Vector< std::unique_ptr< amrex::MultiFab > > sinPhi_m
Definition: ERF.H:669
void derive_diag_profiles(amrex::Real time, amrex::Gpu::HostVector< amrex::Real > &h_avg_u, amrex::Gpu::HostVector< amrex::Real > &h_avg_v, amrex::Gpu::HostVector< amrex::Real > &h_avg_w, amrex::Gpu::HostVector< amrex::Real > &h_avg_rho, amrex::Gpu::HostVector< amrex::Real > &h_avg_th, amrex::Gpu::HostVector< amrex::Real > &h_avg_ksgs, amrex::Gpu::HostVector< amrex::Real > &h_avg_Kmv, amrex::Gpu::HostVector< amrex::Real > &h_avg_Khv, amrex::Gpu::HostVector< amrex::Real > &h_avg_qv, amrex::Gpu::HostVector< amrex::Real > &h_avg_qc, amrex::Gpu::HostVector< amrex::Real > &h_avg_qr, amrex::Gpu::HostVector< amrex::Real > &h_avg_wqv, amrex::Gpu::HostVector< amrex::Real > &h_avg_wqc, amrex::Gpu::HostVector< amrex::Real > &h_avg_wqr, amrex::Gpu::HostVector< amrex::Real > &h_avg_qi, amrex::Gpu::HostVector< amrex::Real > &h_avg_qs, amrex::Gpu::HostVector< amrex::Real > &h_avg_qg, amrex::Gpu::HostVector< amrex::Real > &h_avg_uu, amrex::Gpu::HostVector< amrex::Real > &h_avg_uv, amrex::Gpu::HostVector< amrex::Real > &h_avg_uw, amrex::Gpu::HostVector< amrex::Real > &h_avg_vv, amrex::Gpu::HostVector< amrex::Real > &h_avg_vw, amrex::Gpu::HostVector< amrex::Real > &h_avg_ww, amrex::Gpu::HostVector< amrex::Real > &h_avg_uth, amrex::Gpu::HostVector< amrex::Real > &h_avg_vth, amrex::Gpu::HostVector< amrex::Real > &h_avg_wth, amrex::Gpu::HostVector< amrex::Real > &h_avg_thth, amrex::Gpu::HostVector< amrex::Real > &h_avg_ku, amrex::Gpu::HostVector< amrex::Real > &h_avg_kv, amrex::Gpu::HostVector< amrex::Real > &h_avg_kw, amrex::Gpu::HostVector< amrex::Real > &h_avg_p, amrex::Gpu::HostVector< amrex::Real > &h_avg_pu, amrex::Gpu::HostVector< amrex::Real > &h_avg_pv, amrex::Gpu::HostVector< amrex::Real > &h_avg_pw, amrex::Gpu::HostVector< amrex::Real > &h_avg_wthv)
Definition: ERF_Write1DProfiles.cpp:190
int real_width
Definition: ERF.H:1067
void MakeNewLevelFromCoarse(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
Definition: ERF_MakeNewLevel.cpp:246
amrex::Vector< std::unique_ptr< amrex::MultiFab > > ax_src
Definition: ERF.H:829
void input_sponge(int lev)
Definition: ERF_InitSponge.cpp:17
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > d_u_geos
Definition: ERF.H:1129
void Define_ERFFillPatchers(int lev)
Definition: ERF.cpp:2111
AMREX_FORCE_INLINE int NumDataLogs() noexcept
Definition: ERF.H:1268
void setRecordEnergyDataInfo(int i, const std::string &filename)
Definition: ERF.H:1379
TurbulentPerturbation turbPert
Definition: ERF.H:1012
amrex::Vector< amrex::MultiFab > rW_old
Definition: ERF.H:753
void FillCoarsePatch(int lev, amrex::Real time)
Definition: ERF_FillCoarsePatch.cpp:21
void ClearLevel(int lev) override
Definition: ERF_MakeNewLevel.cpp:559
std::unique_ptr< SurfaceLayer > m_SurfaceLayer
Definition: ERF.H:1171
static amrex::Vector< amrex::AMRErrorTag > ref_tags
Definition: ERF.H:1177
void make_physbcs(int lev)
Definition: ERF_MakeNewArrays.cpp:646
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > d_w_subsid
Definition: ERF.H:1126
amrex::Vector< ERFFillPatcher > FPr_w
Definition: ERF.H:797
int real_set_width
Definition: ERF.H:1068
void FillPatch(int lev, amrex::Real time, const amrex::Vector< amrex::MultiFab * > &mfs_vel, const amrex::Vector< amrex::MultiFab * > &mfs_mom, const amrex::MultiFab &old_base_state, const amrex::MultiFab &new_base_state, bool fillset=true, bool cons_only=false)
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_hfx2_lev
Definition: ERF.H:810
amrex::Vector< amrex::Vector< amrex::Real > > zlevels_stag
Definition: ERF.H:816
AMREX_FORCE_INLINE int NumDerDataLogs() noexcept
Definition: ERF.H:1275
amrex::EBFArrayBoxFactory const & EBFactory(int lev) const noexcept
Definition: ERF.H:1465
amrex::Vector< amrex::Vector< amrex::MultiFab * > > lsm_data
Definition: ERF.H:777
amrex::Vector< amrex::Vector< amrex::Real > > stretched_dz_h
Definition: ERF.H:847
void WriteCheckpointFile() const
Definition: ERF_Checkpoint.cpp:26
int sampler_interval
Definition: ERF.H:1427
static int output_1d_column
Definition: ERF.H:1099
bool metgrid_debug_psfc
Definition: ERF.H:1081
amrex::Vector< std::unique_ptr< amrex::MultiFab > > az_src
Definition: ERF.H:831
static int fixed_mri_dt_ratio
Definition: ERF.H:930
int m_plot_int_2
Definition: ERF.H:946
amrex::Vector< amrex::Real > dt
Definition: ERF.H:716
static amrex::Real init_shrink
Definition: ERF.H:922
void WriteVTKPolyline(const std::string &filename, amrex::Vector< std::array< amrex::Real, 2 >> &points_xy)
Definition: ERF_Write1DProfiles.cpp:593
amrex::Vector< std::unique_ptr< amrex::MultiFab > > mf_C2H
Definition: ERF.H:1095
static amrex::Real dt_max_initial
Definition: ERF.H:924
static bool is_it_time_for_action(int nstep, amrex::Real time, amrex::Real dt, int action_interval, amrex::Real action_per)
Definition: ERF_WriteScalarProfiles.cpp:685
static std::string nc_low_file
Definition: ERF.H:1071
amrex::Vector< amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > > d_rayleigh_ptrs
Definition: ERF.H:1150
void InitData()
Definition: ERF.cpp:673
void advance_microphysics(int lev, amrex::MultiFab &cons_in, const amrex::Real &dt_advance, const int &iteration, const amrex::Real &time)
Definition: ERF_AdvanceMicrophysics.cpp:5
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Lwave
Definition: ERF.H:855
amrex::Vector< std::unique_ptr< amrex::MultiFab > > cosPhi_m
Definition: ERF.H:669
void ParameterSanityChecks()
Definition: ERF.cpp:1866
void derive_stress_profiles(amrex::Gpu::HostVector< amrex::Real > &h_avg_tau11, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau12, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau13, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau22, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau23, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau33, amrex::Gpu::HostVector< amrex::Real > &h_avg_hfx3, amrex::Gpu::HostVector< amrex::Real > &h_avg_q1fx3, amrex::Gpu::HostVector< amrex::Real > &h_avg_q2fx3, amrex::Gpu::HostVector< amrex::Real > &h_avg_diss)
Definition: ERF_Write1DProfiles.cpp:475
int cf_width
Definition: ERF.H:792
amrex::Vector< amrex::Vector< amrex::Vector< amrex::Real > > > h_rayleigh_ptrs
Definition: ERF.H:1144
amrex::Vector< std::unique_ptr< amrex::iMultiFab > > zflux_imask
Definition: ERF.H:884
bool m_expand_plotvars_to_unif_rr
Definition: ERF.H:944
int plot_file_on_restart
Definition: ERF.H:897
void Construct_ERFFillPatchers(int lev)
Definition: ERF.cpp:2085
void post_update(amrex::MultiFab &state_mf, amrex::Real time, const amrex::Geometry &geom)
amrex::Vector< int > num_boxes_at_level
Definition: ERF.H:706
static amrex::Real sub_cfl
Definition: ERF.H:921
static void print_error(MPI_Comm, const std::string &msg)
Definition: ERF_ConsoleIO.cpp:43
static int ng_dens_hse
Definition: ERF.H:1115
std::unique_ptr< ReadBndryPlanes > m_r2d
Definition: ERF.H:1170
amrex::Vector< std::unique_ptr< amrex::MultiFab > > ay
Definition: ERF.H:824
amrex::Vector< amrex::Vector< amrex::MultiFab * > > qmoist
Definition: ERF.H:761
amrex::Vector< std::unique_ptr< amrex::MultiFab > > SFS_q1fx1_lev
Definition: ERF.H:812
static amrex::Real getCPUTime()
Definition: ERF.H:1339
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > zvel_bc_data
Definition: ERF.H:680
void derive_stress_profiles_stag(amrex::Gpu::HostVector< amrex::Real > &h_avg_tau11, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau12, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau13, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau22, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau23, amrex::Gpu::HostVector< amrex::Real > &h_avg_tau33, amrex::Gpu::HostVector< amrex::Real > &h_avg_hfx3, amrex::Gpu::HostVector< amrex::Real > &h_avg_q1fx3, amrex::Gpu::HostVector< amrex::Real > &h_avg_q2fx3, amrex::Gpu::HostVector< amrex::Real > &h_avg_diss)
Definition: ERF_Write1DProfiles_stag.cpp:605
LandSurface lsm
Definition: ERF.H:776
static amrex::Real change_max
Definition: ERF.H:923
void AverageDownTo(int crse_lev, int scomp, int ncomp)
Definition: ERF_AverageDown.cpp:36
void setRecordSampleLineInfo(int i, int lev, amrex::IntVect &cell, const std::string &filename)
Definition: ERF.H:1409
void setSpongeRefFromSounding(bool restarting)
Set sponge mean profiles from input sounding.
Definition: ERF_InitSponge.cpp:65
amrex::Vector< std::unique_ptr< amrex::MultiFab > > detJ_cc_new
Definition: ERF.H:834
amrex::Array< std::string, 2 *AMREX_SPACEDIM > domain_bc_type
Definition: ERF.H:870
amrex::Vector< amrex::Gpu::DeviceVector< amrex::Real > > yvel_bc_data
Definition: ERF.H:679
void init_uniform(int lev)
Definition: ERF_InitUniform.cpp:17
static void writeBuildInfo(std::ostream &os)
Definition: ERF_WriteJobInfo.cpp:137
amrex::GpuArray< ERF_BC, AMREX_SPACEDIM *2 > phys_bc_type
Definition: ERF.H:879
std::string check_file
Definition: ERF.H:960
amrex::Vector< amrex::IntVect > samplepoint
Definition: ERF.H:1440
amrex::Vector< amrex::Real > h_havg_qv
Definition: ERF.H:1158
static void print_usage(MPI_Comm, std::ostream &)
Definition: ERF_ConsoleIO.cpp:26
amrex::Vector< amrex::MultiFab > rV_old
Definition: ERF.H:751
void make_eb_regular()
amrex::Vector< std::unique_ptr< amrex::MultiFab > > mf_MUB
Definition: ERF.H:1096
amrex::Vector< std::unique_ptr< amrex::MultiFab > > Hwave
Definition: ERF.H:854
amrex::Vector< int > istep
Definition: ERF.H:710
const int datprecision
Definition: ERF.H:901
amrex::Vector< std::unique_ptr< amrex::iMultiFab > > xflux_imask
Definition: ERF.H:882
void derive_upwp(amrex::Vector< amrex::Real > &h_havg)
int metgrid_order
Definition: ERF.H:1089
bool finished_wave
Definition: ERF.H:858
void ReadCheckpointFile()
Definition: ERF_Checkpoint.cpp:419
bool writeNow(const amrex::Real cur_time, const amrex::Real dt, const int nstep, const int plot_int, const amrex::Real plot_per)
Definition: ERF.cpp:2162
amrex::Vector< amrex::Vector< amrex::MultiFab > > vars_old
Definition: ERF.H:723
amrex::MultiFab & build_fine_mask(int lev)
Definition: ERF_WriteScalarProfiles.cpp:648
amrex::Vector< std::unique_ptr< ERFPhysBCFunct_base > > physbcs_base
Definition: ERF.H:741
void init_thin_body(int lev, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm)
Definition: ERF_MakeNewLevel.cpp:598
AMREX_FORCE_INLINE std::ostream & SamplePointLog(int i)
Definition: ERF.H:1283
amrex::Array< amrex::Array< amrex::Real, AMREX_SPACEDIM *2 >, AMREX_SPACEDIM+NBCVAR_max > m_bc_neumann_vals
Definition: ERF.H:876
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab > > > tsk_lev
Definition: ERF.H:806
void setRecordSamplePointInfo(int i, int lev, amrex::IntVect &cell, const std::string &filename)
Definition: ERF.H:1392
static int column_interval
Definition: ERF.H:1100
static void print_summary(std::ostream &)
void turbPert_amplitude(const int lev)
Definition: ERF_InitTurbPert.cpp:32
void sample_lines(int lev, amrex::Real time, amrex::IntVect cell, amrex::MultiFab &mf)
Definition: ERF_WriteScalarProfiles.cpp:507
void initializeMicrophysics(const int &)
Definition: ERF.cpp:1367
bool plot_lsm
Definition: ERF.H:953
const amrex::Vector< std::string > cons_names
Definition: ERF.H:966
void ReadCheckpointFileSurfaceLayer()
Definition: ERF_Checkpoint.cpp:957
void FillPatch(int lev, amrex::Real time, const amrex::Vector< amrex::MultiFab * > &mfs_vel, bool cons_only=false)
void timeStep(int lev, amrex::Real time, int iteration)
Definition: ERF_TimeStep.cpp:17
amrex::Real m_plot_per_2
Definition: ERF.H:949
Definition: ERF_LandSurface.H:15
Definition: ERF_EB.H:13
@ pres
Definition: ERF_Kessler.H:25
@ qv
Definition: ERF_Kessler.H:28
@ T
Definition: ERF_IndexDefines.H:110
Definition: ERF_ConsoleIO.cpp:12
real(c_double), parameter, private pi
Definition: ERF_module_mp_morr_two_moment.F90:100
AdvType moistscal_horiz_adv_type
Definition: ERF_AdvStruct.H:343
AdvType dycore_vert_adv_type
Definition: ERF_AdvStruct.H:340
AdvType moistscal_vert_adv_type
Definition: ERF_AdvStruct.H:344
AdvType dryscal_horiz_adv_type
Definition: ERF_AdvStruct.H:341
AdvType dycore_horiz_adv_type
Definition: ERF_AdvStruct.H:339
AdvType dryscal_vert_adv_type
Definition: ERF_AdvStruct.H:342
Definition: ERF_InputSoundingData.H:22
Definition: ERF_InputSpongeData.H:19
Definition: ERF_DataStruct.H:91
bool use_num_diff
Definition: ERF_DataStruct.H:751
AdvChoice advChoice
Definition: ERF_DataStruct.H:673
static TerrainType terrain_type
Definition: ERF_DataStruct.H:659
Definition: ERF_TurbPertStruct.H:22