REMORA
Regional Modeling of Oceans Refined Adaptively
Loading...
Searching...
No Matches
REMORA.H
Go to the documentation of this file.
1#ifndef REMORA_H_
2#define REMORA_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_InterpFaceRegister.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
25#ifdef AMREX_MEM_PROFILING
26#include <AMReX_MemProfiler.H>
27#endif
28
29#include <REMORA_Math.H>
30#include <REMORA_PhysBCFunct.H>
31#include <REMORA_FillPatcher.H>
32
33#include <REMORA_IndexDefines.H>
35#include <REMORA_DataStruct.H>
36#include <REMORA_Derive.H>
37#include "REMORA_prob_common.H"
38
39#ifdef REMORA_USE_PARTICLES
40#include "REMORA_ParticleData.H"
41#endif
42
43#ifdef REMORA_USE_NETCDF
44#include "REMORA_NCInterface.H"
45#include "REMORA_NCTimeSeries.H"
48#endif
49
50#ifdef REMORA_USE_MOAB
51#include "REMORA_MOAB.H"
52#endif
54#include <iostream>
55
56#ifdef AMREX_LAZY
57#include <AMReX_Lazy.H>
58#endif
59
60#ifndef AMREX_USE_MPI
61using amrex::MPI_COMM_WORLD;
62using amrex::MPI_Comm;
63#endif
64
76
77// Forward declarations to resolve circular dependency
78class ProblemBase;
79#ifdef REMORA_USE_NETCDF
80class NCTimeSeries;
83#endif
84
85/*!
86 * \brief Class that stores all relevant simulation state data with methods for time stepping
87 */
88class REMORA
89 : public amrex::AmrCore
90{
91public:
92
93 REMORA ();
94 virtual ~REMORA ();
95
96 /** \brief Advance solution to final time */
97 void Evolve ();
98
99 /** \brief Tag cells for refinement */
100 virtual void ErrorEst (int lev, amrex::TagBoxArray& tags, amrex::Real time, int ngrow) override;
101
102 /** \brief Initialize multilevel data */
103 void InitData ();
104
105 /** \brief Init (NOT restart or regrid) */
106 void init_only (int lev, amrex::Real time);
107
108 /** \briefRestart */
109 void restart ();
110
111 /** \brief Called after every level 0 timestep */
112 void post_timestep (int nstep, amrex::Real time, amrex::Real dt_lev);
113
114 // Diagnostics
115
116 /** \brief Integrate conserved quantities for diagnostics */
117 void sum_integrated_quantities (amrex::Real time);
118
119 /** \brief Perform the volume-weighted sum */
120 amrex::Real
121 volWgtSumMF (int lev,
122 const amrex::MultiFab& mf, int comp, bool local, bool finemask);
123
124 /** \brief Decide if it is time to take an action */
125 bool is_it_time_for_action (int nstep, amrex::Real time, amrex::Real dt,
126 int action_interval, amrex::Real action_per);
127
128 /** \brief Make a new level using provided BoxArray and DistributionMapping and
129 * fill with interpolated coarse level data.
130 * Overrides the pure virtual function in AmrCore
131 */
132 virtual void MakeNewLevelFromCoarse (int lev, amrex::Real time, const amrex::BoxArray& ba,
133 const amrex::DistributionMapping& dm) override;
134
135 /** \brief Remake an existing level using provided BoxArray and DistributionMapping and
136 * fill with existing fine and coarse data.
137 * Overrides the pure virtual function in AmrCore
138 */
139 virtual void RemakeLevel (int lev, amrex::Real time, const amrex::BoxArray& ba,
140 const amrex::DistributionMapping& dm) override;
141
142 /** \brief Delete level data
143 * Overrides the pure virtual function in AmrCore
144 */
145 virtual void ClearLevel (int lev) override;
146
147 /** \brief Make a new level from scratch using provided BoxArray and DistributionMapping.
148 * Only used during initialization.
149 * Overrides the pure virtual function in AmrCore
150 */
151 virtual void MakeNewLevelFromScratch (int lev, amrex::Real time, const amrex::BoxArray& ba,
152 const amrex::DistributionMapping& dm) override;
153
154 /** \brief Set pm and pn arrays on level lev. Only works if using analytic initialization */
155 void set_grid_scale (int lev);
156
157 /** \brief Set zeta components to be equal to time-averaged Zt_avg1 */
158 void set_zeta_to_Ztavg (int lev);
159
160 /** \brief Calculate u-, v-, and psi-point masks based on rho-point masks after analytic initialization */
161 void calculate_nodal_masks (int lev);
162
163 /** \brief Copy maskr to all z levels */
164 void fill_3d_masks (int lev);
165
166 /** \brief Set psi-point mask to be consistent with rho-point mask */
167 void update_mskp (int lev);
168
169 /** \brief compute dt from CFL considerations */
170 amrex::Real estTimeStep (int lev) const;
171
172 /** \brief Interface for advancing the data at one level by one "slow" timestep */
173 void remora_advance(int level,
174 amrex::MultiFab& cons_old, amrex::MultiFab& cons_new,
175 amrex::MultiFab& xvel_old, amrex::MultiFab& yvel_old, amrex::MultiFab& zvel_old,
176 amrex::MultiFab& xvel_new, amrex::MultiFab& yvel_new, amrex::MultiFab& zvel_new,
177 amrex::MultiFab& source,
178 const amrex::Geometry fine_geom,
179 const amrex::Real dt, const amrex::Real time);
180
181 /** \brief Make mask to zero out covered cells (for mesh refinement) */
182 amrex::MultiFab& build_fine_mask(int lev);
183
184 /** \brief main driver for writing AMReX plotfiles */
185 void WritePlotFile ();
186
187 /** \brief write out particular data to an AMReX plotfile */
188 void WriteMultiLevelPlotfileWithBathymetry (const std::string &plotfilename,
189 int nlevels,
190 const amrex::Vector<const amrex::MultiFab*> &mf,
191 const amrex::Vector<const amrex::MultiFab*> &mf_nd,
192 const amrex::Vector<const amrex::MultiFab*> &mf_u,
193 const amrex::Vector<const amrex::MultiFab*> &mf_v,
194 const amrex::Vector<const amrex::MultiFab*> &mf_w,
195 const amrex::Vector<const amrex::MultiFab*> &mf_2d_rho,
196 const amrex::Vector<const amrex::MultiFab*> &mf_2d_u,
197 const amrex::Vector<const amrex::MultiFab*> &mf_2d_v,
198 const amrex::Vector<std::string> &varnames_3d,
199 const amrex::Vector<std::string> &varnames_2d_rho,
200 const amrex::Vector<std::string> &varnames_2d_u,
201 const amrex::Vector<std::string> &varnames_2d_v,
202 const amrex::Vector<amrex::Geometry>& my_geom,
203 amrex::Real time,
204 const amrex::Vector<int> &level_steps,
205 const amrex::Vector<amrex::IntVect>& rr,
206 const std::string &versionName = "HyperCLaw-V1.1",
207 const std::string &levelPrefix = "Level_",
208 const std::string &mfPrefix = "Cell",
209 const amrex::Vector<std::string>& extra_dirs = amrex::Vector<std::string>()) const;
210
211
212 /** \brief write out header data for an AMReX plotfile */
213 void WriteGenericPlotfileHeaderWithBathymetry (std::ostream &HeaderFile,
214 int nlevels,
215 const amrex::Vector<amrex::BoxArray> &bArray,
216 const amrex::Vector<std::string> &varnames_3d,
217 const amrex::Vector<std::string> &varnames_2d_rho,
218 const amrex::Vector<std::string> &varnames_2d_u,
219 const amrex::Vector<std::string> &varnames_2d_v,
220 const amrex::Vector<amrex::Geometry>& my_geom,
221 amrex::Real time,
222 const amrex::Vector<int> &level_steps,
223 const amrex::Vector<amrex::IntVect>& rr,
224 const std::string &versionName,
225 const std::string &levelPrefix,
226 const std::string &mfPrefix) const;
227
228 /** \brief default prefix for input file parameters */
229 std::string pp_prefix {"remora"};
230
231 /** \brief multilevel data container for last step's scalar data: temperature, salinity, passive scalar */
232 amrex::Vector<amrex::MultiFab*> cons_old;
233 /** \brief multilevel data container for last step's x velocities (u in ROMS) */
234 amrex::Vector<amrex::MultiFab*> xvel_old;
235 /** \brief multilevel data container for last step's y velocities (v in ROMS) */
236 amrex::Vector<amrex::MultiFab*> yvel_old;
237 /** \brief multilevel data container for last step's z velocities (largely unused; W stored separately) */
238 amrex::Vector<amrex::MultiFab*> zvel_old;
239
240 /** \brief multilevel data container for current step's scalar data: temperature, salinity, passive scalar */
241 amrex::Vector<amrex::MultiFab*> cons_new;
242 /** \brief multilevel data container for current step's x velocities (u in ROMS) */
243 amrex::Vector<amrex::MultiFab*> xvel_new;
244 /** \brief multilevel data container for current step's y velocities (v in ROMS) */
245 amrex::Vector<amrex::MultiFab*> yvel_new;
246 /** \brief multilevel data container for current step's z velocities (largely unused; W stored separately) */
247 amrex::Vector<amrex::MultiFab*> zvel_new;
248
249 // Program state data is represented by vectors of pointers to AMReX Multifabs.
250 // There is one pointer per level
251
252 /** \brief Bathymetry data (2D, positive valued, h in ROMS) **/
253 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_h;
254
255 /** \brief Width of cells in the vertical (z-) direction (3D, Hz in ROMS) */
256 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Hz;
257 /** \brief u-volume flux (3D) */
258 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Huon;
259 /** \brief v-volume flux (3D) */
260 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Hvom;
261 /** \brief u velocity RHS (3D, includes horizontal and vertical advection) */
262 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_ru;
263 /** \brief v velocity RHS (3D, includes horizontal and vertical advection) */
264 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rv;
265 /** \brief u velocity RHS (2D, includes horizontal and vertical advection) */
266 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_ru2d;
267 /** \brief v velocity RHS (2D, includes horizontal and vertical advection) */
268 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rv2d;
269 /** \brief u velocity RHS, integrated, including advection and bottom/surface stresses (2D) */
270 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rufrc;
271 /** \brief v velocity RHS, integrated, including advection and bottom/surface stresses (2D) */
272 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rvfrc;
273 /** \brief Vertical viscosity coefficient (3D) */
274 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Akv;
275 /** \brief Vertical diffusion coefficient (3D) */
276 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Akt;
277 /** \brief Harmonic viscosity defined on the psi points (corners of horizontal grid cells) */
278 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_visc2_p;
279 /** \brief Harmonic viscosity defined on the rho points (centers) */
280 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_visc2_r;
281 /** \brief Harmonic diffusivity for temperature / salinity */
282 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_diff2;
283
284 /** \brief z coordinates at rho points (cell centers) */
285 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_z_r;
286
287 /** \brief z coordinates at w points (faces between z-cells) */
288 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_z_w;
289 /** \brief Scaled vertical coordinate (range [0,1]) that transforms to z, defined at rho points (cell centers) */
290 amrex::Gpu::DeviceVector<amrex::Real> s_r;
291 /** \brief Scaled vertical coordinate (range [0,1]) that transforms to z, defined at w-points (cell faces) */
292 amrex::Gpu::DeviceVector<amrex::Real> s_w;
293
294 //amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_s_r;
295 //amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_s_w;
296 //amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Cs_r;
297 //amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Cs_w;
298
299 /** \brief Stretching coefficients at rho points */
300 amrex::Gpu::DeviceVector<amrex::Real> Cs_r;
301 /** \brief Stretching coefficients at w points */
302 amrex::Gpu::DeviceVector<amrex::Real> Cs_w;
303
304 /** \brief z coordinates at psi points (cell nodes) **/
305 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_z_phys_nd;
306
307 /** \brief Average of the free surface, zeta (2D) */
308 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Zt_avg1;
309
310 /** \brief Surface stress in the u direction */
311 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_sustr;
312 /** \brief Surface stress in the v direction */
313 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_svstr;
314
315 /** \brief Wind in the u direction, defined at rho-points */
316 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_uwind;
317 /** \brief Wind in the v direction, defined at rho-points */
318 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_vwind;
319 /** \brief Air temperature [°C], defined at rho-points */
320 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Tair;
321 /** \brief Specific humidity [kg/kg], defined at rho-points */
322 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_qair;
323 /** \brief Air pressure [mb], defined at rho-points */
324 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Pair;
325 /** \brief Shortwave radiation flux [W/m²], defined at rho-points */
326 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_srflx;
327
328 /** \brief longwave radiation */
329 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_lrflx;
330 /** \brief latent heat flux */
331 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_lhflx;
332 /** \brief sensible heat flux */
333 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_shflx;
334
335 /** \brief Surface tracer flux; working arrays */
336 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_stflx;
337 /** \brief Surface tracer flux; input arrays */
338 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_stflux;
339 /** \brief Bottom tracer flux; working arrays */
340 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_btflx;
341 /** \brief Bottom tracer flux; input arrays */
342 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_btflux;
343
344 /** \brief precipitation rate [kg/m^2/s] */
345 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rain;
346 /** \brief evaporation rate [kg/m^2/s] */
347 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_evap;
348 /** \brief cloud cover fraction [0-1], defined at rho-points */
349 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_cloud;
350 /** \brief evaporation minus precipitation [kg/m^2/s], defined at rho-points */
351 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_EminusP;
352
353 /** \brief Linear drag coefficient [m/s], defined at rho points */
354 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rdrag;
355 /** \brief Quadratic drag coefficient [unitless], defined at rho points */
356 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rdrag2;
357 /** \brief Bottom roughness length [m], defined at rho points */
358 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_ZoBot;
359
360 /** \brief Bottom stress in the u direction */
361 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_bustr;
362 /** \brief Bottom stress in the v direction */
363 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_bvstr;
364
365 /** \brief time average of barotropic x velocity flux (2D) */
366 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_DU_avg1;
367 /** \brief correct time average of barotropic x velocity flux for coupling (2D) */
368 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_DU_avg2;
369 /** \brief time average of barotropic y velocity flux */
370 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_DV_avg1;
371 /** \brief correct time average of barotropic y velocity flux for coupling (2D) */
372 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_DV_avg2;
373 /** \brief barotropic x velocity for the RHS (2D) */
374 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rubar;
375 /** \brief barotropic y velocity for the RHS (2D) */
376 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rvbar;
377 /** \brief free surface height for the RHS (2D) */
378 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rzeta;
379 /** \brief barotropic x velocity (2D) */
380 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_ubar;
381 /** \brief barotropic y velocity (2D) */
382 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_vbar;
383 /** \brief free surface height (2D) */
384 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_zeta;
385
386 /** \brief land/sea mask at cell centers (2D) */
387 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_mskr;
388 /** \brief land/sea mask at x-faces (2D) */
389 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_msku;
390 /** \brief land/sea mask at y-faces (2D) */
391 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_mskv;
392 /** \brief land/sea mask at cell corners (2D) */
393 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_mskp;
394 /** \brief land/sea mask at cell centers, copied to all z levels (3D) */
395 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_mskr3d;
396
397 /** \brief horizontal scaling factor: 1 / dx (2D) */
398 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_pm;
399 /** \brief horizontal scaling factor: 1 / dy (2D) */
400 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_pn;
401
402 /** \brief coriolis factor (2D) */
403 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_fcor;
404
405 /** \brief x_grid on rho points (2D) */
406 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_xr;
407 /** \brief y_grid on rho points (2D) */
408 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_yr;
409
410 /** \brief x_grid on u-points (2D) */
411 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_xu;
412 /** \brief y_grid on u-points (2D) */
413 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_yu;
414
415 /** \brief x_grid on v-points (2D) */
416 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_xv;
417 /** \brief y_grid on v-points (2D) */
418 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_yv;
419
420 /** \brief x_grid on psi-points (2D) */
421 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_xp;
422 /** \brief y_grid on psi-points (2D) */
423 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_yp;
424
425 /** \brief additional scratch space for calculations on temp, salt, etc */
426 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_sstore;
427
428 /** \brief density perturbation */
429 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rhoS;
430 /** \brief vertically-averaged density */
431 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_rhoA;
432 /** \brief Brunt-Vaisala frequency (3D) */
433 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_bvf;
434 /** \brief Thermal expansion coefficient (3D) */
435 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_alpha;
436 /** \brief Saline contraction coefficient (3D) */
437 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_beta;
438
439 /** \brief Weights for calculating avg1 in 2D advance */
440 amrex::Vector<amrex::Real> vec_weight1;
441 /** \brief Weights for calculating avg2 in 2D advance */
442 amrex::Vector<amrex::Real> vec_weight2;
443
444 // GLS
445 /** \brief Turbulent kinetic energy */
446 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_tke;
447 /** \brief Turbulent generic length scale */
448 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_gls;
449 /** \brief Vertical mixing turbulent length scale */
450 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Lscale;
451 /** \brief Turbulent kinetic energy vertical diffusion coefficient */
452 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Akk;
453 /** \brief Turbulent length scale vertical diffusion coefficient */
454 amrex::Vector<std::unique_ptr<amrex::MultiFab>> vec_Akp;
455
456 /** \brief Climatology nudging coefficients */
457 amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>> vec_nudg_coeff;
458
459 /** \brief advance a single level for a single time step */
460 void Advance (int lev, amrex::Real time, amrex::Real dt_lev, int iteration, int ncycle);
461
462 /** \brief Set everything up for a step on a level */
463 void setup_step(int lev, amrex::Real time, amrex::Real dt_lev);
464
465 /** \brief 3D advance on a single level */
466 void advance_3d_ml (int lev, amrex::Real dt_lev);
467
468 /** \brief 2D advance, one predictor/corrector step */
469 void advance_2d_onestep (int lev, amrex::Real dt_lev, amrex::Real dtfast_lev, int my_iif, int nfast_counter);
470
471 /** \brief Perform a 2D predictor (predictor_2d_step=True) or corrector (predictor_2d_step=False) step */
472 void advance_2d (int lev,
473 amrex::MultiFab const* mf_rhoS,
474 amrex::MultiFab const* mf_rhoA,
475 amrex::MultiFab * mf_ru2d,
476 amrex::MultiFab * mf_rv2d,
477 amrex::MultiFab * mf_rufrc,
478 amrex::MultiFab * mf_rvfrc,
479 amrex::MultiFab * mf_Zt_avg1,
480 std::unique_ptr<amrex::MultiFab>& mf_DU_avg1,
481 std::unique_ptr<amrex::MultiFab>& mf_DU_avg2,
482 std::unique_ptr<amrex::MultiFab>& mf_DV_avg1,
483 std::unique_ptr<amrex::MultiFab>& mf_DV_avg2,
484 std::unique_ptr<amrex::MultiFab>& mf_rubar,
485 std::unique_ptr<amrex::MultiFab>& mf_rvbar,
486 std::unique_ptr<amrex::MultiFab>& mf_rzeta,
487 std::unique_ptr<amrex::MultiFab>& mf_ubar,
488 std::unique_ptr<amrex::MultiFab>& mf_vbar,
489 amrex::MultiFab * mf_zeta,
490 amrex::MultiFab const* mf_h,
491 amrex::MultiFab const* mf_pm,
492 amrex::MultiFab const* mf_pn,
493 amrex::MultiFab const* mf_fcor,
494 amrex::MultiFab const* mf_visc2_p,
495 amrex::MultiFab const* mf_visc2_r,
496 amrex::MultiFab const* mf_mskr,
497 amrex::MultiFab const* mf_msku,
498 amrex::MultiFab const* mf_mskv,
499 amrex::MultiFab const* mf_mskp,
500 amrex::Real dtfast_lev,
501 bool predictor_2d_step,
502 bool first_2d_step, int my_iif,
503 int & next_indx1);
504
505 /** \brief Advance the 3D variables */
506 void advance_3d (int lev,
507 amrex::MultiFab& mf_cons,
508 amrex::MultiFab& mf_u , amrex::MultiFab& mf_v,
509 amrex::MultiFab* mf_sstore,
510 amrex::MultiFab* mf_ru , amrex::MultiFab* mf_rv,
511 std::unique_ptr<amrex::MultiFab>& mf_DU_avg1,
512 std::unique_ptr<amrex::MultiFab>& mf_DU_avg2,
513 std::unique_ptr<amrex::MultiFab>& mf_DV_avg1,
514 std::unique_ptr<amrex::MultiFab>& mf_DV_avg2,
515 std::unique_ptr<amrex::MultiFab>& mf_ubar,
516 std::unique_ptr<amrex::MultiFab>& mf_vbar,
517 std::unique_ptr<amrex::MultiFab>& mf_Akv,
518 std::unique_ptr<amrex::MultiFab>& mf_Akt,
519 std::unique_ptr<amrex::MultiFab>& mf_Hz,
520 std::unique_ptr<amrex::MultiFab>& mf_Huon,
521 std::unique_ptr<amrex::MultiFab>& mf_Hvom,
522 std::unique_ptr<amrex::MultiFab>& mf_z_w,
523 amrex::MultiFab const* mf_h,
524 amrex::MultiFab const* mf_pm,
525 amrex::MultiFab const* mf_pn,
526 amrex::MultiFab const* mf_mskr,
527 amrex::MultiFab const* mf_msku,
528 amrex::MultiFab const* mf_mskv,
529 const int N,
530 const amrex::Real dt_lev);
531
532 /** \brief Calculate bulk temperature, salinity, wind fluxes */
533 void bulk_fluxes (int lev,
534 amrex::MultiFab* mf_cons,
535 amrex::MultiFab* mf_uwind,
536 amrex::MultiFab* mf_vwind,
537 amrex::MultiFab* mf_Tair,
538 amrex::MultiFab* mf_qair,
539 amrex::MultiFab* mf_Pair,
540 amrex::MultiFab* mf_srflx,
541 amrex::MultiFab* mf_evap,
542 amrex::MultiFab* mf_sustr,
543 amrex::MultiFab* mf_svstr,
544 amrex::MultiFab* mf_stflux,
545 amrex::MultiFab* mf_lrflx,
546 amrex::MultiFab* mf_lhflx,
547 amrex::MultiFab* mf_shflx,
548 const int N);
549
550 /** \brief Wrapper function for prestep */
551 void prestep (int lev,
552 amrex::MultiFab& mf_uold, amrex::MultiFab& mf_vold,
553 amrex::MultiFab& mf_u, amrex::MultiFab& mf_v,
554 amrex::MultiFab* mf_ru,
555 amrex::MultiFab* mf_rv,
556 amrex::MultiFab& S_old,
557 amrex::MultiFab& S_new,
558 amrex::MultiFab& mf_W, amrex::MultiFab& mf_DC,
559 /* MF mf_FC? */
560 const amrex::MultiFab* mf_z_r,
561 const amrex::MultiFab* mf_z_w,
562 const amrex::MultiFab* mf_h,
563 const amrex::MultiFab* mf_pm,
564 const amrex::MultiFab* mf_pn,
565 const amrex::MultiFab* mf_sustr,
566 const amrex::MultiFab* mf_svstr,
567 const amrex::MultiFab* mf_bustr,
568 const amrex::MultiFab* mf_bvstr,
569 const amrex::MultiFab* mf_msku,
570 const amrex::MultiFab* mf_mskv,
571 const int iic, const int nfirst,
572 const int nnew, int nstp, int nrhs,
573 int N, const amrex::Real dt_lev);
574
575 /** \brief Prestep advection calculations for the tracers */
576 void prestep_t_advection (int lev, const amrex::Box& tbx,
577 const amrex::Box& gbx,
578 const amrex::Array4<amrex::Real >& tempold,
579 const amrex::Array4<amrex::Real >& tempcache,
580 const amrex::Array4<amrex::Real >& Hz,
581 const amrex::Array4<amrex::Real >& Huon,
582 const amrex::Array4<amrex::Real >& Hvom,
583 const amrex::Array4<amrex::Real >& W,
584 const amrex::Array4<amrex::Real >& DC,
585 const amrex::Array4<amrex::Real >& FC,
586 const amrex::Array4<amrex::Real >& sstore,
587 const amrex::Array4<amrex::Real const>& z_w,
588 const amrex::Array4<amrex::Real const>& h,
589 const amrex::Array4<amrex::Real const>& pm,
590 const amrex::Array4<amrex::Real const>& pn,
591 const amrex::Array4<amrex::Real const>& msku,
592 const amrex::Array4<amrex::Real const>& mskv,
593 const amrex::Array4<int const>& river_pos,
594 const amrex::Array4<amrex::Real const>& river_source,
595 int iic, int ntfirst, int nrhs, int N,
596 const amrex::Real dt_lev);
597
598 /** \brief RHS terms for tracer */
599 void rhs_t_3d (int lev,
600 const amrex::Box& bx,
601 const amrex::Array4<amrex::Real >& t,
602 const amrex::Array4<amrex::Real const>& tempstore,
603 const amrex::Array4<amrex::Real const>& Huon,
604 const amrex::Array4<amrex::Real const>& Hvom,
605 const amrex::Array4<amrex::Real const>& Hz,
606 const amrex::Array4<amrex::Real const>& pn,
607 const amrex::Array4<amrex::Real const>& pm,
608 const amrex::Array4<amrex::Real const>& W,
609 const amrex::Array4<amrex::Real >& FC,
610 const amrex::Array4<amrex::Real const>& mskr,
611 const amrex::Array4<amrex::Real const>& msku,
612 const amrex::Array4<amrex::Real const>& mskv,
613 const amrex::Array4<int const>& river_pos,
614 const amrex::Array4<amrex::Real const>& river_source,
615 int nrhs, int nnew, int N, const amrex::Real dt_lev);
616
617 /** \brief RHS terms for 3D momentum */
618 void rhs_uv_3d (int lev,
619 const amrex::Box& xbx,
620 const amrex::Box& ybx,
621 const amrex::Array4<amrex::Real const>& uold,
622 const amrex::Array4<amrex::Real const>& vold,
623 const amrex::Array4<amrex::Real >& ru,
624 const amrex::Array4<amrex::Real >& rv,
625 const amrex::Array4<amrex::Real >& rufrc,
626 const amrex::Array4<amrex::Real >& rvfrc,
627 const amrex::Array4<amrex::Real const>& sustr,
628 const amrex::Array4<amrex::Real const>& svstr,
629 const amrex::Array4<amrex::Real const>& bustr,
630 const amrex::Array4<amrex::Real const>& bvstr,
631 const amrex::Array4<amrex::Real const>& Huon,
632 const amrex::Array4<amrex::Real const>& Hvom,
633 const amrex::Array4<amrex::Real const>& pm,
634 const amrex::Array4<amrex::Real const>& pn,
635 const amrex::Array4<amrex::Real const>& W,
636 const amrex::Array4<amrex::Real >& FC,
637 int nrhs, int N);
638
639 /** \brief RHS terms for 2D momentum */
640 void rhs_uv_2d (int lev,
641 const amrex::Box& xbx,
642 const amrex::Box& ybx,
643 const amrex::Array4<amrex::Real const>& uold,
644 const amrex::Array4<amrex::Real const>& vold,
645 const amrex::Array4<amrex::Real >& ru,
646 const amrex::Array4<amrex::Real >& rv,
647 const amrex::Array4<amrex::Real const>& Duon,
648 const amrex::Array4<amrex::Real const>& Dvom,
649 const int nrhs);
650
651 /** \brief Wrapper around equation of state calculation */
652 void rho_eos (const amrex::Box& bx,
653 const amrex::Array4<amrex::Real const>& state,
654 const amrex::Array4<amrex::Real >& rho,
655 const amrex::Array4<amrex::Real >& rhoA,
656 const amrex::Array4<amrex::Real >& rhoS,
657 const amrex::Array4<amrex::Real >& bvf,
658 const amrex::Array4<amrex::Real >& alpha,
659 const amrex::Array4<amrex::Real >& beta,
660 const amrex::Array4<amrex::Real const>& Hz,
661 const amrex::Array4<amrex::Real const>& z_w,
662 const amrex::Array4<amrex::Real const>& z_r,
663 const amrex::Array4<amrex::Real const>& h,
664 const amrex::Array4<amrex::Real const>& mskr,
665 const int N);
666
667 /** \brief Calculate density and related quantities from linear equation of state */
668 void lin_eos (const amrex::Box& bx,
669 const amrex::Array4<amrex::Real const>& state,
670 const amrex::Array4<amrex::Real >& rho,
671 const amrex::Array4<amrex::Real >& rhoA,
672 const amrex::Array4<amrex::Real >& rhoS,
673 const amrex::Array4<amrex::Real >& bvf,
674 const amrex::Array4<amrex::Real const>& Hz,
675 const amrex::Array4<amrex::Real const>& z_w,
676 const amrex::Array4<amrex::Real const>& z_r,
677 const amrex::Array4<amrex::Real const>& h,
678 const amrex::Array4<amrex::Real const>& mskr,
679 const int N);
680
681 /** \brief Calculate density and related quantities from nonlinear equation of state */
682 void nonlin_eos (const amrex::Box& bx,
683 const amrex::Array4<amrex::Real const>& state,
684 const amrex::Array4<amrex::Real >& rho,
685 const amrex::Array4<amrex::Real >& rhoA,
686 const amrex::Array4<amrex::Real >& rhoS,
687 const amrex::Array4<amrex::Real >& bvf,
688 const amrex::Array4<amrex::Real >& alpha,
689 const amrex::Array4<amrex::Real >& beta,
690 const amrex::Array4<amrex::Real const>& Hz,
691 const amrex::Array4<amrex::Real const>& z_w,
692 const amrex::Array4<amrex::Real const>& z_r,
693 const amrex::Array4<amrex::Real const>& h,
694 const amrex::Array4<amrex::Real const>& mskr,
695 const int N);
696
697 /** \brief Calculate pressure gradient */
698 void prsgrd (const amrex::Box& bx,
699 const amrex::Box& gbx,
700 const amrex::Box& utbx,
701 const amrex::Box& vtbx,
702 const amrex::Array4<amrex::Real >& ru,
703 const amrex::Array4<amrex::Real >& rv,
704 const amrex::Array4<amrex::Real const>& pn,
705 const amrex::Array4<amrex::Real const>& pm,
706 const amrex::Array4<amrex::Real const>& rho,
707 const amrex::Array4<amrex::Real >& FC,
708 const amrex::Array4<amrex::Real const>& Hz,
709 const amrex::Array4<amrex::Real const>& z_r,
710 const amrex::Array4<amrex::Real const>& z_w,
711 const amrex::Array4<amrex::Real const>& msku,
712 const amrex::Array4<amrex::Real const>& mskv,
713 const int nrhs, const int N);
714
715 /** \brief Update velocities or tracers with diffusion/viscosity
716 * as the last part of the prestep */
717 void prestep_diffusion (const amrex::Box& bx,
718 const amrex::Box& gbx,
719 const int ioff, const int joff,
720 const amrex::Array4<amrex::Real >& vel,
721 const amrex::Array4<amrex::Real const>& vel_old,
722 const amrex::Array4<amrex::Real >& rvel,
723 const amrex::Array4<amrex::Real const>& Hz,
724 const amrex::Array4<amrex::Real const>& Akv,
725 const amrex::Array4<amrex::Real >& FC,
726 const amrex::Array4<amrex::Real const>& sstr,
727 const amrex::Array4<amrex::Real const>& bstr,
728 const amrex::Array4<amrex::Real const>& z_r,
729 const amrex::Array4<amrex::Real const>& pm,
730 const amrex::Array4<amrex::Real const>& pn,
731 const int iic, const int ntfirst, const int nnew, int nstp, int nrhs, int N,
732 const amrex::Real lambda, const amrex::Real dt_lev);
733
734 /** \brief Calculate effects of vertical viscosity or diffusivity */
735 void vert_visc_3d (const amrex::Box& bx,
736 const int ioff, const int joff,
737 const amrex::Array4<amrex::Real >& phi,
738 const amrex::Array4<amrex::Real const>& Hz,
739 const amrex::Array4<amrex::Real >& Hzk,
740 const amrex::Array4<amrex::Real >& AK,
741 const amrex::Array4<amrex::Real const>& Akv,
742 const amrex::Array4<amrex::Real >& BC,
743 const amrex::Array4<amrex::Real >& DC,
744 const amrex::Array4<amrex::Real >& FC,
745 const amrex::Array4<amrex::Real >& CF,
746 const int nnew, const int N,
747 const amrex::Real dt_lev);
748
749 /** \brief Correct mass flux */
750 void update_massflux_3d (int lev, const amrex::Box& bx,
751 const int ioff, const int joff,
752 const amrex::Array4<amrex::Real >& phi,
753 const amrex::Array4<amrex::Real >& phibar,
754 const amrex::Array4<amrex::Real >& Hphi,
755 const amrex::Array4<amrex::Real const>& Hz,
756 const amrex::Array4<amrex::Real const>& pm_or_pn,
757 const amrex::Array4<amrex::Real const>& Dphi1,
758 const amrex::Array4<amrex::Real const>& Dphi2,
759 const amrex::Array4<amrex::Real >& DC,
760 const amrex::Array4<amrex::Real >& FC,
761 const amrex::Array4<amrex::Real const>& msk,
762 const int nnew);
763
764 /** \brief Adjust 3D momentum variables based on vertical mean momentum */
765 void vert_mean_3d (const amrex::Box& bx,
766 const int ioff, const int joff,
767 const amrex::Array4<amrex::Real >& phi,
768 const amrex::Array4<amrex::Real const>& Hz,
769 const amrex::Array4<amrex::Real const>& Dphi_avg1,
770 const amrex::Array4<amrex::Real >& DC,
771 const amrex::Array4<amrex::Real >& CF,
772 const amrex::Array4<amrex::Real const>& pm_or_pn,
773 const amrex::Array4<amrex::Real const>& msk,
774 const int nnew, const int N);
775
776 /** \brief Harmonic viscosity */
777 void uv3dmix (const amrex::Box& xbx,
778 const amrex::Box& ybx,
779 const amrex::Array4<amrex::Real >& u,
780 const amrex::Array4<amrex::Real >& v,
781 const amrex::Array4<amrex::Real const>& uold,
782 const amrex::Array4<amrex::Real const>& vold,
783 const amrex::Array4<amrex::Real >& rufrc,
784 const amrex::Array4<amrex::Real >& rvfrc,
785 const amrex::Array4<amrex::Real const>& visc2_p,
786 const amrex::Array4<amrex::Real const>& visc2_r,
787 const amrex::Array4<amrex::Real const>& Hz,
788 const amrex::Array4<amrex::Real const>& pm,
789 const amrex::Array4<amrex::Real const>& pn,
790 const amrex::Array4<amrex::Real const>& mskp,
791 int nrhs, int nnew,
792 const amrex::Real dt_lev);
793
794 /** \brief Harmonic diffusivity for tracers */
795 void t3dmix (const amrex::Box& bx,
796 const amrex::Array4<amrex::Real >& state,
797 const amrex::Array4<amrex::Real >& state_rhs,
798 const amrex::Array4<amrex::Real const>& diff2,
799 const amrex::Array4<amrex::Real const>& Hz,
800 const amrex::Array4<amrex::Real const>& pm,
801 const amrex::Array4<amrex::Real const>& pn,
802 const amrex::Array4<amrex::Real const>& msku,
803 const amrex::Array4<amrex::Real const>& mskv,
804 const amrex::Real dt_lev,
805 const int ncomp);
806
807 /** \brief Calculate Coriolis terms */
808 void coriolis (const amrex::Box& xbx,
809 const amrex::Box& ybx,
810 const amrex::Array4<amrex::Real const>& uold,
811 const amrex::Array4<amrex::Real const>& vold,
812 const amrex::Array4<amrex::Real >& ru,
813 const amrex::Array4<amrex::Real >& rv,
814 const amrex::Array4<amrex::Real const>& Hz,
815 const amrex::Array4<amrex::Real const>& fomn,
816 int nrhs, int nr);
817
818 /** \brief Apply climatology nudging */
819 void apply_clim_nudg (const amrex::Box& bx,
820 int ioff, int joff,
821 const amrex::Array4<amrex::Real >& var,
822 const amrex::Array4<amrex::Real const>& var_old,
823 const amrex::Array4<amrex::Real const>& var_clim,
824 const amrex::Array4<amrex::Real const>& clim_coeff,
825 const amrex::Array4<amrex::Real const>& Hz,
826 const amrex::Array4<amrex::Real const>& pm,
827 const amrex::Array4<amrex::Real const>& pn,
828 const amrex::Real dt_lev = amrex::Real(0.0));
829
830 /** \brief Set 2D momentum arrays from 3D momentum */
831 void set_2darrays (int lev);
832
833 /** \brief Set Zt_avg1 to zeta */
834 void set_zeta_average (int lev);
835
836 /** \brief Initialize zeta from file or analytic */
837 void set_zeta (int lev);
838
839 /** \brief Initialize bathymetry from file or analytic */
840 void set_bathymetry (int lev);
841
842 /** \brief Initialize Coriolis factor from file or analytic */
843 void set_coriolis (int lev);
844
845 /** \brief Initialize land-sea masks from file or analytic */
846 void set_masks (int lev);
847
848 /** \brief Calculate vertical stretched coordinates */
849 void stretch_transform (int lev);
850
851 /** \brief Initialize vertical mixing coefficients from file or analytic */
852 void init_set_vmix (int lev);
853 /** \brief Set vertical mixing coefficients from analytic */
854 void set_analytic_vmix (int lev);
855 /** \brief Initialize GLS variables */
856 void init_gls_vmix (int lev, SolverChoice solver_choice);
857 /** \brief Prestep for GLS calculation */
858 void gls_prestep (int lev, amrex::MultiFab* mf_gls, amrex::MultiFab* mf_tke,
859 amrex::MultiFab& mf_W,
860 amrex::MultiFab* mf_msku, amrex::MultiFab* mf_mskv,
861 const int nstp, const int nnew, const int iic, const int ntfirst,
862 const int N, const amrex::Real dt_lev);
863 /** \brief Corrector step for GLS calculation */
864 void gls_corrector (int lev, amrex::MultiFab* mf_gls, amrex::MultiFab* mf_tke,
865 amrex::MultiFab& mf_W, amrex::MultiFab* mf_Akv, amrex::MultiFab* mf_Akt,
866 amrex::MultiFab* mf_Akk, amrex::MultiFab* mf_Akp,
867 amrex::MultiFab* mf_mskr,
868 amrex::MultiFab* mf_msku, amrex::MultiFab* mf_mskv,
869 const int nstp, const int nnew,
870 const int N, const amrex::Real dt_lev);
871
872 /** \brief Scale RHS momentum variables by 1/cell area, needed before FillPatch to different levels*/
873 void scale_rhs_vars ();
874 /** \brief Scale RHS momentum variables by cell area, needed after FillPatch to different levels*/
875 void scale_rhs_vars_inv ();
876
877 /** \brief Initialize or calculate surface momentum flux from file or analytic */
878 void set_smflux (int lev);
879
880 /** \brief Initialize or calculate wind speed from file or analytic */
881 void set_wind (int lev);
882
883 /** \brief Initialize horizontal mixing coefficients */
884 void set_hmixcoef (int lev);
885
886 /** \brief Initialize flat bathymetry to value from problo */
887 void init_flat_bathymetry (int lev);
888
889 /** \brief Initialize or calculate bottom drag */
890 void set_drag (int lev);
891
892 /** \brief Set weights for averaging 3D variables to 2D */
893 void set_weights (int lev);
894
895 /** \brief Fill the physical boundary conditions for cell-centered velocity (diagnostic only) */
896 void FillBdyCCVels (int lev, amrex::MultiFab& mf_cc_vel);
897
898 /** \brief Fill a new MultiFab by copying in phi from valid region and filling ghost cells */
899 void FillPatch (int lev, amrex::Real time,
900 amrex::MultiFab& mf_to_be_filled,
901 amrex::Vector<amrex::MultiFab*> const& mfs,
902 const int bccomp,
903 const int bdy_var_type = BdyVars::null,
904 const int icomp=0,
905 const bool fill_all=true,
906 const bool fill_set=true,
907 const int n_not_fill=0,
908 const int icomp_calc=0,
909 const amrex::Real dt = amrex::Real(0.0),
910 const amrex::MultiFab& mf_calc = amrex::MultiFab());
911
912 /** \brief Fill a new MultiFab by copying in phi from valid region and filling ghost cells without applying boundary conditions */
913 void FillPatchNoBC (int lev, amrex::Real time,
914 amrex::MultiFab& mf_to_be_filled,
915 amrex::Vector<amrex::MultiFab*> const& mfs,
916 const int bdy_var_type = BdyVars::null,
917 const int icomp=0,
918 const bool fill_all=true,
919 const bool fill_set=true);
920 /** \brief Fill boundary data from netcdf file */
921 void fill_from_bdyfiles (int lev,
922 amrex::MultiFab& mf_to_fill,
923 const amrex::MultiFab& mf_mask,
924 const amrex::Real time,
925 const int bccomp,
926 const int bdy_var_type,
927 const int icomp_to_fill,
928 const int icomp_calc = 0,
929 const amrex::MultiFab& mf_calc = amrex::MultiFab(),
930 const amrex::Real = amrex::Real(0.0));
931
932 /** \brief fill an entire multifab by interpolating from the coarser level
933 * using the piecewise constant interpolater */
934 void FillCoarsePatchPC (int lev, amrex::Real time, amrex::MultiFab* mf_fine,
935 amrex::MultiFab* mf_crse,
936 const int bccomp,
937 const int bdy_var_type = BdyVars::null,
938 const int icomp = 0,
939 const bool fill_all = true,
940 const int n_not_fill=0,
941 const int icomp_calc=0,
942 const amrex::Real dt = amrex::Real(0.0),
943 const amrex::MultiFab& mf_calc = amrex::MultiFab());
944
945 /** \brief fill an entire multifab by interpolating from the coarser level */
946 void FillCoarsePatch (int lev, amrex::Real time, amrex::MultiFab* mf_fine,
947 amrex::MultiFab* mf_crse,
948 const int bccomp,
949 const int bdy_var_type = BdyVars::null,
950 const int icomp = 0,
951 const bool fill_all = true,
952 const int n_not_fill=0,
953 const int icomp_calc=0,
954 const amrex::Real dt = amrex::Real(0.0),
955 const amrex::MultiFab& mf_calc = amrex::MultiFab());
956
957 /** \brief fill an entire multifab by interpolating from the coarser level,
958 * explicitly specifying interpolator to use */
959 void FillCoarsePatchMap (int lev, amrex::Real time, amrex::MultiFab* mf_fine,
960 amrex::MultiFab* mf_crse,
961 const int bccomp,
962 const int bdy_var_type = BdyVars::null,
963 const int icomp = 0,
964 const bool fill_all = true,
965 const int n_not_fill=0,
966 const int icomp_calc=0,
967 const amrex::Real dt = amrex::Real(0.0),
968 const amrex::MultiFab& mf_calc = amrex::MultiFab(),
969 amrex::Interpolater* mapper = nullptr);
970
971 /** \brief initialize and calculate stretch coefficients */
972 void init_stretch_coeffs ();
973 /** \brief calculate vertical stretch coefficients */
974 void calc_stretch_coeffs ();
975
976 /** \brief Calculate Coriolis parameters from beta plane parametrization */
977 void init_beta_plane_coriolis (int lev);
978
979 /** \brief Problem initialization from NetCDF file */
980 void init_data_from_netcdf (int lev);
981 /** \brief Boundary data initialization from NetCDF file */
982 void init_bdry_from_netcdf (int lev);
983 /** \brief Mask data initialization from NetCDF file */
984 void init_masks_from_netcdf (int lev);
985 /** \brief Bathymetry data initialization from NetCDF file */
986 void init_bathymetry_from_netcdf (int lev);
987 /** \brief Sea-surface height data initialization from NetCDF file */
988 void init_zeta_from_netcdf (int lev);
989 /** \brief Coriolis parameter data initialization from NetCDF file */
990 void init_coriolis_from_netcdf (int lev);
991 /** \brief Climatology nudging coefficient initialization from NetCDF file */
993 /** \brief Wrapper to initialize climatology nudging coefficient */
994 void init_clim_nudg_coeff (int lev);
995 void init_riv_pos_from_netcdf (int lev);
996
997 /** \brief Convert data in a multifab from inverse days to inverse seconds */
998 void convert_inv_days_to_inv_s (amrex::MultiFab*);
999
1000 /** \brief Mask data arrays before writing output */
1001 void mask_arrays_for_write (int lev, amrex::Real fill_value, amrex::Real fill_where);
1002
1003
1004#ifdef REMORA_USE_NETCDF
1006#endif
1007
1008private:
1009
1010 ///////////////////////////
1011 // private member functions
1012 ///////////////////////////
1013
1014 /** \brief read in some parameters from inputs file */
1015 void ReadParameters();
1016
1017 /** \brief set covered coarse cells to be the average of overlying fine cells */
1018 void AverageDown ();
1019
1020 /** \brief Read in boundary parameters from input file and set up data structures */
1021 void init_bcs();
1022
1023 /** \brief Initialize initial problem data from analytic functions */
1024 void init_analytic(int lev);
1025
1026 /** \brief Allocate MultiFabs for state and evolution variables */
1027 void init_stuff (int lev, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm);
1028
1029 /** \brief Allocate MultiFabs for masks */
1030 void init_masks (int lev, const amrex::BoxArray& ba, const amrex::DistributionMapping& dm);
1031
1032 /** \brief Resize variable containers to accommodate data on levels 0 to max_lev */
1033 void resize_stuff (int lev);
1034
1035 /** \brief more flexible version of AverageDown() that lets you average down across multiple levels */
1036 void AverageDownTo (int crse_lev);
1037
1038 /** \brief Construct FillPatchers */
1039 void Construct_REMORAFillPatchers (int lev);
1040
1041 /** \brief Define FillPatchers */
1042 void Define_REMORAFillPatchers (int lev);
1043
1044 /** \brief utility to copy in data from old and/or new state into another multifab */
1045 TimeInterpolatedData GetDataAtTime (int lev, amrex::Real time);
1046
1047 /** \brief advance a level by dt, includes a recursive call for finer levels */
1048 void timeStep (int lev, amrex::Real time, int iteration);
1049
1050 /** \brief advance all levels by dt, loops over finer levels */
1051 void timeStepML (amrex::Real time, int iteration);
1052
1053 /** \brief a wrapper for estTimeStep() */
1054 void ComputeDt ();
1055
1056 /** \brief get plotfile name */
1057 std::string PlotFileName (int lev) const;
1058
1059 /* set which variables and derived quantities go into plotfiles */
1060 void set2DPlotVariables (const std::string& pp_plot_var_names_2d);
1061 void set3DPlotVariables (const std::string& pp_plot_var_names_3d);
1062
1063 /* append variables to plot */
1064 void append2DPlotVariables (const std::string& pp_plot_var_names_2d);
1065 void append3DPlotVariables (const std::string& pp_plot_var_names_3d);
1066
1067#ifdef REMORA_USE_NETCDF
1068 /** \brief Write plotfile using NetCDF (wrapper) */
1069 void WriteNCPlotFile (int istep);
1070 /** \brief Write a particular NetCDF plotfile */
1071 void WriteNCPlotFile_which (int lev, int which_subdomain,
1072 bool write_header, ncutils::NCFile& ncf,
1073 bool is_history);
1074
1075 /** \brief Write MultiFab in NetCDF format */
1076 void WriteNCMultiFab (const amrex::FabArray<amrex::FArrayBox> &fab,
1077 const std::string& name,
1078 bool set_ghost = false) const;
1079
1080 /** \brief Read MultiFab in NetCDF format */
1081 void ReadNCMultiFab (amrex::FabArray<amrex::FArrayBox> &fab,
1082 const std::string &name,
1083 int coordinatorProc = amrex::ParallelDescriptor::IOProcessorNumber(),
1084 int allow_empty_mf = 0);
1085
1086 /** \brief Start time in the time series of boundary data */
1087 amrex::Real start_bdy_time;
1088 /** \brief Interval between boundary data times */
1090
1091 /** \brief Whether to output NetCDF files as a single history file with several time steps */
1093
1094 /** \brief Data container for u-component surface momentum flux read from file */
1096 /** \brief Data container for v-component surface momentum flux read from file */
1098 /** \brief Data container for u-direction wind read from file */
1100 /** \brief Data container for v-direction wind read from file */
1102 /** \brief Data container for air temperature read from file */
1104 /** \brief Data container for specific humidity read from file */
1106 /** \brief Data container for air pressure read from file */
1108 /** \brief Data container for shortwave radiation flux read from file */
1110 /** \brief Data container for precipitation rate read from file */
1112 /** \brief Data container for cloud cover fraction read from file */
1114 /** \brief Data container for evaporation minus precipitation read from file */
1116
1117 /** \brief Data container for ubar climatology data read from file */
1119 /** \brief Data container for vbar climatology data read from file */
1121 /** \brief Data container for u-velocity climatology data read from file */
1123 /** \brief Data container for v-velocity climatology data read from file */
1125 /** \brief Data container for temperature climatology data read from file */
1127 /** \brief Data container for salinity climatology data read from file */
1129
1130 /** \brief Vector of data containers for scalar data in rivers */
1131 amrex::Vector<NCTimeSeriesRiver*> river_source_cons;
1132 /** \brief Data container for momentum transport in rivers */
1134 /** \brief Data container for vertically integrated momentum transport in rivers */
1136
1137 /** \brief Vector over BdyVars of boundary series data containers */
1138 amrex::Vector<amrex::Vector<NCTimeSeriesBoundary*>> boundary_series;
1139
1140#endif // REMORA_USE_NETCDF
1141 /** \brief iMultiFab for river positions; contents are indices of rivers */
1142 amrex::Vector<std::unique_ptr<amrex::iMultiFab>> vec_river_position;
1143 /** \brief Vector over rivers of river direction: 0: u-face; 1: v-face; 2: w-face */
1144 amrex::Gpu::DeviceVector<int> river_direction;
1145
1146
1147#ifdef REMORA_USE_MOAB
1148 /** \brief Initialize connection to MOAB */
1149 void InitMOABMesh();
1150#endif
1151 /** \brief Nudging width at coarse-fine interface */
1152 int cf_width{0};
1153 /** \brief Width for fixing values at coarse-fine interface */
1155 // Fillpatcher classes for coarse-fine boundaries
1156 /** \brief Vector over levels of FillPatchers for scalars */
1157 amrex::Vector<REMORAFillPatcher> FPr_c;
1158 /** \brief Vector over levels of FillPatchers for u (3D) */
1159 amrex::Vector<REMORAFillPatcher> FPr_u;
1160 /** \brief Vector over levels of FillPatchers for v (3D) */
1161 amrex::Vector<REMORAFillPatcher> FPr_v;
1162 /** \brief Vector over levels of FillPatchers for w */
1163 amrex::Vector<REMORAFillPatcher> FPr_w;
1164
1165 // Fillpatcher classes for 2d velocity variables
1166 /** \brief Vector over levels of FillPatchers for ubar (2D) */
1167 amrex::Vector<REMORAFillPatcher> FPr_ubar;
1168 /** \brief Vector over levels of FillPatchers for vbar (2D) */
1169 amrex::Vector<REMORAFillPatcher> FPr_vbar;
1170
1171 /** \brief write checkpoint file to disk */
1172 void WriteCheckpointFile ();
1173
1174 /** \brief read checkpoint file from disk */
1175 void ReadCheckpointFile ();
1176
1177 /** \brief Read the file passed to remora.restart and use it as an initial condition for the current simulation */
1179
1180 /** \brief Initialize the new-time data at a level from the initial_data MultiFab */
1181 void InitializeLevelFromData (int lev, const amrex::MultiFab& initial_data);
1182
1183 /** \brief utility to skip to next line in Header */
1184 static void GotoNextLine (std::istream& is);
1185
1186 ////////////////
1187 // private data members
1188
1189 /** \brief Pointer to container of analytical functions for problem definition */
1190 std::unique_ptr<ProblemBase> prob = nullptr;
1191
1192 /** \brief how many boxes specified at each level by tagging criteria */
1193 amrex::Vector<int> num_boxes_at_level;
1194 /** \brief how many netcdf input files specified at each level */
1195 amrex::Vector<int> num_files_at_level;
1196 /** \brief the boxes specified at each level by tagging criteria */
1197 amrex::Vector<amrex::Vector<amrex::Box>> boxes_at_level;
1198
1199 /** \brief which step? */
1200 amrex::Vector<int> istep;
1201 /** \brief How many substeps on each level? */
1202 amrex::Vector<int> nsubsteps;
1203 /** \brief new time at each level */
1204 amrex::Vector<amrex::Real> t_new;
1205 /** \brief old time at each level */
1206 amrex::Vector<amrex::Real> t_old;
1207 /** \brief time step at each level */
1208 amrex::Vector<amrex::Real> dt;
1209
1210 /** \brief whether to set boundary conditions by variable rather than just by side */
1212
1213 /** \brief Vector (over level) of functors to apply physical boundary conditions */
1214 amrex::Vector<std::unique_ptr<REMORAPhysBCFunct>> physbcs;
1215
1216 /** \brief array of flux registers for refluxing in multilevel */
1217 amrex::Vector<amrex::YAFluxRegister*> advflux_reg;
1218
1219 ////////////////
1220 // boundary data members
1221
1222 // A BCRec is essentially a 2*DIM integer array storing the boundary
1223 // condition type at each lo/hi walls in each direction. We have one BCRec
1224 // for each component of the cell-centered variables and each velocity component.
1225 /** \brief vector (over BCVars) of BCRecs */
1226 amrex::Vector <amrex::BCRec> domain_bcs_type;
1227 /** \brief GPU vector (over BCVars) of BCRecs */
1228 amrex::Gpu::DeviceVector<amrex::BCRec> domain_bcs_type_d;
1229
1230 /** \brief Array of strings describing domain boundary conditions */
1231 amrex::Array<std::string,2*AMREX_SPACEDIM> domain_bc_type;
1232
1233 /** \brief Array holding the Dirichlet values at walls which need them */
1234 amrex::Array<amrex::Array<amrex::Real, AMREX_SPACEDIM*2>,AMREX_SPACEDIM+NCONS+8> m_bc_extdir_vals;
1235
1236 /** \brief Array holding the "physical" boundary condition types (e.g. "inflow") */
1237 amrex::GpuArray<amrex::GpuArray<REMORA_BC, AMREX_SPACEDIM*2>,BCVars::NumTypes> phys_bc_type;
1238
1239 /** \brief These are flags that indicate whether we need to read in boundary data from file */
1240 amrex::GpuArray<amrex::GpuArray<bool, AMREX_SPACEDIM*2>,BdyVars::NumTypes+1> phys_bc_need_data;
1241
1242 /** \brief Container to connect boundary data being read in boundary condition containers.
1243 *
1244 * Needed for phys_bc_need_data to work correctly
1245 */
1246 amrex::Vector<int> bdy_index;
1247
1248 /** \brief Step when we last output a plotfile */
1250 /** \brief Simulation time when we last output a plotfile */
1252
1253 /** \brief Step when we last output a checkpoint file */
1255 /** \brief Simulation time when we last output a checkpoint file */
1257 /** \brief Whether to output a plotfile on restart from checkpoint */
1259
1260 ////////////////
1261 // runtime parameters
1262
1263 /** \brief maximum number of steps */
1264 int max_step = std::numeric_limits<int>::max();
1265 /** \brief Time to stop */
1266 amrex::Real stop_time = std::numeric_limits<amrex::Real>::max();
1267
1268 /** \brief Time of the start of the simulation, in seconds */
1269 amrex::Real start_time = 0.0;
1270
1271 /** \brief If set, restart from this checkpoint file */
1272 std::string restart_chkfile = "";
1273
1274 // Time step controls
1275 /** \brief CFL condition */
1276 static amrex::Real cfl;
1277 /** \brief Fraction maximum change in subsequent time steps */
1278 static amrex::Real change_max;
1279 /** \brief User specified fixed baroclinic time step */
1280 static amrex::Real fixed_dt;
1281 /** \brief User specified fixed barotropic time step */
1282 static amrex::Real fixed_fast_dt;
1283 /** \brief User specified, number of barotropic steps per baroclinic step */
1285 /** \brief Number of fast steps to take */
1287
1288 /** \brief Whether to substep fine levels in time */
1289 int do_substep = 0;
1290
1291 /** \brief how often each level regrids the higher levels of refinement (after a level advances that many time steps) */
1292 int regrid_int = 2;
1293
1294 // I/O controls
1295 /** \brief Plotfile prefix */
1296 std::string plot_file_name {"plt_"};
1297 /** \brief Plotfile output interval in iterations */
1298 int plot_int = -1;
1299 /** \brief Plotfile output interval in seconds */
1300 amrex::Real plot_int_time = amrex::Real(-1.0);
1301 /** \brief Checkpoint file prefix */
1302 std::string check_file {"chk"};
1303 /** \brief Checkpoint output interval in iterations */
1304 int check_int = -1;
1305 /** \brief Checkpoint output interval in seconds */
1306 amrex::Real check_int_time = amrex::Real(-1.0);
1307
1308 /** \brief Whether to chunk netcdf history file */
1310 /** \brief Number of time steps per netcdf history file.
1311 *
1312 -1 is the default and means code will automatically compute
1313 number of steps per file based on grid size to keep files < 2 GB */
1315 /** \brief Counter for which time index we are writing to in the netcdf history file */
1317
1318 /** \brief Names of 3D variables to output to AMReX plotfile */
1319 amrex::Vector<std::string> plot_var_names_3d;
1320 /** \brief Names of 2D variables to output to AMReX plotfile */
1321 amrex::Vector<std::string> plot_var_names_2d;
1322 /** \brief Names of scalars for plotfile output */
1323 const amrex::Vector<std::string> cons_names {"temp", "salt", "scalar"};
1324 // Note that the order of variable names here must match the order in PlotFile.cpp
1325 /** \brief Names of derived fields for plotfiles */
1326 const amrex::Vector<std::string> derived_names {"vorticity"};
1327
1328 /** \brief Container for algorithmic choices */
1330
1331 /** \brief whether plotfile variables should be expanded to a uniform refinement ratio */
1333
1334#ifdef REMORA_USE_PARTICLES
1335 /** \brief Particle container with all particle species */
1336 ParticleData particleData;
1337
1338 // variables and functions for tracers particles
1339 /** \brief tracer particles that advect with flow */
1340 bool m_use_tracer_particles;
1341 /** \brief tracer particles that fall with gravity */
1342 bool m_use_hydro_particles;
1343
1344 /** \brief Read tracer and hydro particles parameters */
1345 void readTracersParams();
1346
1347 /** \brief Initialize tracer and hydro particles */
1348 void initializeTracers ( amrex::ParGDBBase*,
1349 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& );
1350
1351 /** \brief Evolve tracers and hydro particles */
1352 void evolveTracers( int lev,
1353 amrex::Real dt,
1354 amrex::Vector<amrex::MultiFab const*>& flow_vel,
1355 const amrex::Vector<std::unique_ptr<amrex::MultiFab>>& );
1356
1357#endif
1358 /** \brief Verbosity level of output */
1359 static int verbose;
1360
1361 /** \brief Diagnostic sum output interval in number of steps */
1362 static int sum_interval;
1363 /** \brief Diagnostic sum output interval in time */
1364 static amrex::Real sum_per;
1365
1366 /** \brief Minimum number of digits in plotfile name or chunked history file */
1368
1369 /** \brief Whether to write the staggered velocities (not averaged to cell centers) */
1371
1372 /** \brief Native or NetCDF plotfile output */
1374
1375 /** \brief NetCDF initialization file */
1376 static amrex::Vector<amrex::Vector<std::string>> nc_init_file;
1377 /** \brief NetCDF grid file */
1378 static amrex::Vector<amrex::Vector<std::string>> nc_grid_file;
1379 /** \brief NetCDF boundary data */
1380 static amrex::Vector<std::string> nc_bdry_file;
1381
1382 /** \brief NetCDF forcing file */
1383 std::string nc_frc_file;
1384 std::string nc_riv_file;
1385
1386 /** \brief NetCDF climatology history file */
1387 std::string nc_clim_his_file;
1388 /** \brief NetCDF climatology coefficient file */
1390
1391 /** \brief Default name of time field for boundary data */
1392 std::string bdry_time_varname = "ocean_time";
1393 /** \brief Name of time fields for boundary data */
1394 amrex::Vector<std::string> bdry_time_name_byvar;
1395
1396 /** \brief Name of time field for ubar climatology data */
1397 std::string clim_ubar_time_varname = "ocean_time";
1398 /** \brief Name of time field for vbar climatology data */
1399 std::string clim_vbar_time_varname = "ocean_time";
1400 /** \brief Name of time field for u climatology data */
1401 std::string clim_u_time_varname = "ocean_time";
1402 /** \brief Name of time field for v climatology data */
1403 std::string clim_v_time_varname = "ocean_time";
1404 /** \brief Name of time field for salinity climatology data */
1405 std::string clim_salt_time_varname = "ocean_time";
1406 /** \brief Name of time field for temperature climatology data */
1407 std::string clim_temp_time_varname = "ocean_time";
1408 /** \brief Name of time field for river time */
1409 std::string riv_time_varname = "river_time";
1410 /** \brief Name of time field for forcing data */
1411 std::string frc_time_varname = "";
1412
1413
1414 /** \brief Set refinement criteria */
1416
1417 /** \brief Holds info for dynamically generated tagging criteria */
1418 static amrex::Vector<amrex::AMRErrorTag> ref_tags;
1419
1420 /** \brief Mask that zeroes out values on a coarse level underlying grids on the next finest level */
1421 amrex::MultiFab fine_mask;
1422
1423 /** \brief Helper function to determine number of ghost cells */
1424 AMREX_FORCE_INLINE
1425 int
1426 ComputeGhostCells(const int& spatial_order) {
1427 int nGhostCells = 0;
1428 switch (spatial_order) {
1429 case 2:
1430 nGhostCells = 2; // We need this many to compute the eddy viscosity in the ghost cells
1431 break;
1432 case 3:
1433 nGhostCells = 2;
1434 break;
1435 case 4:
1436 nGhostCells = 2;
1437 break;
1438 case 5:
1439 nGhostCells = 3;
1440 break;
1441 case 6:
1442 nGhostCells = 3;
1443 break;
1444 default:
1445 amrex::Error("Must specify spatial order to be 2,3,4,5 or 6");
1446 }
1447
1448 return nGhostCells;
1449 }
1450
1451 /** \brief Get flux register */
1452 AMREX_FORCE_INLINE
1453 amrex::YAFluxRegister* getAdvFluxReg (int lev)
1454 {
1455 return advflux_reg[lev];
1456 }
1457
1458 /** \brief Helper function for IO stream */
1459 AMREX_FORCE_INLINE
1460 std::ostream&
1461 DataLog (int i)
1462 {
1463 return *datalog[i];
1464 }
1465
1466 AMREX_FORCE_INLINE
1467 int
1468 NumDataLogs () noexcept
1469 {
1470 return datalog.size();
1471 }
1472
1473 /** \brief Variable for CPU timing */
1474 static amrex::Real startCPUTime;
1475 /** \brief Accumulator variable for CPU time used thusfar */
1476 static amrex::Real previousCPUTimeUsed;
1477
1478 /** \brief Get CPU time used */
1479 amrex::Real
1481 {
1482 int numCores = amrex::ParallelDescriptor::NProcs();
1483#ifdef _OPENMP
1484 numCores = numCores * omp_get_max_threads();
1485#endif
1486
1487 amrex::Real T =
1488 numCores * (amrex::Real(amrex::ParallelDescriptor::second()) - startCPUTime) +
1490
1491 return T;
1492 }
1493
1494 void setRecordDataInfo (int i, const std::string& filename)
1495 {
1496 if (amrex::ParallelDescriptor::IOProcessor())
1497 {
1498 datalog[i] = std::make_unique<std::fstream>();
1499 datalog[i]->open(filename.c_str(),std::ios::out|std::ios::app);
1500 if (!datalog[i]->good()) {
1501 amrex::FileOpenFailed(filename);
1502 }
1503 }
1504 amrex::ParallelDescriptor::Barrier("REMORA::setRecordDataInfo");
1505 }
1506
1507 amrex::Vector<std::unique_ptr<std::fstream> > datalog;
1508 amrex::Vector<std::string> datalogname;
1509
1510 /** \brief The filename of the ith datalog file. */
1511 const std::string DataLogName (int i) const noexcept { return datalogname[i]; }
1512
1513public:
1514 /** \brief Write job info to stdout */
1515 void writeJobInfo (const std::string& dir) const;
1516 /** \brief Write build info to os */
1517 static void writeBuildInfo (std::ostream& os);
1518
1519 static void print_banner(MPI_Comm /*comm*/, std::ostream& /*out*/);
1520 static void print_usage(MPI_Comm /*comm*/, std::ostream& /*out*/);
1521 static void print_error(MPI_Comm /*comm*/, const std::string& msg);
1522 static void print_summary(std::ostream&);
1523 static void print_tpls(std::ostream& /*out*/);
1524
1525 /** \brief Accessor method for t_old to expose to outside classes */
1526 amrex::Real get_t_old(int lev) const;
1527
1528 /** \brief Evaluate stability function psi for wind speed */
1529 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
1530 static amrex::Real bulk_psiu(amrex::Real ZoL) {
1531 // Compute stability function, psi
1532 using namespace amrex;
1533
1534 Real psiu;
1535 if (ZoL < 0.0_rt) {
1536 // Unstable conditions.
1537 Real x = std::pow(1.0_rt-15.0_rt*ZoL,0.25_rt);
1538 Real psik = 2.0_rt*std::log(0.5_rt*(1.0_rt+x))+
1539 std::log(0.5_rt*(1.0_rt+x*x))-
1540 2.0_rt*std::atan(x)+0.5_rt*PI;
1541 // For very unstable conditions, use free-convection (Fairall).
1542 Real sqrt3 = std::sqrt(3.0_rt);
1543 Real y = std::pow(1.0_rt-10.15_rt*ZoL,1.0_rt/3.0_rt);
1544 Real psic = 1.5_rt*std::log(1.0_rt/3.0_rt*(1.0_rt+y+y*y))-
1545 sqrt3*std::atan((1.0_rt+2.0_rt*y)/sqrt3)+PI/sqrt3;
1546 // Match Kansas and free-convection forms with weighting Fw.
1547 Real Zol2 = ZoL*ZoL;
1548 Real Fw = Zol2/(1.0_rt+Zol2);
1549
1550 psiu = (1.0_rt-Fw)*psik+Fw*psic;
1551 } else {
1552 // Stable conditions
1553 Real cff=std::min(50.0_rt,0.35_rt*ZoL);
1554 psiu = -((1.0_rt+ZoL)+0.6667_rt*(ZoL-14.28_rt)/
1555 std::exp(cff)+8.525_rt);
1556 }
1557 return psiu;
1558 }
1559
1560 /** \brief Evaluate stability function psi for moisture and heat */
1561 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
1562 static amrex::Real bulk_psit(amrex::Real ZoL) {
1563 // Compute stability function, psi
1564 using namespace amrex;
1565
1566 Real psit;
1567 if (ZoL < 0.0_rt) {
1568 // Unstable conditions.
1569 Real x = std::pow(1.0_rt-15.0_rt*ZoL,0.5_rt);
1570 Real psik = 2.0_rt*std::log(0.5_rt*(1.0_rt+x));
1571 // For very unstable conditions, use free-convection (Fairall).
1572 Real sqrt3=std::sqrt(3.0_rt);
1573 Real y=std::pow(1.0_rt-34.15_rt*ZoL,1.0_rt/3.0_rt);
1574 Real psic=1.5_rt*std::log(1.0_rt/3.0_rt*(1.0_rt+y+y*y))-
1575 sqrt3*std::atan((1.0_rt+2.0_rt*y)/sqrt3)+PI/sqrt3;
1576
1577 // Match Kansas and free-convection forms with weighting Fw.
1578 Real ZoL2=ZoL*ZoL;
1579 Real Fw=ZoL2/(1.0_rt+ZoL2);
1580 psit = (1.0_rt-Fw)*psik+Fw*psic;
1581 } else {
1582 // Stable conditions.
1583 Real cff=std::min(50.0_rt,0.35_rt*ZoL);
1584 psit=-(std::pow(1.0_rt+2.0_rt*ZoL,1.5_rt)+
1585 0.6667_rt*(ZoL-14.28_rt)/std::exp(cff)+8.525_rt);
1586 }
1587 return psit;
1588 }
1589};
1590
1591#endif
constexpr amrex::Real PI
PlotfileType
plotfile format
#define NCONS
A class to hold and interpolate time series data read from a NetCDF file.
A class to hold and interpolate time series data read from a NetCDF file.
Class that stores all relevant simulation state data with methods for time stepping.
Definition REMORA.H:90
static PlotfileType plotfile_type
Native or NetCDF plotfile output.
Definition REMORA.H:1373
NCTimeSeriesRiver * river_source_transportbar
Data container for vertically integrated momentum transport in rivers.
Definition REMORA.H:1135
const amrex::Vector< std::string > cons_names
Names of scalars for plotfile output.
Definition REMORA.H:1323
void FillCoarsePatchPC(int lev, amrex::Real time, amrex::MultiFab *mf_fine, amrex::MultiFab *mf_crse, const int bccomp, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const int n_not_fill=0, const int icomp_calc=0, const amrex::Real dt=amrex::Real(0.0), const amrex::MultiFab &mf_calc=amrex::MultiFab())
fill an entire multifab by interpolating from the coarser level using the piecewise constant interpol...
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_EminusP
evaporation minus precipitation [kg/m^2/s], defined at rho-points
Definition REMORA.H:351
std::string riv_time_varname
Name of time field for river time.
Definition REMORA.H:1409
static void GotoNextLine(std::istream &is)
utility to skip to next line in Header
int nfast
Number of fast steps to take.
Definition REMORA.H:1286
void WriteNCMultiFab(const amrex::FabArray< amrex::FArrayBox > &fab, const std::string &name, bool set_ghost=false) const
Write MultiFab in NetCDF format.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rv2d
v velocity RHS (2D, includes horizontal and vertical advection)
Definition REMORA.H:268
void prsgrd(const amrex::Box &bx, const amrex::Box &gbx, const amrex::Box &utbx, const amrex::Box &vtbx, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &rho, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &msku, const amrex::Array4< amrex::Real const > &mskv, const int nrhs, const int N)
Calculate pressure gradient.
static amrex::Real fixed_dt
User specified fixed baroclinic time step.
Definition REMORA.H:1280
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_evap
evaporation rate [kg/m^2/s]
Definition REMORA.H:347
amrex::Real last_plot_file_time
Simulation time when we last output a plotfile.
Definition REMORA.H:1251
void update_massflux_3d(int lev, const amrex::Box &bx, const int ioff, const int joff, const amrex::Array4< amrex::Real > &phi, const amrex::Array4< amrex::Real > &phibar, const amrex::Array4< amrex::Real > &Hphi, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pm_or_pn, const amrex::Array4< amrex::Real const > &Dphi1, const amrex::Array4< amrex::Real const > &Dphi2, const amrex::Array4< amrex::Real > &DC, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real const > &msk, const int nnew)
Correct mass flux.
void scale_rhs_vars()
Scale RHS momentum variables by 1/cell area, needed before FillPatch to different levels.
amrex::Vector< NCTimeSeriesRiver * > river_source_cons
Vector of data containers for scalar data in rivers.
Definition REMORA.H:1131
void init_bathymetry_from_netcdf(int lev)
Bathymetry data initialization from NetCDF file.
void init_bcs()
Read in boundary parameters from input file and set up data structures.
NCTimeSeries * rain_data_from_file
Data container for precipitation rate read from file.
Definition REMORA.H:1111
amrex::Vector< amrex::BCRec > domain_bcs_type
vector (over BCVars) of BCRecs
Definition REMORA.H:1226
bool set_bcs_by_var
whether to set boundary conditions by variable rather than just by side
Definition REMORA.H:1211
void calculate_nodal_masks(int lev)
Calculate u-, v-, and psi-point masks based on rho-point masks after analytic initialization.
static amrex::Real previousCPUTimeUsed
Accumulator variable for CPU time used thusfar.
Definition REMORA.H:1476
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_fcor
coriolis factor (2D)
Definition REMORA.H:403
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_btflux
Bottom tracer flux; input arrays.
Definition REMORA.H:342
void init_gls_vmix(int lev, SolverChoice solver_choice)
Initialize GLS variables.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rubar
barotropic x velocity for the RHS (2D)
Definition REMORA.H:374
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_h
Bathymetry data (2D, positive valued, h in ROMS)
Definition REMORA.H:253
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_pm
horizontal scaling factor: 1 / dx (2D)
Definition REMORA.H:398
amrex::MultiFab fine_mask
Mask that zeroes out values on a coarse level underlying grids on the next finest level.
Definition REMORA.H:1421
void set2DPlotVariables(const std::string &pp_plot_var_names_2d)
amrex::Vector< REMORAFillPatcher > FPr_v
Vector over levels of FillPatchers for v (3D)
Definition REMORA.H:1161
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_ZoBot
Bottom roughness length [m], defined at rho points.
Definition REMORA.H:358
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_DU_avg2
correct time average of barotropic x velocity flux for coupling (2D)
Definition REMORA.H:368
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_lrflx
longwave radiation
Definition REMORA.H:329
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_yv
y_grid on v-points (2D)
Definition REMORA.H:418
static void print_error(MPI_Comm, const std::string &msg)
amrex::Vector< amrex::MultiFab * > cons_new
multilevel data container for current step's scalar data: temperature, salinity, passive scalar
Definition REMORA.H:241
static bool write_history_file
Whether to output NetCDF files as a single history file with several time steps.
Definition REMORA.H:1092
virtual void MakeNewLevelFromCoarse(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
Make a new level using provided BoxArray and DistributionMapping and fill with interpolated coarse le...
void FillCoarsePatch(int lev, amrex::Real time, amrex::MultiFab *mf_fine, amrex::MultiFab *mf_crse, const int bccomp, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const int n_not_fill=0, const int icomp_calc=0, const amrex::Real dt=amrex::Real(0.0), const amrex::MultiFab &mf_calc=amrex::MultiFab())
fill an entire multifab by interpolating from the coarser level
void stretch_transform(int lev)
Calculate vertical stretched coordinates.
amrex::Gpu::DeviceVector< amrex::Real > s_w
Scaled vertical coordinate (range [0,1]) that transforms to z, defined at w-points (cell faces)
Definition REMORA.H:292
amrex::GpuArray< amrex::GpuArray< REMORA_BC, AMREX_SPACEDIM *2 >, BCVars::NumTypes > phys_bc_type
Array holding the "physical" boundary condition types (e.g. "inflow")
Definition REMORA.H:1237
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_vwind
Wind in the v direction, defined at rho-points.
Definition REMORA.H:318
std::unique_ptr< ProblemBase > prob
Pointer to container of analytical functions for problem definition.
Definition REMORA.H:1190
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskr
land/sea mask at cell centers (2D)
Definition REMORA.H:387
void Construct_REMORAFillPatchers(int lev)
Construct FillPatchers.
Definition REMORA.cpp:376
void advance_3d(int lev, amrex::MultiFab &mf_cons, amrex::MultiFab &mf_u, amrex::MultiFab &mf_v, amrex::MultiFab *mf_sstore, amrex::MultiFab *mf_ru, amrex::MultiFab *mf_rv, std::unique_ptr< amrex::MultiFab > &mf_DU_avg1, std::unique_ptr< amrex::MultiFab > &mf_DU_avg2, std::unique_ptr< amrex::MultiFab > &mf_DV_avg1, std::unique_ptr< amrex::MultiFab > &mf_DV_avg2, std::unique_ptr< amrex::MultiFab > &mf_ubar, std::unique_ptr< amrex::MultiFab > &mf_vbar, std::unique_ptr< amrex::MultiFab > &mf_Akv, std::unique_ptr< amrex::MultiFab > &mf_Akt, std::unique_ptr< amrex::MultiFab > &mf_Hz, std::unique_ptr< amrex::MultiFab > &mf_Huon, std::unique_ptr< amrex::MultiFab > &mf_Hvom, std::unique_ptr< amrex::MultiFab > &mf_z_w, amrex::MultiFab const *mf_h, amrex::MultiFab const *mf_pm, amrex::MultiFab const *mf_pn, amrex::MultiFab const *mf_mskr, amrex::MultiFab const *mf_msku, amrex::MultiFab const *mf_mskv, const int N, const amrex::Real dt_lev)
Advance the 3D variables.
static int sum_interval
Diagnostic sum output interval in number of steps.
Definition REMORA.H:1362
int history_count
Counter for which time index we are writing to in the netcdf history file.
Definition REMORA.H:1316
amrex::Real stop_time
Time to stop.
Definition REMORA.H:1266
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rain
precipitation rate [kg/m^2/s]
Definition REMORA.H:345
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_tke
Turbulent kinetic energy.
Definition REMORA.H:446
void rho_eos(const amrex::Box &bx, const amrex::Array4< amrex::Real const > &state, const amrex::Array4< amrex::Real > &rho, const amrex::Array4< amrex::Real > &rhoA, const amrex::Array4< amrex::Real > &rhoS, const amrex::Array4< amrex::Real > &bvf, const amrex::Array4< amrex::Real > &alpha, const amrex::Array4< amrex::Real > &beta, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &h, const amrex::Array4< amrex::Real const > &mskr, const int N)
Wrapper around equation of state calculation.
static void print_summary(std::ostream &)
int do_substep
Whether to substep fine levels in time.
Definition REMORA.H:1289
NCTimeSeries * vbar_clim_data_from_file
Data container for vbar climatology data read from file.
Definition REMORA.H:1120
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_stflx
Surface tracer flux; working arrays.
Definition REMORA.H:336
void Evolve()
Advance solution to final time.
Definition REMORA.cpp:146
NCTimeSeries * Uwind_data_from_file
Data container for u-direction wind read from file.
Definition REMORA.H:1099
std::string bdry_time_varname
Default name of time field for boundary data.
Definition REMORA.H:1392
void ReadCheckpointFile()
read checkpoint file from disk
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_gls
Turbulent generic length scale.
Definition REMORA.H:448
bool chunk_history_file
Whether to chunk netcdf history file.
Definition REMORA.H:1309
void writeJobInfo(const std::string &dir) const
Write job info to stdout.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_sustr
Surface stress in the u direction.
Definition REMORA.H:311
amrex::Real get_t_old(int lev) const
Accessor method for t_old to expose to outside classes.
Definition REMORA.cpp:1300
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_yp
y_grid on psi-points (2D)
Definition REMORA.H:423
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_xr
x_grid on rho points (2D)
Definition REMORA.H:406
NCTimeSeries * v_clim_data_from_file
Data container for v-velocity climatology data read from file.
Definition REMORA.H:1124
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_ru2d
u velocity RHS (2D, includes horizontal and vertical advection)
Definition REMORA.H:266
virtual void ClearLevel(int lev) override
Delete level data Overrides the pure virtual function in AmrCore.
amrex::Vector< std::string > datalogname
Definition REMORA.H:1508
amrex::Vector< amrex::MultiFab * > zvel_new
multilevel data container for current step's z velocities (largely unused; W stored separately)
Definition REMORA.H:247
AMREX_FORCE_INLINE int ComputeGhostCells(const int &spatial_order)
Helper function to determine number of ghost cells.
Definition REMORA.H:1426
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_sstore
additional scratch space for calculations on temp, salt, etc
Definition REMORA.H:426
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_xv
x_grid on v-points (2D)
Definition REMORA.H:416
void init_only(int lev, amrex::Real time)
Init (NOT restart or regrid)
Definition REMORA.cpp:810
void init_set_vmix(int lev)
Initialize vertical mixing coefficients from file or analytic.
Definition REMORA.cpp:631
std::string clim_u_time_varname
Name of time field for u climatology data.
Definition REMORA.H:1401
void rhs_uv_3d(int lev, const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real > &rufrc, const amrex::Array4< amrex::Real > &rvfrc, const amrex::Array4< amrex::Real const > &sustr, const amrex::Array4< amrex::Real const > &svstr, const amrex::Array4< amrex::Real const > &bustr, const amrex::Array4< amrex::Real const > &bvstr, const amrex::Array4< amrex::Real const > &Huon, const amrex::Array4< amrex::Real const > &Hvom, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &W, const amrex::Array4< amrex::Real > &FC, int nrhs, int N)
RHS terms for 3D momentum.
void set_grid_scale(int lev)
Set pm and pn arrays on level lev. Only works if using analytic initialization.
void set_coriolis(int lev)
Initialize Coriolis factor from file or analytic.
Definition REMORA.cpp:602
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Lscale
Vertical mixing turbulent length scale.
Definition REMORA.H:450
amrex::Vector< REMORAFillPatcher > FPr_u
Vector over levels of FillPatchers for u (3D)
Definition REMORA.H:1159
std::string clim_temp_time_varname
Name of time field for temperature climatology data.
Definition REMORA.H:1407
amrex::Vector< amrex::Vector< amrex::Box > > boxes_at_level
the boxes specified at each level by tagging criteria
Definition REMORA.H:1197
void prestep_diffusion(const amrex::Box &bx, const amrex::Box &gbx, const int ioff, const int joff, const amrex::Array4< amrex::Real > &vel, const amrex::Array4< amrex::Real const > &vel_old, const amrex::Array4< amrex::Real > &rvel, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &Akv, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real const > &sstr, const amrex::Array4< amrex::Real const > &bstr, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const int iic, const int ntfirst, const int nnew, int nstp, int nrhs, int N, const amrex::Real lambda, const amrex::Real dt_lev)
Update velocities or tracers with diffusion/viscosity as the last part of the prestep.
void vert_mean_3d(const amrex::Box &bx, const int ioff, const int joff, const amrex::Array4< amrex::Real > &phi, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &Dphi_avg1, const amrex::Array4< amrex::Real > &DC, const amrex::Array4< amrex::Real > &CF, const amrex::Array4< amrex::Real const > &pm_or_pn, const amrex::Array4< amrex::Real const > &msk, const int nnew, const int N)
Adjust 3D momentum variables based on vertical mean momentum.
static amrex::Vector< amrex::AMRErrorTag > ref_tags
Holds info for dynamically generated tagging criteria.
Definition REMORA.H:1418
std::string nc_frc_file
NetCDF forcing file.
Definition REMORA.H:1383
void t3dmix(const amrex::Box &bx, const amrex::Array4< amrex::Real > &state, const amrex::Array4< amrex::Real > &state_rhs, const amrex::Array4< amrex::Real const > &diff2, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &msku, const amrex::Array4< amrex::Real const > &mskv, const amrex::Real dt_lev, const int ncomp)
Harmonic diffusivity for tracers.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Hz
Width of cells in the vertical (z-) direction (3D, Hz in ROMS)
Definition REMORA.H:256
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Akt
Vertical diffusion coefficient (3D)
Definition REMORA.H:276
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_msku
land/sea mask at x-faces (2D)
Definition REMORA.H:389
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rvfrc
v velocity RHS, integrated, including advection and bottom/surface stresses (2D)
Definition REMORA.H:272
std::string clim_ubar_time_varname
Name of time field for ubar climatology data.
Definition REMORA.H:1397
void WriteNCPlotFile(int istep)
Write plotfile using NetCDF (wrapper)
std::string check_file
Checkpoint file prefix.
Definition REMORA.H:1302
void FillPatchNoBC(int lev, amrex::Real time, amrex::MultiFab &mf_to_be_filled, amrex::Vector< amrex::MultiFab * > const &mfs, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const bool fill_set=true)
Fill a new MultiFab by copying in phi from valid region and filling ghost cells without applying boun...
static amrex::Real startCPUTime
Variable for CPU timing.
Definition REMORA.H:1474
NCTimeSeries * u_clim_data_from_file
Data container for u-velocity climatology data read from file.
Definition REMORA.H:1122
amrex::Vector< amrex::MultiFab * > xvel_old
multilevel data container for last step's x velocities (u in ROMS)
Definition REMORA.H:234
amrex::Real start_time
Time of the start of the simulation, in seconds.
Definition REMORA.H:1269
NCTimeSeries * ubar_clim_data_from_file
Data container for ubar climatology data read from file.
Definition REMORA.H:1118
NCTimeSeries * Tair_data_from_file
Data container for air temperature read from file.
Definition REMORA.H:1103
void init_data_from_netcdf(int lev)
Problem initialization from NetCDF file.
void WriteNCPlotFile_which(int lev, int which_subdomain, bool write_header, ncutils::NCFile &ncf, bool is_history)
Write a particular NetCDF plotfile.
void init_masks_from_netcdf(int lev)
Mask data initialization from NetCDF file.
amrex::Vector< amrex::MultiFab * > yvel_new
multilevel data container for current step's y velocities (v in ROMS)
Definition REMORA.H:245
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_uwind
Wind in the u direction, defined at rho-points.
Definition REMORA.H:316
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rufrc
u velocity RHS, integrated, including advection and bottom/surface stresses (2D)
Definition REMORA.H:270
static amrex::Real fixed_fast_dt
User specified fixed barotropic time step.
Definition REMORA.H:1282
int regrid_int
how often each level regrids the higher levels of refinement (after a level advances that many time s...
Definition REMORA.H:1292
amrex::Real check_int_time
Checkpoint output interval in seconds.
Definition REMORA.H:1306
amrex::Real bdy_time_interval
Interval between boundary data times.
Definition REMORA.H:1089
void gls_prestep(int lev, amrex::MultiFab *mf_gls, amrex::MultiFab *mf_tke, amrex::MultiFab &mf_W, amrex::MultiFab *mf_msku, amrex::MultiFab *mf_mskv, const int nstp, const int nnew, const int iic, const int ntfirst, const int N, const amrex::Real dt_lev)
Prestep for GLS calculation.
amrex::Real start_bdy_time
Start time in the time series of boundary data.
Definition REMORA.H:1087
NCTimeSeries * sustr_data_from_file
Data container for u-component surface momentum flux read from file.
Definition REMORA.H:1095
amrex::Vector< amrex::Real > vec_weight2
Weights for calculating avg2 in 2D advance.
Definition REMORA.H:442
amrex::Vector< int > bdy_index
Container to connect boundary data being read in boundary condition containers.
Definition REMORA.H:1246
amrex::Gpu::DeviceVector< amrex::Real > s_r
Scaled vertical coordinate (range [0,1]) that transforms to z, defined at rho points (cell centers)
Definition REMORA.H:290
void Define_REMORAFillPatchers(int lev)
Define FillPatchers.
Definition REMORA.cpp:425
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_shflx
sensible heat flux
Definition REMORA.H:333
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_visc2_p
Harmonic viscosity defined on the psi points (corners of horizontal grid cells)
Definition REMORA.H:278
void set_drag(int lev)
Initialize or calculate bottom drag.
amrex::MultiFab & build_fine_mask(int lev)
Make mask to zero out covered cells (for mesh refinement)
amrex::Real plot_int_time
Plotfile output interval in seconds.
Definition REMORA.H:1300
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rvbar
barotropic y velocity for the RHS (2D)
Definition REMORA.H:376
amrex::Vector< int > num_files_at_level
how many netcdf input files specified at each level
Definition REMORA.H:1195
void advance_2d_onestep(int lev, amrex::Real dt_lev, amrex::Real dtfast_lev, int my_iif, int nfast_counter)
2D advance, one predictor/corrector step
amrex::Vector< REMORAFillPatcher > FPr_vbar
Vector over levels of FillPatchers for vbar (2D)
Definition REMORA.H:1169
void AverageDownTo(int crse_lev)
more flexible version of AverageDown() that lets you average down across multiple levels
Definition REMORA.cpp:1274
int steps_per_history_file
Number of time steps per netcdf history file.
Definition REMORA.H:1314
void post_timestep(int nstep, amrex::Real time, amrex::Real dt_lev)
Called after every level 0 timestep.
Definition REMORA.cpp:233
int max_step
maximum number of steps
Definition REMORA.H:1264
amrex::Vector< amrex::MultiFab * > zvel_old
multilevel data container for last step's z velocities (largely unused; W stored separately)
Definition REMORA.H:238
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_z_r
z coordinates at rho points (cell centers)
Definition REMORA.H:285
NCTimeSeries * qair_data_from_file
Data container for specific humidity read from file.
Definition REMORA.H:1105
amrex::Vector< int > num_boxes_at_level
how many boxes specified at each level by tagging criteria
Definition REMORA.H:1193
amrex::Vector< amrex::MultiFab * > xvel_new
multilevel data container for current step's x velocities (u in ROMS)
Definition REMORA.H:243
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_lhflx
latent heat flux
Definition REMORA.H:331
void refinement_criteria_setup()
Set refinement criteria.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskp
land/sea mask at cell corners (2D)
Definition REMORA.H:393
void remora_advance(int level, amrex::MultiFab &cons_old, amrex::MultiFab &cons_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, const amrex::Geometry fine_geom, const amrex::Real dt, const amrex::Real time)
Interface for advancing the data at one level by one "slow" timestep.
int last_check_file_step
Step when we last output a checkpoint file.
Definition REMORA.H:1254
void prestep(int lev, amrex::MultiFab &mf_uold, amrex::MultiFab &mf_vold, amrex::MultiFab &mf_u, amrex::MultiFab &mf_v, amrex::MultiFab *mf_ru, amrex::MultiFab *mf_rv, amrex::MultiFab &S_old, amrex::MultiFab &S_new, amrex::MultiFab &mf_W, amrex::MultiFab &mf_DC, const amrex::MultiFab *mf_z_r, const amrex::MultiFab *mf_z_w, const amrex::MultiFab *mf_h, const amrex::MultiFab *mf_pm, const amrex::MultiFab *mf_pn, const amrex::MultiFab *mf_sustr, const amrex::MultiFab *mf_svstr, const amrex::MultiFab *mf_bustr, const amrex::MultiFab *mf_bvstr, const amrex::MultiFab *mf_msku, const amrex::MultiFab *mf_mskv, const int iic, const int nfirst, const int nnew, int nstp, int nrhs, int N, const amrex::Real dt_lev)
Wrapper function for prestep.
void init_beta_plane_coriolis(int lev)
Calculate Coriolis parameters from beta plane parametrization.
std::string clim_vbar_time_varname
Name of time field for vbar climatology data.
Definition REMORA.H:1399
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_bvf
Brunt-Vaisala frequency (3D)
Definition REMORA.H:433
virtual void RemakeLevel(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
Remake an existing level using provided BoxArray and DistributionMapping and fill with existing fine ...
NCTimeSeries * cloud_data_from_file
Data container for cloud cover fraction read from file.
Definition REMORA.H:1113
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskv
land/sea mask at y-faces (2D)
Definition REMORA.H:391
void init_masks(int lev, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm)
Allocate MultiFabs for masks.
amrex::Vector< int > nsubsteps
How many substeps on each level?
Definition REMORA.H:1202
amrex::Vector< std::unique_ptr< REMORAPhysBCFunct > > physbcs
Vector (over level) of functors to apply physical boundary conditions.
Definition REMORA.H:1214
void ComputeDt()
a wrapper for estTimeStep()
void fill_3d_masks(int lev)
Copy maskr to all z levels.
static void writeBuildInfo(std::ostream &os)
Write build info to os.
virtual void ErrorEst(int lev, amrex::TagBoxArray &tags, amrex::Real time, int ngrow) override
Tag cells for refinement.
int plot_int
Plotfile output interval in iterations.
Definition REMORA.H:1298
void FillPatch(int lev, amrex::Real time, amrex::MultiFab &mf_to_be_filled, amrex::Vector< amrex::MultiFab * > const &mfs, const int bccomp, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const bool fill_set=true, const int n_not_fill=0, const int icomp_calc=0, const amrex::Real dt=amrex::Real(0.0), const amrex::MultiFab &mf_calc=amrex::MultiFab())
Fill a new MultiFab by copying in phi from valid region and filling ghost cells.
amrex::Real getCPUTime() const
Get CPU time used.
Definition REMORA.H:1480
void InitData()
Initialize multilevel data.
Definition REMORA.cpp:265
void set3DPlotVariables(const std::string &pp_plot_var_names_3d)
amrex::Vector< int > istep
which step?
Definition REMORA.H:1200
void apply_clim_nudg(const amrex::Box &bx, int ioff, int joff, const amrex::Array4< amrex::Real > &var, const amrex::Array4< amrex::Real const > &var_old, const amrex::Array4< amrex::Real const > &var_clim, const amrex::Array4< amrex::Real const > &clim_coeff, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Real dt_lev=amrex::Real(0.0))
Apply climatology nudging.
void uv3dmix(const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real > &u, const amrex::Array4< amrex::Real > &v, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &rufrc, const amrex::Array4< amrex::Real > &rvfrc, const amrex::Array4< amrex::Real const > &visc2_p, const amrex::Array4< amrex::Real const > &visc2_r, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &mskp, int nrhs, int nnew, const amrex::Real dt_lev)
Harmonic viscosity.
void WriteCheckpointFile()
write checkpoint file to disk
std::string nc_clim_coeff_file
NetCDF climatology coefficient file.
Definition REMORA.H:1389
void lin_eos(const amrex::Box &bx, const amrex::Array4< amrex::Real const > &state, const amrex::Array4< amrex::Real > &rho, const amrex::Array4< amrex::Real > &rhoA, const amrex::Array4< amrex::Real > &rhoS, const amrex::Array4< amrex::Real > &bvf, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &h, const amrex::Array4< amrex::Real const > &mskr, const int N)
Calculate density and related quantities from linear equation of state.
void setRecordDataInfo(int i, const std::string &filename)
Definition REMORA.H:1494
void advance_3d_ml(int lev, amrex::Real dt_lev)
3D advance on a single level
const std::string DataLogName(int i) const noexcept
The filename of the ith datalog file.
Definition REMORA.H:1511
void bulk_fluxes(int lev, amrex::MultiFab *mf_cons, amrex::MultiFab *mf_uwind, amrex::MultiFab *mf_vwind, amrex::MultiFab *mf_Tair, amrex::MultiFab *mf_qair, amrex::MultiFab *mf_Pair, amrex::MultiFab *mf_srflx, amrex::MultiFab *mf_evap, amrex::MultiFab *mf_sustr, amrex::MultiFab *mf_svstr, amrex::MultiFab *mf_stflux, amrex::MultiFab *mf_lrflx, amrex::MultiFab *mf_lhflx, amrex::MultiFab *mf_shflx, const int N)
Calculate bulk temperature, salinity, wind fluxes.
void WriteMultiLevelPlotfileWithBathymetry(const std::string &plotfilename, int nlevels, const amrex::Vector< const amrex::MultiFab * > &mf, const amrex::Vector< const amrex::MultiFab * > &mf_nd, const amrex::Vector< const amrex::MultiFab * > &mf_u, const amrex::Vector< const amrex::MultiFab * > &mf_v, const amrex::Vector< const amrex::MultiFab * > &mf_w, const amrex::Vector< const amrex::MultiFab * > &mf_2d_rho, const amrex::Vector< const amrex::MultiFab * > &mf_2d_u, const amrex::Vector< const amrex::MultiFab * > &mf_2d_v, const amrex::Vector< std::string > &varnames_3d, const amrex::Vector< std::string > &varnames_2d_rho, const amrex::Vector< std::string > &varnames_2d_u, const amrex::Vector< std::string > &varnames_2d_v, const amrex::Vector< amrex::Geometry > &my_geom, amrex::Real time, const amrex::Vector< int > &level_steps, const amrex::Vector< amrex::IntVect > &rr, 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
write out particular data to an AMReX plotfile
void set_analytic_vmix(int lev)
Set vertical mixing coefficients from analytic.
Definition REMORA.cpp:648
void mask_arrays_for_write(int lev, amrex::Real fill_value, amrex::Real fill_where)
Mask data arrays before writing output.
void init_flat_bathymetry(int lev)
Initialize flat bathymetry to value from problo.
Definition REMORA.cpp:688
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rhoS
density perturbation
Definition REMORA.H:429
amrex::Vector< std::string > bdry_time_name_byvar
Name of time fields for boundary data.
Definition REMORA.H:1394
void rhs_uv_2d(int lev, const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real const > &Duon, const amrex::Array4< amrex::Real const > &Dvom, const int nrhs)
RHS terms for 2D momentum.
static int file_min_digits
Minimum number of digits in plotfile name or chunked history file.
Definition REMORA.H:1367
void init_riv_pos_from_netcdf(int lev)
static amrex::Vector< std::string > nc_bdry_file
NetCDF boundary data.
Definition REMORA.H:51
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_visc2_r
Harmonic viscosity defined on the rho points (centers)
Definition REMORA.H:280
std::string nc_riv_file
Definition REMORA.H:1384
void update_mskp(int lev)
Set psi-point mask to be consistent with rho-point mask.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_svstr
Surface stress in the v direction.
Definition REMORA.H:313
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Huon
u-volume flux (3D)
Definition REMORA.H:258
REMORA()
Definition REMORA.cpp:64
void FillBdyCCVels(int lev, amrex::MultiFab &mf_cc_vel)
Fill the physical boundary conditions for cell-centered velocity (diagnostic only)
void set_zeta(int lev)
Initialize zeta from file or analytic.
Definition REMORA.cpp:485
static amrex::Real change_max
Fraction maximum change in subsequent time steps.
Definition REMORA.H:1278
void calc_stretch_coeffs()
calculate vertical stretch coefficients
void init_zeta_from_netcdf(int lev)
Sea-surface height data initialization from NetCDF file.
void set_zeta_average(int lev)
Set Zt_avg1 to zeta.
void init_coriolis_from_netcdf(int lev)
Coriolis parameter data initialization from NetCDF file.
NCTimeSeries * EminusP_data_from_file
Data container for evaporation minus precipitation read from file.
Definition REMORA.H:1115
static void print_usage(MPI_Comm, std::ostream &)
void fill_from_bdyfiles(int lev, amrex::MultiFab &mf_to_fill, const amrex::MultiFab &mf_mask, const amrex::Real time, const int bccomp, const int bdy_var_type, const int icomp_to_fill, const int icomp_calc=0, const amrex::MultiFab &mf_calc=amrex::MultiFab(), const amrex::Real=amrex::Real(0.0))
Fill boundary data from netcdf file.
std::string pp_prefix
default prefix for input file parameters
Definition REMORA.H:229
void set_bathymetry(int lev)
Initialize bathymetry from file or analytic.
Definition REMORA.cpp:513
amrex::Vector< amrex::MultiFab * > yvel_old
multilevel data container for last step's y velocities (v in ROMS)
Definition REMORA.H:236
void init_stuff(int lev, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm)
Allocate MultiFabs for state and evolution variables.
TimeInterpolatedData GetDataAtTime(int lev, amrex::Real time)
utility to copy in data from old and/or new state into another multifab
void Advance(int lev, amrex::Real time, amrex::Real dt_lev, int iteration, int ncycle)
advance a single level for a single time step
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rhoA
vertically-averaged density
Definition REMORA.H:431
NCTimeSeries * srflx_data_from_file
Data container for shortwave radiation flux read from file.
Definition REMORA.H:1109
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_DV_avg1
time average of barotropic y velocity flux
Definition REMORA.H:370
amrex::Vector< REMORAFillPatcher > FPr_c
Vector over levels of FillPatchers for scalars.
Definition REMORA.H:1157
void rhs_t_3d(int lev, const amrex::Box &bx, const amrex::Array4< amrex::Real > &t, const amrex::Array4< amrex::Real const > &tempstore, const amrex::Array4< amrex::Real const > &Huon, const amrex::Array4< amrex::Real const > &Hvom, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &W, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real const > &mskr, const amrex::Array4< amrex::Real const > &msku, const amrex::Array4< amrex::Real const > &mskv, const amrex::Array4< int const > &river_pos, const amrex::Array4< amrex::Real const > &river_source, int nrhs, int nnew, int N, const amrex::Real dt_lev)
RHS terms for tracer.
AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE amrex::Real bulk_psiu(amrex::Real ZoL)
Evaluate stability function psi for wind speed.
Definition REMORA.H:1530
static void print_banner(MPI_Comm, std::ostream &)
std::string clim_v_time_varname
Name of time field for v climatology data.
Definition REMORA.H:1403
void scale_rhs_vars_inv()
Scale RHS momentum variables by cell area, needed after FillPatch to different levels.
amrex::Vector< REMORAFillPatcher > FPr_w
Vector over levels of FillPatchers for w.
Definition REMORA.H:1163
amrex::Vector< amrex::YAFluxRegister * > advflux_reg
array of flux registers for refluxing in multilevel
Definition REMORA.H:1217
std::string clim_salt_time_varname
Name of time field for salinity climatology data.
Definition REMORA.H:1405
amrex::Gpu::DeviceVector< amrex::Real > Cs_r
Stretching coefficients at rho points.
Definition REMORA.H:300
NCTimeSeries * Vwind_data_from_file
Data container for v-direction wind read from file.
Definition REMORA.H:1101
amrex::Vector< amrex::Real > t_new
new time at each level
Definition REMORA.H:1204
NCTimeSeriesRiver * river_source_transport
Data container for momentum transport in rivers.
Definition REMORA.H:1133
void init_stretch_coeffs()
initialize and calculate stretch coefficients
void init_bdry_from_netcdf(int lev)
Boundary data initialization from NetCDF file.
NCTimeSeries * temp_clim_data_from_file
Data container for temperature climatology data read from file.
Definition REMORA.H:1126
static SolverChoice solverChoice
Container for algorithmic choices.
Definition REMORA.H:1329
void resize_stuff(int lev)
Resize variable containers to accommodate data on levels 0 to max_lev.
amrex::Vector< std::unique_ptr< amrex::iMultiFab > > vec_river_position
iMultiFab for river positions; contents are indices of rivers
Definition REMORA.H:1142
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Akk
Turbulent kinetic energy vertical diffusion coefficient.
Definition REMORA.H:452
void set_masks(int lev)
Initialize land-sea masks from file or analytic.
Definition REMORA.cpp:783
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rdrag2
Quadratic drag coefficient [unitless], defined at rho points.
Definition REMORA.H:356
int cf_set_width
Width for fixing values at coarse-fine interface.
Definition REMORA.H:1154
NCTimeSeries * salt_clim_data_from_file
Data container for salinity climatology data read from file.
Definition REMORA.H:1128
void ReadParameters()
read in some parameters from inputs file
Definition REMORA.cpp:1022
static void print_tpls(std::ostream &)
void WriteGenericPlotfileHeaderWithBathymetry(std::ostream &HeaderFile, int nlevels, const amrex::Vector< amrex::BoxArray > &bArray, const amrex::Vector< std::string > &varnames_3d, const amrex::Vector< std::string > &varnames_2d_rho, const amrex::Vector< std::string > &varnames_2d_u, const amrex::Vector< std::string > &varnames_2d_v, const amrex::Vector< amrex::Geometry > &my_geom, amrex::Real time, const amrex::Vector< int > &level_steps, const amrex::Vector< amrex::IntVect > &rr, const std::string &versionName, const std::string &levelPrefix, const std::string &mfPrefix) const
write out header data for an AMReX plotfile
void vert_visc_3d(const amrex::Box &bx, const int ioff, const int joff, const amrex::Array4< amrex::Real > &phi, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real > &Hzk, const amrex::Array4< amrex::Real > &AK, const amrex::Array4< amrex::Real const > &Akv, const amrex::Array4< amrex::Real > &BC, const amrex::Array4< amrex::Real > &DC, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real > &CF, const int nnew, const int N, const amrex::Real dt_lev)
Calculate effects of vertical viscosity or diffusivity.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_ru
u velocity RHS (3D, includes horizontal and vertical advection)
Definition REMORA.H:262
NCTimeSeries * svstr_data_from_file
Data container for v-component surface momentum flux read from file.
Definition REMORA.H:1097
void sum_integrated_quantities(amrex::Real time)
Integrate conserved quantities for diagnostics.
static int total_nc_plot_file_step
Definition REMORA.H:1005
amrex::Vector< amrex::Real > vec_weight1
Weights for calculating avg1 in 2D advance.
Definition REMORA.H:440
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_xp
x_grid on psi-points (2D)
Definition REMORA.H:421
static int plot_staggered_vels
Whether to write the staggered velocities (not averaged to cell centers)
Definition REMORA.H:1370
static amrex::Vector< amrex::Vector< std::string > > nc_grid_file
NetCDF grid file.
Definition REMORA.H:53
amrex::Vector< amrex::Vector< NCTimeSeriesBoundary * > > boundary_series
Vector over BdyVars of boundary series data containers.
Definition REMORA.H:1138
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_zeta
free surface height (2D)
Definition REMORA.H:384
amrex::Gpu::DeviceVector< int > river_direction
Vector over rivers of river direction: 0: u-face; 1: v-face; 2: w-face.
Definition REMORA.H:1144
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_vbar
barotropic y velocity (2D)
Definition REMORA.H:382
void ReadNCMultiFab(amrex::FabArray< amrex::FArrayBox > &fab, const std::string &name, int coordinatorProc=amrex::ParallelDescriptor::IOProcessorNumber(), int allow_empty_mf=0)
Read MultiFab in NetCDF format.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_DU_avg1
time average of barotropic x velocity flux (2D)
Definition REMORA.H:366
amrex::Gpu::DeviceVector< amrex::Real > Cs_w
Stretching coefficients at w points.
Definition REMORA.H:302
void set_zeta_to_Ztavg(int lev)
Set zeta components to be equal to time-averaged Zt_avg1.
bool expand_plotvars_to_unif_rr
whether plotfile variables should be expanded to a uniform refinement ratio
Definition REMORA.H:1332
void advance_2d(int lev, amrex::MultiFab const *mf_rhoS, amrex::MultiFab const *mf_rhoA, amrex::MultiFab *mf_ru2d, amrex::MultiFab *mf_rv2d, amrex::MultiFab *mf_rufrc, amrex::MultiFab *mf_rvfrc, amrex::MultiFab *mf_Zt_avg1, std::unique_ptr< amrex::MultiFab > &mf_DU_avg1, std::unique_ptr< amrex::MultiFab > &mf_DU_avg2, std::unique_ptr< amrex::MultiFab > &mf_DV_avg1, std::unique_ptr< amrex::MultiFab > &mf_DV_avg2, std::unique_ptr< amrex::MultiFab > &mf_rubar, std::unique_ptr< amrex::MultiFab > &mf_rvbar, std::unique_ptr< amrex::MultiFab > &mf_rzeta, std::unique_ptr< amrex::MultiFab > &mf_ubar, std::unique_ptr< amrex::MultiFab > &mf_vbar, amrex::MultiFab *mf_zeta, amrex::MultiFab const *mf_h, amrex::MultiFab const *mf_pm, amrex::MultiFab const *mf_pn, amrex::MultiFab const *mf_fcor, amrex::MultiFab const *mf_visc2_p, amrex::MultiFab const *mf_visc2_r, amrex::MultiFab const *mf_mskr, amrex::MultiFab const *mf_msku, amrex::MultiFab const *mf_mskv, amrex::MultiFab const *mf_mskp, amrex::Real dtfast_lev, bool predictor_2d_step, bool first_2d_step, int my_iif, int &next_indx1)
Perform a 2D predictor (predictor_2d_step=True) or corrector (predictor_2d_step=False) step.
int plot_file_on_restart
Whether to output a plotfile on restart from checkpoint.
Definition REMORA.H:1258
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_alpha
Thermal expansion coefficient (3D)
Definition REMORA.H:435
void set_2darrays(int lev)
Set 2D momentum arrays from 3D momentum.
void FillCoarsePatchMap(int lev, amrex::Real time, amrex::MultiFab *mf_fine, amrex::MultiFab *mf_crse, const int bccomp, const int bdy_var_type=BdyVars::null, const int icomp=0, const bool fill_all=true, const int n_not_fill=0, const int icomp_calc=0, const amrex::Real dt=amrex::Real(0.0), const amrex::MultiFab &mf_calc=amrex::MultiFab(), amrex::Interpolater *mapper=nullptr)
fill an entire multifab by interpolating from the coarser level, explicitly specifying interpolator t...
amrex::Array< amrex::Array< amrex::Real, AMREX_SPACEDIM *2 >, AMREX_SPACEDIM+NCONS+8 > m_bc_extdir_vals
Array holding the Dirichlet values at walls which need them.
Definition REMORA.H:1234
void init_analytic(int lev)
Initialize initial problem data from analytic functions.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_ubar
barotropic x velocity (2D)
Definition REMORA.H:380
void InitializeLevelFromData(int lev, const amrex::MultiFab &initial_data)
Initialize the new-time data at a level from the initial_data MultiFab.
amrex::Vector< amrex::MultiFab * > cons_old
multilevel data container for last step's scalar data: temperature, salinity, passive scalar
Definition REMORA.H:232
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_bustr
Bottom stress in the u direction.
Definition REMORA.H:361
AMREX_FORCE_INLINE int NumDataLogs() noexcept
Definition REMORA.H:1468
amrex::Real volWgtSumMF(int lev, const amrex::MultiFab &mf, int comp, bool local, bool finemask)
Perform the volume-weighted sum.
std::string frc_time_varname
Name of time field for forcing data.
Definition REMORA.H:1411
void set_wind(int lev)
Initialize or calculate wind speed from file or analytic.
Definition REMORA.cpp:717
void init_clim_nudg_coeff_from_netcdf(int lev)
Climatology nudging coefficient initialization from NetCDF file.
amrex::Vector< REMORAFillPatcher > FPr_ubar
Vector over levels of FillPatchers for ubar (2D)
Definition REMORA.H:1167
bool is_it_time_for_action(int nstep, amrex::Real time, amrex::Real dt, int action_interval, amrex::Real action_per)
Decide if it is time to take an action.
std::string PlotFileName(int lev) const
get plotfile name
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_DV_avg2
correct time average of barotropic y velocity flux for coupling (2D)
Definition REMORA.H:372
void set_hmixcoef(int lev)
Initialize horizontal mixing coefficients.
Definition REMORA.cpp:662
amrex::Array< std::string, 2 *AMREX_SPACEDIM > domain_bc_type
Array of strings describing domain boundary conditions.
Definition REMORA.H:1231
amrex::Real estTimeStep(int lev) const
compute dt from CFL considerations
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_yu
y_grid on u-points (2D)
Definition REMORA.H:413
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_bvstr
Bottom stress in the v direction.
Definition REMORA.H:363
std::string nc_clim_his_file
NetCDF climatology history file.
Definition REMORA.H:1387
void timeStep(int lev, amrex::Real time, int iteration)
advance a level by dt, includes a recursive call for finer levels
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rzeta
free surface height for the RHS (2D)
Definition REMORA.H:378
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_z_phys_nd
z coordinates at psi points (cell nodes)
Definition REMORA.H:305
AMREX_FORCE_INLINE amrex::YAFluxRegister * getAdvFluxReg(int lev)
Get flux register.
Definition REMORA.H:1453
void AverageDown()
set covered coarse cells to be the average of overlying fine cells
Definition REMORA.cpp:1261
static int fixed_ndtfast_ratio
User specified, number of barotropic steps per baroclinic step.
Definition REMORA.H:1284
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_xu
x_grid on u-points (2D)
Definition REMORA.H:411
void timeStepML(amrex::Real time, int iteration)
advance all levels by dt, loops over finer levels
amrex::GpuArray< amrex::GpuArray< bool, AMREX_SPACEDIM *2 >, BdyVars::NumTypes+1 > phys_bc_need_data
These are flags that indicate whether we need to read in boundary data from file.
Definition REMORA.H:1240
amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab > > > vec_nudg_coeff
Climatology nudging coefficients.
Definition REMORA.H:457
void set_weights(int lev)
Set weights for averaging 3D variables to 2D.
void prestep_t_advection(int lev, const amrex::Box &tbx, const amrex::Box &gbx, const amrex::Array4< amrex::Real > &tempold, const amrex::Array4< amrex::Real > &tempcache, const amrex::Array4< amrex::Real > &Hz, const amrex::Array4< amrex::Real > &Huon, const amrex::Array4< amrex::Real > &Hvom, const amrex::Array4< amrex::Real > &W, const amrex::Array4< amrex::Real > &DC, const amrex::Array4< amrex::Real > &FC, const amrex::Array4< amrex::Real > &sstore, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &h, const amrex::Array4< amrex::Real const > &pm, const amrex::Array4< amrex::Real const > &pn, const amrex::Array4< amrex::Real const > &msku, const amrex::Array4< amrex::Real const > &mskv, const amrex::Array4< int const > &river_pos, const amrex::Array4< amrex::Real const > &river_source, int iic, int ntfirst, int nrhs, int N, const amrex::Real dt_lev)
Prestep advection calculations for the tracers.
AMREX_FORCE_INLINE std::ostream & DataLog(int i)
Helper function for IO stream.
Definition REMORA.H:1461
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_pn
horizontal scaling factor: 1 / dy (2D)
Definition REMORA.H:400
amrex::Vector< std::unique_ptr< std::fstream > > datalog
Definition REMORA.H:1507
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Akv
Vertical viscosity coefficient (3D)
Definition REMORA.H:274
static amrex::Real cfl
CFL condition.
Definition REMORA.H:1276
void append3DPlotVariables(const std::string &pp_plot_var_names_3d)
virtual void MakeNewLevelFromScratch(int lev, amrex::Real time, const amrex::BoxArray &ba, const amrex::DistributionMapping &dm) override
Make a new level from scratch using provided BoxArray and DistributionMapping. Only used during initi...
amrex::Vector< std::string > plot_var_names_3d
Names of 3D variables to output to AMReX plotfile.
Definition REMORA.H:1319
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_stflux
Surface tracer flux; input arrays.
Definition REMORA.H:338
static int verbose
Verbosity level of output.
Definition REMORA.H:1359
void setup_step(int lev, amrex::Real time, amrex::Real dt_lev)
Set everything up for a step on a level.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rdrag
Linear drag coefficient [m/s], defined at rho points.
Definition REMORA.H:354
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_cloud
cloud cover fraction [0-1], defined at rho-points
Definition REMORA.H:349
void nonlin_eos(const amrex::Box &bx, const amrex::Array4< amrex::Real const > &state, const amrex::Array4< amrex::Real > &rho, const amrex::Array4< amrex::Real > &rhoA, const amrex::Array4< amrex::Real > &rhoS, const amrex::Array4< amrex::Real > &bvf, const amrex::Array4< amrex::Real > &alpha, const amrex::Array4< amrex::Real > &beta, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &z_w, const amrex::Array4< amrex::Real const > &z_r, const amrex::Array4< amrex::Real const > &h, const amrex::Array4< amrex::Real const > &mskr, const int N)
Calculate density and related quantities from nonlinear equation of state.
std::string plot_file_name
Plotfile prefix.
Definition REMORA.H:1296
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Zt_avg1
Average of the free surface, zeta (2D)
Definition REMORA.H:308
int check_int
Checkpoint output interval in iterations.
Definition REMORA.H:1304
void WritePlotFile()
main driver for writing AMReX plotfiles
void set_smflux(int lev)
Initialize or calculate surface momentum flux from file or analytic.
Definition REMORA.cpp:698
std::string restart_chkfile
If set, restart from this checkpoint file.
Definition REMORA.H:1272
void init_clim_nudg_coeff(int lev)
Wrapper to initialize climatology nudging coefficient.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_rv
v velocity RHS (3D, includes horizontal and vertical advection)
Definition REMORA.H:264
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_btflx
Bottom tracer flux; working arrays.
Definition REMORA.H:340
int cf_width
Nudging width at coarse-fine interface.
Definition REMORA.H:1152
AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE amrex::Real bulk_psit(amrex::Real ZoL)
Evaluate stability function psi for moisture and heat.
Definition REMORA.H:1562
static amrex::Vector< amrex::Vector< std::string > > nc_init_file
NetCDF initialization file.
Definition REMORA.H:52
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_beta
Saline contraction coefficient (3D)
Definition REMORA.H:437
int last_plot_file_step
Step when we last output a plotfile.
Definition REMORA.H:1249
amrex::Vector< std::string > plot_var_names_2d
Names of 2D variables to output to AMReX plotfile.
Definition REMORA.H:1321
const amrex::Vector< std::string > derived_names
Names of derived fields for plotfiles.
Definition REMORA.H:1326
amrex::Vector< amrex::Real > t_old
old time at each level
Definition REMORA.H:1206
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_mskr3d
land/sea mask at cell centers, copied to all z levels (3D)
Definition REMORA.H:395
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_srflx
Shortwave radiation flux [W/m²], defined at rho-points.
Definition REMORA.H:326
amrex::Real last_check_file_time
Simulation time when we last output a checkpoint file.
Definition REMORA.H:1256
void append2DPlotVariables(const std::string &pp_plot_var_names_2d)
amrex::Vector< amrex::Real > dt
time step at each level
Definition REMORA.H:1208
static amrex::Real sum_per
Diagnostic sum output interval in time.
Definition REMORA.H:1364
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Pair
Air pressure [mb], defined at rho-points.
Definition REMORA.H:324
void InitializeFromFile()
Read the file passed to remora.restart and use it as an initial condition for the current simulation.
void coriolis(const amrex::Box &xbx, const amrex::Box &ybx, const amrex::Array4< amrex::Real const > &uold, const amrex::Array4< amrex::Real const > &vold, const amrex::Array4< amrex::Real > &ru, const amrex::Array4< amrex::Real > &rv, const amrex::Array4< amrex::Real const > &Hz, const amrex::Array4< amrex::Real const > &fomn, int nrhs, int nr)
Calculate Coriolis terms.
amrex::Gpu::DeviceVector< amrex::BCRec > domain_bcs_type_d
GPU vector (over BCVars) of BCRecs.
Definition REMORA.H:1228
virtual ~REMORA()
Definition REMORA.cpp:141
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_qair
Specific humidity [kg/kg], defined at rho-points.
Definition REMORA.H:322
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_z_w
z coordinates at w points (faces between z-cells)
Definition REMORA.H:288
void restart()
Definition REMORA.cpp:472
NCTimeSeries * Pair_data_from_file
Data container for air pressure read from file.
Definition REMORA.H:1107
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Tair
Air temperature [°C], defined at rho-points.
Definition REMORA.H:320
void convert_inv_days_to_inv_s(amrex::MultiFab *)
Convert data in a multifab from inverse days to inverse seconds.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_yr
y_grid on rho points (2D)
Definition REMORA.H:408
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Hvom
v-volume flux (3D)
Definition REMORA.H:260
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_Akp
Turbulent length scale vertical diffusion coefficient.
Definition REMORA.H:454
void gls_corrector(int lev, amrex::MultiFab *mf_gls, amrex::MultiFab *mf_tke, amrex::MultiFab &mf_W, amrex::MultiFab *mf_Akv, amrex::MultiFab *mf_Akt, amrex::MultiFab *mf_Akk, amrex::MultiFab *mf_Akp, amrex::MultiFab *mf_mskr, amrex::MultiFab *mf_msku, amrex::MultiFab *mf_mskv, const int nstp, const int nnew, const int N, const amrex::Real dt_lev)
Corrector step for GLS calculation.
amrex::Vector< std::unique_ptr< amrex::MultiFab > > vec_diff2
Harmonic diffusivity for temperature / salinity.
Definition REMORA.H:282
@ CellConservativeQuartic
Definition REMORA.H:73
@ CellBilinear
Definition REMORA.H:70
@ PCInterp
Definition REMORA.H:67
@ NodeBilinear
Definition REMORA.H:68
@ CellConservativeLinear
Definition REMORA.H:69
@ CellQuadratic
Definition REMORA.H:71
@ CellConservativeProtected
Definition REMORA.H:72