ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_TI_slow_headers.H
Go to the documentation of this file.
1 #ifndef ERF_SLOW_INTEGRATION_H_
2 #define ERF_SLOW_INTEGRATION_H_
3 
4 #include "AMReX_MultiFab.H"
5 #include "AMReX_BCRec.H"
6 #include "AMReX_YAFluxRegister.H"
7 #include "AMReX_MultiCutFab.H"
8 #include "AMReX_EBMultiFabUtil.H"
9 
10 #include "ERF_DataStruct.H"
11 #include "ERF_IndexDefines.H"
12 #include "ERF_SurfaceLayer.H"
13 #include "ERF_Advection.H"
14 #include "ERF_Diffusion.H"
15 #include "ERF_EddyViscosity.H"
16 #include "ERF_TerrainMetrics.H"
17 #include "ERF_TileNoZ.H"
18 #include "ERF_EB.H"
19 #include "ERF_ReadBndryPlanes.H"
20 #include "Prob/ERF_CloudChamber.H"
21 
22 /**
23  * @brief Budget tracking for the cloud chamber simulation.
24  */
25 class CloudChamberBudget;
26 
27 /**
28  * @brief Driver for the SHOC physics model.
29  */
30 class ShocDriver;
31 
32 void erf_make_tau_terms (int level, int nrk,
33  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
34  const amrex::MultiFab& z_phys_nd,
35  amrex::Vector<amrex::MultiFab>& S_data,
36  const amrex::MultiFab& xvel,
37  const amrex::MultiFab& yvel,
38  const amrex::MultiFab& zvel,
39  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
40  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_corr_lev,
41  amrex::MultiFab* SmnSmn,
42  amrex::MultiFab* eddyDiffs,
43  const amrex::Geometry geom,
44  const SolverChoice& solverChoice,
45  std::unique_ptr<SurfaceLayer>& SurfLayer,
46  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
47  const amrex::MultiFab& detJ,
48  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
49  const amrex::MultiFab& ax,
50  const amrex::MultiFab& ay,
51  const amrex::MultiFab& az,
52  const eb_& ebfact);
53 
54 void copy_surface_tau_for_implicit (amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
55  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_corr_lev);
56 
57 /**
58  * Function for computing the slow RHS for the evolution equations for the density, potential temperature and momentum.
59  *
60  */
61 void erf_slow_rhs_pre (int level, int finest_level, int nrk,
62  double dt,
63  amrex::Vector<amrex::MultiFab>& S_rhs,
64  amrex::Vector<amrex::MultiFab>& S_old,
65  amrex::Vector<amrex::MultiFab>& S_data,
66  const amrex::MultiFab & S_prim,
67  const amrex::MultiFab & qt,
68  amrex::MultiFab& avg_xmom,
69  amrex::MultiFab& avg_ymom,
70  amrex::MultiFab& avg_zmom,
71  const amrex::MultiFab& xvel,
72  const amrex::MultiFab& yvel,
73  const amrex::MultiFab& zvel,
74  std::unique_ptr<amrex::MultiFab>& z_t,
75  const amrex::MultiFab& cc_src,
76  const amrex::MultiFab& xmom_src,
77  const amrex::MultiFab& ymom_src,
78  const amrex::MultiFab& zmom_src,
79  const amrex::MultiFab& buoyancy,
80  const amrex::MultiFab* zmom_crse_rhs,
81  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
82  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_corr_lev,
83  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>>& Tau_EB,
84  amrex::MultiFab* SmnSmn,
85  amrex::MultiFab* eddyDiffs,
86  amrex::MultiFab* Hfx1,
87  amrex::MultiFab* Hfx2,
88  amrex::MultiFab* Hfx3,
89  amrex::MultiFab* Q1fx1,
90  amrex::MultiFab* Q1fx2,
91  amrex::MultiFab* Q1fx3,
92  amrex::MultiFab* Q2fx3,
93  amrex::MultiFab* Diss,
94  amrex::MultiFab* Hfx3_EB,
95  const amrex::Geometry geom,
96  const SolverChoice& solverChoice,
97  std::unique_ptr<SurfaceLayer>& SurfLayer,
98  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
99  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
100  const amrex::MultiFab& z_phys_nd,
101  const amrex::MultiFab& z_phys_cc,
102  const amrex::MultiFab& ax,
103  const amrex::MultiFab& ay,
104  const amrex::MultiFab& az,
105  const amrex::MultiFab& dJ,
106  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
107  amrex::Vector<amrex::MultiFab>& gradp,
108  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
109  const eb_& ebfact,
110 #ifdef ERF_USE_EAMXX_SHOC
111  SHOCInterface* eamxx_shoc_lev,
112 #endif
113  ShocDriver* native_shoc_lev,
114  amrex::YAFluxRegister* fr_as_crse,
115  amrex::YAFluxRegister* fr_as_fine,
116  const amrex::MultiFab* cloud_chamber_base_state,
117  const erf_cloud_chamber::Config* cloud_chamber_config,
118  CloudChamberBudget* cloud_budget);
119 
120 /**
121  * Function for computing the slow RHS for the evolution equations for the scalars other than density or potential temperature
122  *
123  */
124 void erf_slow_rhs_post (int level, int finest_level, int nrk,
125  double dt,
126  int n_qstate,
127  amrex::Vector<amrex::MultiFab>& S_rhs,
128  amrex::Vector<amrex::MultiFab>& S_old,
129  amrex::Vector<amrex::MultiFab>& S_new,
130  amrex::Vector<amrex::MultiFab>& S_data,
131  const amrex::MultiFab& S_prim,
132  amrex::MultiFab& avg_xmom,
133  amrex::MultiFab& avg_ymom,
134  amrex::MultiFab& avg_zmom,
135  const amrex::MultiFab& xvel,
136  const amrex::MultiFab& yvel,
137  const amrex::MultiFab& zvel,
138  const amrex::MultiFab& source,
139  amrex::MultiFab* terrain_blank,
140  amrex::MultiFab* terrain_blank_xface,
141  amrex::MultiFab* terrain_blank_yface,
142  amrex::MultiFab* terrain_blank_zface,
143  const amrex::MultiFab* SmnSmn,
144  const amrex::MultiFab* eddyDiffs,
145  amrex::MultiFab* Hfx1,
146  amrex::MultiFab* Hfx2,
147  amrex::MultiFab* Hfx3,
148  amrex::MultiFab* Q1fx1,
149  amrex::MultiFab* Q1fx2,
150  amrex::MultiFab* Q1fx3,
151  amrex::MultiFab* Q2fx3,
152  amrex::MultiFab* Diss,
153  const amrex::Geometry geom,
154  const SolverChoice& solverChoice,
155  std::unique_ptr<SurfaceLayer>& SurfLayer,
156  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
157  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
158  std::unique_ptr<amrex::MultiFab>& z_phys_nd,
159  std::unique_ptr<amrex::MultiFab>& z_phys_cc,
160  std::unique_ptr<amrex::MultiFab>& ax,
161  std::unique_ptr<amrex::MultiFab>& ay,
162  std::unique_ptr<amrex::MultiFab>& az,
163  std::unique_ptr<amrex::MultiFab>& dJ_old,
164  amrex::MultiFab* dJ_new,
165  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
166  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
167  const eb_& ebfact,
168 #ifdef ERF_USE_EAMXX_SHOC
169  SHOCInterface* eamxx_shoc_lev,
170 #endif
171  ShocDriver* native_shoc_lev,
172  amrex::YAFluxRegister* fr_as_crse,
173  amrex::YAFluxRegister* fr_as_fine,
174  std::unique_ptr<ReadBndryPlanes>& m_r2d,
175  const amrex::MultiFab* cloud_chamber_base_state,
176  const erf_cloud_chamber::Config* cloud_chamber_config,
177  CloudChamberBudget* cloud_budget);
178 
179 #endif
ERF_Advection.H
ERF_CloudChamber.H
ERF_DataStruct.H
ERF_Diffusion.H
ERF_EB.H
Declares the embedded-boundary factory manager used by ERF levels.
ERF_EddyViscosity.H
ERF_IndexDefines.H
ERF_ReadBndryPlanes.H
ERF_SurfaceLayer.H
erf_make_tau_terms
void erf_make_tau_terms(int level, int nrk, const amrex::Vector< amrex::BCRec > &domain_bcs_type, const amrex::MultiFab &z_phys_nd, amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab &xvel, const amrex::MultiFab &yvel, const amrex::MultiFab &zvel, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_corr_lev, amrex::MultiFab *SmnSmn, amrex::MultiFab *eddyDiffs, const amrex::Geometry geom, const SolverChoice &solverChoice, std::unique_ptr< SurfaceLayer > &SurfLayer, amrex::Gpu::DeviceVector< amrex::Real > &stretched_dz_d, const amrex::MultiFab &detJ, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const amrex::MultiFab &ax, const amrex::MultiFab &ay, const amrex::MultiFab &az, const eb_ &ebfact)
erf_slow_rhs_post
void erf_slow_rhs_post(int level, int finest_level, int nrk, double dt, int n_qstate, amrex::Vector< amrex::MultiFab > &S_rhs, amrex::Vector< amrex::MultiFab > &S_old, amrex::Vector< amrex::MultiFab > &S_new, amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab &S_prim, amrex::MultiFab &avg_xmom, amrex::MultiFab &avg_ymom, amrex::MultiFab &avg_zmom, const amrex::MultiFab &xvel, const amrex::MultiFab &yvel, const amrex::MultiFab &zvel, const amrex::MultiFab &source, amrex::MultiFab *terrain_blank, amrex::MultiFab *terrain_blank_xface, amrex::MultiFab *terrain_blank_yface, amrex::MultiFab *terrain_blank_zface, const amrex::MultiFab *SmnSmn, const amrex::MultiFab *eddyDiffs, amrex::MultiFab *Hfx1, amrex::MultiFab *Hfx2, amrex::MultiFab *Hfx3, amrex::MultiFab *Q1fx1, amrex::MultiFab *Q1fx2, amrex::MultiFab *Q1fx3, amrex::MultiFab *Q2fx3, amrex::MultiFab *Diss, const amrex::Geometry geom, const SolverChoice &solverChoice, std::unique_ptr< SurfaceLayer > &SurfLayer, const amrex::Gpu::DeviceVector< amrex::BCRec > &domain_bcs_type_d, const amrex::Vector< amrex::BCRec > &domain_bcs_type, std::unique_ptr< amrex::MultiFab > &z_phys_nd, std::unique_ptr< amrex::MultiFab > &z_phys_cc, std::unique_ptr< amrex::MultiFab > &ax, std::unique_ptr< amrex::MultiFab > &ay, std::unique_ptr< amrex::MultiFab > &az, std::unique_ptr< amrex::MultiFab > &dJ_old, amrex::MultiFab *dJ_new, amrex::Gpu::DeviceVector< amrex::Real > &stretched_dz_d, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const eb_ &ebfact, ShocDriver *native_shoc_lev, amrex::YAFluxRegister *fr_as_crse, amrex::YAFluxRegister *fr_as_fine, std::unique_ptr< ReadBndryPlanes > &m_r2d, const amrex::MultiFab *cloud_chamber_base_state, const erf_cloud_chamber::Config *cloud_chamber_config, CloudChamberBudget *cloud_budget)
copy_surface_tau_for_implicit
void copy_surface_tau_for_implicit(amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_corr_lev)
erf_slow_rhs_pre
void erf_slow_rhs_pre(int level, int finest_level, int nrk, double dt, amrex::Vector< amrex::MultiFab > &S_rhs, amrex::Vector< amrex::MultiFab > &S_old, amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab &S_prim, const amrex::MultiFab &qt, amrex::MultiFab &avg_xmom, amrex::MultiFab &avg_ymom, amrex::MultiFab &avg_zmom, const amrex::MultiFab &xvel, const amrex::MultiFab &yvel, const amrex::MultiFab &zvel, std::unique_ptr< amrex::MultiFab > &z_t, const amrex::MultiFab &cc_src, const amrex::MultiFab &xmom_src, const amrex::MultiFab &ymom_src, const amrex::MultiFab &zmom_src, const amrex::MultiFab &buoyancy, const amrex::MultiFab *zmom_crse_rhs, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_corr_lev, amrex::Vector< amrex::Vector< std::unique_ptr< amrex::MultiFab >>> &Tau_EB, amrex::MultiFab *SmnSmn, amrex::MultiFab *eddyDiffs, amrex::MultiFab *Hfx1, amrex::MultiFab *Hfx2, amrex::MultiFab *Hfx3, amrex::MultiFab *Q1fx1, amrex::MultiFab *Q1fx2, amrex::MultiFab *Q1fx3, amrex::MultiFab *Q2fx3, amrex::MultiFab *Diss, amrex::MultiFab *Hfx3_EB, const amrex::Geometry geom, const SolverChoice &solverChoice, std::unique_ptr< SurfaceLayer > &SurfLayer, const amrex::Gpu::DeviceVector< amrex::BCRec > &domain_bcs_type_d, const amrex::Vector< amrex::BCRec > &domain_bcs_type, const amrex::MultiFab &z_phys_nd, const amrex::MultiFab &z_phys_cc, const amrex::MultiFab &ax, const amrex::MultiFab &ay, const amrex::MultiFab &az, const amrex::MultiFab &dJ, amrex::Gpu::DeviceVector< amrex::Real > &stretched_dz_d, amrex::Vector< amrex::MultiFab > &gradp, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const eb_ &ebfact, ShocDriver *native_shoc_lev, amrex::YAFluxRegister *fr_as_crse, amrex::YAFluxRegister *fr_as_fine, const amrex::MultiFab *cloud_chamber_base_state, const erf_cloud_chamber::Config *cloud_chamber_config, CloudChamberBudget *cloud_budget)
ERF_TerrainMetrics.H
ERF_TileNoZ.H
CloudChamberBudget
Definition: ERF_CloudChamberBudget.H:28
SHOCInterface
Definition: ERF_ShocInterface.H:50
ShocDriver
Definition: ERF_ShocDriver.H:61
eb_
Owns and exposes cell-centered and face-centered EB factories.
Definition: ERF_EB.H:24
MicVar_Kess::qt
@ qt
Definition: ERF_Kessler.H:29
Vars::xvel
@ xvel
Definition: ERF_IndexDefines.H:215
Vars::zvel
@ zvel
Definition: ERF_IndexDefines.H:217
Vars::yvel
@ yvel
Definition: ERF_IndexDefines.H:216
SolverChoice
Definition: ERF_DataStruct.H:634
erf_cloud_chamber::Config
Configuration parameters for cloud chamber initialization.
Definition: ERF_CloudChamber.H:41