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