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