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