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_PlaneAverage.H"
17 #include "ERF_TerrainMetrics.H"
18 #include "ERF_TileNoZ.H"
19 #include "ERF_EB.H"
20 
21 void erf_make_tau_terms (int level, int nrk,
22  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
23  const amrex::MultiFab& z_phys_nd,
24  amrex::Vector<amrex::MultiFab>& S_data,
25  const amrex::MultiFab& xvel,
26  const amrex::MultiFab& yvel,
27  const amrex::MultiFab& zvel,
28  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
29  amrex::MultiFab* SmnSmn,
30  amrex::MultiFab* eddyDiffs,
31  const amrex::Geometry geom,
32  const SolverChoice& solverChoice,
33  std::unique_ptr<SurfaceLayer>& SurfLayer,
34  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
35  const amrex::MultiFab& detJ,
36  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac);
37 
38 /**
39  * Function for computing the slow RHS for the evolution equations for the density, potential temperature and momentum.
40  *
41  */
42 void erf_slow_rhs_pre (int level, int finest_level, int nrk,
43  amrex::Real dt,
44  amrex::Vector<amrex::MultiFab>& S_rhs,
45  amrex::Vector<amrex::MultiFab>& S_old,
46  amrex::Vector<amrex::MultiFab>& S_data,
47  const amrex::MultiFab & S_prim,
48  const amrex::MultiFab & qt,
49  amrex::MultiFab& avg_xmom,
50  amrex::MultiFab& avg_ymom,
51  amrex::MultiFab& avg_zmom,
52  const amrex::MultiFab& xvel,
53  const amrex::MultiFab& yvel,
54  const amrex::MultiFab& zvel,
55  std::unique_ptr<amrex::MultiFab>& z_t,
56  const amrex::MultiFab& cc_src,
57  const amrex::MultiFab& xmom_src,
58  const amrex::MultiFab& ymom_src,
59  const amrex::MultiFab& zmom_src,
60  const amrex::MultiFab& buoyancy,
61  const amrex::MultiFab* zmom_crse_rhs,
62  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
63  amrex::MultiFab* SmnSmn,
64  amrex::MultiFab* eddyDiffs,
65  amrex::MultiFab* Hfx1,
66  amrex::MultiFab* Hfx2,
67  amrex::MultiFab* Hfx3,
68  amrex::MultiFab* Q1fx1,
69  amrex::MultiFab* Q1fx2,
70  amrex::MultiFab* Q1fx3,
71  amrex::MultiFab* Q2fx3,
72  amrex::MultiFab* Diss,
73  const amrex::Geometry geom,
74  const SolverChoice& solverChoice,
75  std::unique_ptr<SurfaceLayer>& SurfLayer,
76  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
77  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
78  const amrex::MultiFab& z_phys_nd,
79  const amrex::MultiFab& z_phys_cc,
80  const amrex::MultiFab& ax,
81  const amrex::MultiFab& ay,
82  const amrex::MultiFab& az,
83  const amrex::MultiFab& dJ,
84  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
85  amrex::Vector<amrex::MultiFab>& gradp,
86  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
87  const eb_& ebfact,
88  amrex::YAFluxRegister* fr_as_crse,
89  amrex::YAFluxRegister* fr_as_fine);
90 
91 /**
92  * Function for computing the slow RHS for the evolution equations for the scalars other than density or potential temperature
93  *
94  */
95 void erf_slow_rhs_post (int level, int finest_level, int nrk,
96  amrex::Real dt,
97  int n_qstate,
98  amrex::Vector<amrex::MultiFab>& S_rhs,
99  amrex::Vector<amrex::MultiFab>& S_old,
100  amrex::Vector<amrex::MultiFab>& S_new,
101  amrex::Vector<amrex::MultiFab>& S_data,
102  const amrex::MultiFab& S_prim,
103  amrex::MultiFab& avg_xmom,
104  amrex::MultiFab& avg_ymom,
105  amrex::MultiFab& avg_zmom,
106  const amrex::MultiFab& xvel,
107  const amrex::MultiFab& yvel,
108  const amrex::MultiFab& zvel,
109  const amrex::MultiFab& source,
110  const amrex::MultiFab* SmnSmn,
111  const amrex::MultiFab* eddyDiffs,
112  amrex::MultiFab* Hfx1,
113  amrex::MultiFab* Hfx2,
114  amrex::MultiFab* Hfx3,
115  amrex::MultiFab* Q1fx1,
116  amrex::MultiFab* Q1fx2,
117  amrex::MultiFab* Q1fx3,
118  amrex::MultiFab* Q2fx3,
119  amrex::MultiFab* Diss,
120  const amrex::Geometry geom,
121  const SolverChoice& solverChoice,
122  std::unique_ptr<SurfaceLayer>& SurfLayer,
123  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
124  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
125  std::unique_ptr<amrex::MultiFab>& z_phys_nd,
126  std::unique_ptr<amrex::MultiFab>& z_phys_cc,
127  std::unique_ptr<amrex::MultiFab>& ax,
128  std::unique_ptr<amrex::MultiFab>& ay,
129  std::unique_ptr<amrex::MultiFab>& az,
130  std::unique_ptr<amrex::MultiFab>& dJ_old,
131  amrex::MultiFab* dJ_new,
132  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
133  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
134  amrex::EBFArrayBoxFactory const& ebfact,
135 #if defined(ERF_USE_NETCDF)
136  const bool& moist_zero,
137  const amrex::Real& bdy_time_interval,
138  const amrex::Real& new_stage_time,
139  const amrex::Real& stop_time,
140  int width,
141  int set_width,
142  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xlo,
143  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xhi,
144  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_ylo,
145  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_yhi,
146 #endif
147  amrex::YAFluxRegister* fr_as_crse,
148  amrex::YAFluxRegister* fr_as_fine);
149 
150 #endif
ERF_Advection.H
ERF_DataStruct.H
ERF_Diffusion.H
ERF_EB.H
ERF_EddyViscosity.H
ERF_IndexDefines.H
ERF_PlaneAverage.H
Real
amrex::Real Real
Definition: ERF_ShocInterface.H:19
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::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)
erf_slow_rhs_post
void erf_slow_rhs_post(int level, int finest_level, int nrk, amrex::Real 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, 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, amrex::YAFluxRegister *fr_as_crse, amrex::YAFluxRegister *fr_as_fine)
erf_slow_rhs_pre
void erf_slow_rhs_pre(int level, int finest_level, int nrk, amrex::Real 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::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, 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, amrex::YAFluxRegister *fr_as_crse, amrex::YAFluxRegister *fr_as_fine)
ERF_TerrainMetrics.H
ERF_TileNoZ.H
eb_
Definition: ERF_EB.H:13
MicVar_Kess::qt
@ qt
Definition: ERF_Kessler.H:27
Vars::xvel
@ xvel
Definition: ERF_IndexDefines.H:141
Vars::zvel
@ zvel
Definition: ERF_IndexDefines.H:143
Vars::yvel
@ yvel
Definition: ERF_IndexDefines.H:142
SolverChoice
Definition: ERF_DataStruct.H:123