ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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  const amrex::MultiFab& detJ,
35  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac);
36 
37 /**
38  * Function for computing the slow RHS for the evolution equations for the density, potential temperature and momentum.
39  *
40  */
41 void erf_slow_rhs_pre (int level, int finest_level, int nrk,
42  amrex::Real dt,
43  amrex::Vector<amrex::MultiFab>& S_rhs,
44  amrex::Vector<amrex::MultiFab>& S_old,
45  amrex::Vector<amrex::MultiFab>& S_data,
46  const amrex::MultiFab & S_prim,
47  amrex::Vector<amrex::MultiFab>& S_scratch,
48  const amrex::MultiFab& xvel,
49  const amrex::MultiFab& yvel,
50  const amrex::MultiFab& zvel,
51  std::unique_ptr<amrex::MultiFab>& z_t,
52  const amrex::MultiFab& cc_src,
53  const amrex::MultiFab& xmom_src,
54  const amrex::MultiFab& ymom_src,
55  const amrex::MultiFab& zmom_src,
56  const amrex::MultiFab& buoyancy,
57  const amrex::MultiFab* zmom_crse_rhs,
58  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
59  amrex::MultiFab* SmnSmn,
60  amrex::MultiFab* eddyDiffs,
61  amrex::MultiFab* Hfx1,
62  amrex::MultiFab* Hfx2,
63  amrex::MultiFab* Hfx3,
64  amrex::MultiFab* Q1fx1,
65  amrex::MultiFab* Q1fx2,
66  amrex::MultiFab* Q1fx3,
67  amrex::MultiFab* Q2fx3,
68  amrex::MultiFab* Diss,
69  const amrex::Geometry geom,
70  const SolverChoice& solverChoice,
71  std::unique_ptr<SurfaceLayer>& SurfLayer,
72  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
73  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
74  const amrex::MultiFab& z_phys_nd,
75  const amrex::MultiFab& ax,
76  const amrex::MultiFab& ay,
77  const amrex::MultiFab& az,
78  const amrex::MultiFab& dJ,
79  amrex::Gpu::DeviceVector<amrex::Real>& stretched_dz_d,
80  amrex::Vector<amrex::MultiFab>& gradp,
81  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
82  const eb_& ebfact,
83  amrex::YAFluxRegister* fr_as_crse,
84  amrex::YAFluxRegister* fr_as_fine);
85 
86 /**
87  * Function for computing the slow RHS for the evolution equations for the scalars other than density or potential temperature
88  *
89  */
90 void erf_slow_rhs_post (int level, int finest_level, int nrk,
91  amrex::Real dt,
92  int n_qstate,
93  amrex::Vector<amrex::MultiFab>& S_rhs,
94  amrex::Vector<amrex::MultiFab>& S_old,
95  amrex::Vector<amrex::MultiFab>& S_new,
96  amrex::Vector<amrex::MultiFab>& S_data,
97  const amrex::MultiFab& S_prim,
98  amrex::Vector<amrex::MultiFab >& S_scratch,
99  const amrex::MultiFab& xvel,
100  const amrex::MultiFab& yvel,
101  const amrex::MultiFab& zvel,
102  const amrex::MultiFab& source,
103  const amrex::MultiFab* SmnSmn,
104  const amrex::MultiFab* eddyDiffs,
105  amrex::MultiFab* Hfx1,
106  amrex::MultiFab* Hfx2,
107  amrex::MultiFab* Hfx3,
108  amrex::MultiFab* Q1fx1,
109  amrex::MultiFab* Q1fx2,
110  amrex::MultiFab* Q1fx3,
111  amrex::MultiFab* Q2fx3,
112  amrex::MultiFab* Diss,
113  const amrex::Geometry geom,
114  const SolverChoice& solverChoice,
115  std::unique_ptr<SurfaceLayer>& SurfLayer,
116  const amrex::Gpu::DeviceVector<amrex::BCRec>& domain_bcs_type_d,
117  const amrex::Vector<amrex::BCRec>& domain_bcs_type,
118  std::unique_ptr<amrex::MultiFab>& z_phys_nd,
119  std::unique_ptr<amrex::MultiFab>& ax,
120  std::unique_ptr<amrex::MultiFab>& ay,
121  std::unique_ptr<amrex::MultiFab>& az,
122  std::unique_ptr<amrex::MultiFab>& dJ_old,
123  amrex::MultiFab* dJ_new,
124  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
125  amrex::EBFArrayBoxFactory const& ebfact,
126 #if defined(ERF_USE_NETCDF)
127  const bool& moist_zero,
128  const amrex::Real& bdy_time_interval,
129  const amrex::Real& start_bdy_time,
130  const amrex::Real& new_stage_time,
131  int width,
132  int set_width,
133  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xlo,
134  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xhi,
135  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_ylo,
136  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_yhi,
137 #endif
138  amrex::YAFluxRegister* fr_as_crse,
139  amrex::YAFluxRegister* fr_as_fine);
140 
141 #endif
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::Vector< amrex::MultiFab > &S_scratch, 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 > &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::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, amrex::EBFArrayBoxFactory const &ebfact, amrex::YAFluxRegister *fr_as_crse, amrex::YAFluxRegister *fr_as_fine)
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, amrex::Vector< amrex::MultiFab > &S_scratch, 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 &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 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, const amrex::MultiFab &detJ, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac)
Definition: ERF_EB.H:13
@ xvel
Definition: ERF_IndexDefines.H:141
@ zvel
Definition: ERF_IndexDefines.H:143
@ yvel
Definition: ERF_IndexDefines.H:142
Definition: ERF_DataStruct.H:95