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 class CloudChamberBudget;
23 
24 class ShocDriver;
25 
26 void erf_make_tau_terms (int level, int nrk,
27  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
28  const amrex::MultiFab& z_phys_nd,
29  amrex::Vector<amrex::MultiFab>& S_data,
30  const amrex::MultiFab& xvel,
31  const amrex::MultiFab& yvel,
32  const amrex::MultiFab& zvel,
33  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
34  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_corr_lev,
35  amrex::MultiFab* SmnSmn,
36  amrex::MultiFab* eddyDiffs,
37  const amrex::Geometry geom,
38  const SolverChoice& solverChoice,
39  std::unique_ptr<SurfaceLayer>& SurfLayer,
40  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
41  const amrex::MultiFab& detJ,
42  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
43  const amrex::MultiFab& ax,
44  const amrex::MultiFab& ay,
45  const amrex::MultiFab& az,
46  const eb_& ebfact);
47 
48 void copy_surface_tau_for_implicit (amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
49  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_corr_lev);
50 
51 /**
52  * Function for computing the slow RHS for the evolution equations for the density, potential temperature and momentum.
53  *
54  */
55 void erf_slow_rhs_pre (int level, int finest_level, int nrk,
56  double dt,
57  amrex::Vector<amrex::MultiFab>& S_rhs,
58  amrex::Vector<amrex::MultiFab>& S_old,
59  amrex::Vector<amrex::MultiFab>& S_data,
60  const amrex::MultiFab & S_prim,
61  const amrex::MultiFab & qt,
62  amrex::MultiFab& avg_xmom,
63  amrex::MultiFab& avg_ymom,
64  amrex::MultiFab& avg_zmom,
65  const amrex::MultiFab& xvel,
66  const amrex::MultiFab& yvel,
67  const amrex::MultiFab& zvel,
68  std::unique_ptr<amrex::MultiFab>& z_t,
69  const amrex::MultiFab& cc_src,
70  const amrex::MultiFab& xmom_src,
71  const amrex::MultiFab& ymom_src,
72  const amrex::MultiFab& zmom_src,
73  const amrex::MultiFab& buoyancy,
74  const amrex::MultiFab* zmom_crse_rhs,
75  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
76  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_corr_lev,
77  amrex::Vector<amrex::Vector<std::unique_ptr<amrex::MultiFab>>>& Tau_EB,
78  amrex::MultiFab* SmnSmn,
79  amrex::MultiFab* eddyDiffs,
80  amrex::MultiFab* Hfx1,
81  amrex::MultiFab* Hfx2,
82  amrex::MultiFab* Hfx3,
83  amrex::MultiFab* Q1fx1,
84  amrex::MultiFab* Q1fx2,
85  amrex::MultiFab* Q1fx3,
86  amrex::MultiFab* Q2fx3,
87  amrex::MultiFab* Diss,
88  amrex::MultiFab* Hfx3_EB,
89  const amrex::Geometry geom,
90  const SolverChoice& solverChoice,
91  std::unique_ptr<SurfaceLayer>& SurfLayer,
92  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
93  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
94  const amrex::MultiFab& z_phys_nd,
95  const amrex::MultiFab& z_phys_cc,
96  const amrex::MultiFab& ax,
97  const amrex::MultiFab& ay,
98  const amrex::MultiFab& az,
99  const amrex::MultiFab& dJ,
100  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
101  amrex::Vector<amrex::MultiFab>& gradp,
102  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
103  const eb_& ebfact,
104 #ifdef ERF_USE_EAMXX_SHOC
105  SHOCInterface* eamxx_shoc_lev,
106 #endif
107  ShocDriver* native_shoc_lev,
108  amrex::YAFluxRegister* fr_as_crse,
109  amrex::YAFluxRegister* fr_as_fine,
110  const amrex::MultiFab* cloud_chamber_base_state,
111  const erf_cloud_chamber::Config* cloud_chamber_config,
112  CloudChamberBudget* cloud_budget);
113 
114 /**
115  * Function for computing the slow RHS for the evolution equations for the scalars other than density or potential temperature
116  *
117  */
118 void erf_slow_rhs_post (int level, int finest_level, int nrk,
119  double dt,
120  int n_qstate,
121  amrex::Vector<amrex::MultiFab>& S_rhs,
122  amrex::Vector<amrex::MultiFab>& S_old,
123  amrex::Vector<amrex::MultiFab>& S_new,
124  amrex::Vector<amrex::MultiFab>& S_data,
125  const amrex::MultiFab& S_prim,
126  amrex::MultiFab& avg_xmom,
127  amrex::MultiFab& avg_ymom,
128  amrex::MultiFab& avg_zmom,
129  const amrex::MultiFab& xvel,
130  const amrex::MultiFab& yvel,
131  const amrex::MultiFab& zvel,
132  const amrex::MultiFab& source,
133  amrex::MultiFab* terrain_blank,
134  const amrex::MultiFab* SmnSmn,
135  const amrex::MultiFab* eddyDiffs,
136  amrex::MultiFab* Hfx1,
137  amrex::MultiFab* Hfx2,
138  amrex::MultiFab* Hfx3,
139  amrex::MultiFab* Q1fx1,
140  amrex::MultiFab* Q1fx2,
141  amrex::MultiFab* Q1fx3,
142  amrex::MultiFab* Q2fx3,
143  amrex::MultiFab* Diss,
144  const amrex::Geometry geom,
145  const SolverChoice& solverChoice,
146  std::unique_ptr<SurfaceLayer>& SurfLayer,
147  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
148  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
149  std::unique_ptr<amrex::MultiFab>& z_phys_nd,
150  std::unique_ptr<amrex::MultiFab>& z_phys_cc,
151  std::unique_ptr<amrex::MultiFab>& ax,
152  std::unique_ptr<amrex::MultiFab>& ay,
153  std::unique_ptr<amrex::MultiFab>& az,
154  std::unique_ptr<amrex::MultiFab>& dJ_old,
155  amrex::MultiFab* dJ_new,
156  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
157  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
158  amrex::EBFArrayBoxFactory const& ebfact,
159 #ifdef ERF_USE_EAMXX_SHOC
160  SHOCInterface* eamxx_shoc_lev,
161 #endif
162  ShocDriver* native_shoc_lev,
163  amrex::YAFluxRegister* fr_as_crse,
164  amrex::YAFluxRegister* fr_as_fine,
165  std::unique_ptr<ReadBndryPlanes>& m_r2d,
166  const amrex::MultiFab* cloud_chamber_base_state,
167  const erf_cloud_chamber::Config* cloud_chamber_config,
168  CloudChamberBudget* cloud_budget);
169 
170 #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)
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_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, 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, amrex::EBFArrayBoxFactory const &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)
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:36
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:177
Vars::zvel
@ zvel
Definition: ERF_IndexDefines.H:179
Vars::yvel
@ yvel
Definition: ERF_IndexDefines.H:178
SolverChoice
Definition: ERF_DataStruct.H:241
erf_cloud_chamber::Config
Definition: ERF_CloudChamber.H:35