ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_SrcHeaders.H
Go to the documentation of this file.
1 #ifndef ERF_INTEGRATION_H_
2 #define ERF_INTEGRATION_H_
3 
4 #include <AMReX_MultiFab.H>
5 #include <AMReX_EBMultiFabUtil.H>
6 
7 #include "ERF_DataStruct.H"
8 #include "ERF_InputSoundingData.H"
9 #include "ERF_TurbPertStruct.H"
10 #include "ERF_EB.H"
11 #include "ERF_ReadBndryPlanes.H"
12 
13 /**
14  * Function for computing the buoyancy term to be used in the evolution
15  * equation for the z-component of momentum in the slow integrator. There
16  * are three options for how buoyancy is computed (two are the same in the absence of moisture).
17  */
18 void make_buoyancy (int level,
19  const amrex::Vector<amrex::MultiFab>& S_data,
20  const amrex::MultiFab & S_prim,
21  const amrex::MultiFab & qt,
22  amrex::MultiFab& buoyancy,
23  const amrex::Geometry geom,
24  const SolverChoice& solverChoice,
25  const amrex::MultiFab& base_state,
26  const int n_qstate,
27  const eb_& ebfact,
28  const int anelastic);
29 
30 void make_gradp_pert (int level,
31  const SolverChoice& solverChoice,
32  const amrex::Geometry& geom,
33  amrex::Vector<amrex::MultiFab>& S_data,
34  const amrex::MultiFab& p0,
35  const amrex::MultiFab& z_phys_nd,
36  const amrex::MultiFab& z_phys_cc,
37  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
38  const eb_& ebfact,
39  amrex::Vector<amrex::MultiFab>& gradp);
40 
41 void compute_gradp (const amrex::MultiFab& p,
42  const amrex::Geometry& geom,
43  const amrex::MultiFab& z_phys_nd,
44  const amrex::MultiFab& z_phys_cc,
45  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
46  const eb_& ebfact,
47  amrex::Vector<amrex::MultiFab>& gradp,
48  const SolverChoice& solverChoice);
49 
50 void compute_gradp_xy (const amrex::MultiFab& p,
51  const amrex::Geometry& geom,
52  const amrex::MultiFab& z_phys_cc,
53  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
54  const eb_& ebfact,
55  amrex::Vector<amrex::MultiFab>& gradp,
56  const SolverChoice& solverChoice);
57 
58 void compute_gradp_z (const amrex::MultiFab& p,
59  const amrex::Geometry& geom,
60  const amrex::MultiFab& z_phys_nd,
61  const eb_& ebfact,
62  amrex::Vector<amrex::MultiFab>& gradp,
63  const SolverChoice& solverChoice);
64 
65 void compute_gradp_interpz (const amrex::MultiFab& p,
66  const amrex::Geometry& geom,
67  const amrex::MultiFab& z_phys_nd,
68  const amrex::MultiFab& z_phys_cc,
69  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
70  amrex::Vector<amrex::MultiFab>& gradp,
71  const SolverChoice& solverChoice);
72 
73 void make_sources (int level, int nrk,
74  amrex::Real dt, amrex::Real time,
75  const amrex::Vector<amrex::MultiFab>& S_data,
76  const amrex::MultiFab& S_prim,
77  amrex::MultiFab& cc_source,
78  const amrex::MultiFab& base_state,
79  const amrex::MultiFab* z_phys_cc,
80  const amrex::MultiFab& xvel,
81  const amrex::MultiFab& yvel,
82  const amrex::MultiFab* qheating_rates,
83  amrex::MultiFab* terrain_blank,
84  const amrex::Geometry geom,
85  const SolverChoice& solverChoice,
86  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
87  const amrex::MultiFab* rhotheta_src,
88  const amrex::MultiFab* rhoqt_src,
89  const amrex::Real* dptr_wbar_sub,
90  const amrex::Vector<amrex::Real*> d_rayleigh_ptrs_at_lev,
91  const amrex::Real* sinesq_at_lev_d,
92  const amrex::MultiFab* surface_state_at_lev,
93  InputSoundingData& input_sounding_data,
94  TurbulentPerturbation& turbPert,
95  bool is_slow_step);
96 
97 #if defined(ERF_USE_NETCDF)
98 void
99 add_moist_nudging_terms (const amrex::MultiFab& S_data,
100  amrex::MultiFab& source,
101  const int n_qstate,
102  const amrex::Real& dt,
103  const amrex::Real& old_stage_time_total,
104  const amrex::Real& start_bdy_time,
105  const amrex::Real& final_bdy_time,
106  const amrex::Real& bdy_time_interval,
107  const amrex::Real& bdy_factor,
108  const int width,
109  const amrex::Geometry& geom,
110  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xlo,
111  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xhi,
112  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_ylo,
113  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_yhi,
114  std::unique_ptr<ReadBndryPlanes>& m_r2d,
115  const amrex::Real& c_p,
116  const amrex::Real& rdOcp,
117  const int bdy_moist_nudge_type);
118 #endif
119 
120 void make_mom_sources (amrex::Real time,
121  amrex::Real dt,
122  const amrex::Vector<amrex::MultiFab>& S_data,
123  const amrex::MultiFab* z_phys_nd,
124  const amrex::MultiFab* z_phys_cc,
125  amrex::Vector<amrex::Real>& stretched_dz_h,
126  const amrex::MultiFab& xvel,
127  const amrex::MultiFab& yvel,
128  const amrex::MultiFab& zvel,
129  amrex::MultiFab& xmom_source,
130  amrex::MultiFab& ymom_source,
131  amrex::MultiFab& zmom_source,
132  const amrex::MultiFab& base_state,
133  amrex::MultiFab* forest_drag,
134  amrex::MultiFab* terrain_blank,
135  amrex::MultiFab* cosPhi_mf,
136  amrex::MultiFab* sinPhi_mf,
137  const amrex::Geometry geom,
138  const SolverChoice& solverChoice,
139  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
140  const amrex::Real* dptr_rhotheta_src,
141  const amrex::Real* dptr_rhoqt_src,
142  const amrex::Real* dptr_wbar_sub,
143  const amrex::Vector<amrex::Real*> d_rayleigh_ptrs_at_lev,
144  const amrex::Real* sinesq_at_lev_d,
145  const amrex::Real* sinesq_stag_at_lev_d,
146  const amrex::Vector<amrex::Real*> d_sponge_ptrs_at_lev,
147  const amrex::Vector<amrex::MultiFab>* forecast_state_at_lev,
148  const amrex::MultiFab* surface_state_at_lev,
149  InputSoundingData& input_sounding_data,
150  const eb_& ebfact,
151  bool is_slow_step);
152 
153 void add_thin_body_sources (amrex::MultiFab& xmom_source,
154  amrex::MultiFab& ymom_source,
155  amrex::MultiFab& zmom_source,
156  std::unique_ptr<amrex::iMultiFab>& xflux_imask_lev,
157  std::unique_ptr<amrex::iMultiFab>& yflux_imask_lev,
158  std::unique_ptr<amrex::iMultiFab>& zflux_imask_lev,
159  std::unique_ptr<amrex::MultiFab>& thin_xforce_lev,
160  std::unique_ptr<amrex::MultiFab>& thin_yforce_lev,
161  std::unique_ptr<amrex::MultiFab>& thin_zforce_lev);
162 
163 #if defined(ERF_USE_NETCDF)
164 void
165 moist_set_rhs (const amrex::Geometry& geom,
166  const amrex::Box& tbx,
167  const amrex::Array4<amrex::Real const>& new_cons,
168  const amrex::Array4<amrex::Real >& cell_rhs,
169  const int n_qstate,
170  const amrex::Real& time,
171  const amrex::Real& dt,
172  const amrex::Real& start_bdy_time,
173  const amrex::Real& final_bdy_time,
174  const amrex::Real& bdy_time_interval,
175  const amrex::Real& nudge_factor,
176  const int width,
177  const amrex::Box& domain,
178  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xlo,
179  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_xhi,
180  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_ylo,
181  amrex::Vector<amrex::Vector<amrex::FArrayBox>>& bdy_data_yhi,
182  std::unique_ptr<ReadBndryPlanes>& m_r2d);
183 #endif
184 
185 void ApplySpongeZoneBCsForCC (const SpongeChoice& spongeChoice,
186  const amrex::Geometry geom,
187  const amrex::Box& bx,
188  const amrex::Array4<amrex::Real>& cell_rhs,
189  const amrex::Array4<const amrex::Real>& cell_data,
190  const amrex::Array4<const amrex::Real>& r0,
191  const amrex::Array4<const amrex::Real>& th0,
192  const amrex::Array4<const amrex::Real>& qv0,
193  const amrex::Array4<const amrex::Real>& z_phys_cc,
194  int n_qstate);
195 
196 void ApplySpongeZoneBCsForMom (const SpongeChoice& spongeChoice,
197  const amrex::Geometry geom,
198  const amrex::Box& tbx,
199  const amrex::Box& tby,
200  const amrex::Box& tbz,
201  const amrex::Array4<amrex::Real>& rho_u_rhs,
202  const amrex::Array4<amrex::Real>& rho_v_rhs,
203  const amrex::Array4<amrex::Real>& rho_w_rhs,
204  const amrex::Array4<const amrex::Real>& rho_u,
205  const amrex::Array4<const amrex::Real>& rho_v,
206  const amrex::Array4<const amrex::Real>& rho_w,
207  const amrex::Array4<const amrex::Real>& r0,
208  const amrex::Array4<const amrex::Real>& z_phys_nd,
209  const amrex::Array4<const amrex::Real>& z_phys_cc);
210 
211 void ApplySpongeZoneBCsForMom_ReadFromFile (const SpongeChoice& spongeChoice,
212  const amrex::Geometry geom,
213  const amrex::Box& tbx,
214  const amrex::Box& tby,
215  const amrex::Array4<const amrex::Real>& cell_data,
216  const amrex::Array4<const amrex::Real>& z_phys_cc,
217  const amrex::Array4<amrex::Real>& rho_u_rhs,
218  const amrex::Array4<amrex::Real>& rho_v_rhs,
219  const amrex::Array4<const amrex::Real>& rho_u,
220  const amrex::Array4<const amrex::Real>& rho_v,
221  const amrex::Vector<amrex::Real*> d_sponge_ptrs_at_lev);
222 
223 void ApplyBndryForcing_Forecast (const SolverChoice& solverChoice,
224  const amrex::Geometry geom,
225  const amrex::Box& tbx,
226  const amrex::Box& tby,
227  const amrex::Box& tbz,
228  const amrex::Array4<const amrex::Real>& z_phys_nd,
229  const amrex::Array4<amrex::Real>& rho_u_rhs,
230  const amrex::Array4<amrex::Real>& rho_v_rhs,
231  const amrex::Array4<amrex::Real>& rho_w_rhs,
232  const amrex::Array4<const amrex::Real>& rho_u,
233  const amrex::Array4<const amrex::Real>& rho_v,
234  const amrex::Array4<const amrex::Real>& rho_w,
235  const amrex::Array4<const amrex::Real>& rho_u_initial_state,
236  const amrex::Array4<const amrex::Real>& rho_v_initial_state,
237  const amrex::Array4<const amrex::Real>& rho_w_initial_state,
238  const amrex::Array4<const amrex::Real>& cons_initial_state);
239 
240 void
241 ApplySurfaceTreatment_BulkCoeff_Mom (const amrex::Box& tbx,
242  const amrex::Box& tby,
243  const amrex::Array4<amrex::Real>& rho_u_rhs,
244  const amrex::Array4<amrex::Real>& rho_v_rhs,
245  const amrex::Array4<const amrex::Real>& rho_u,
246  const amrex::Array4<const amrex::Real>& rho_v,
247  const amrex::Array4<const amrex::Real>& cons_state,
248  const amrex::Array4<const amrex::Real>& z_phys_nd,
249  const amrex::Array4<const amrex::Real>& surface_state_arr);
250 
251 void
252 ApplySurfaceTreatment_BulkCoeff_CC (const amrex::Box& bx,
253  const amrex::Array4<amrex::Real>& cell_rhs,
254  const amrex::Array4<const amrex::Real>& cons_state,
255  const amrex::Array4<const amrex::Real>& z_phys_cc,
256  const amrex::Array4<const amrex::Real>& surface_state_arr);
257 
258 #endif
ERF_DataStruct.H
ERF_EB.H
rdOcp
const Real rdOcp
Definition: ERF_InitCustomPert_Bomex.H:16
ERF_InputSoundingData.H
ERF_ReadBndryPlanes.H
Real
amrex::Real Real
Definition: ERF_ShocInterface.H:19
make_gradp_pert
void make_gradp_pert(int level, const SolverChoice &solverChoice, const amrex::Geometry &geom, amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab &p0, const amrex::MultiFab &z_phys_nd, const amrex::MultiFab &z_phys_cc, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const eb_ &ebfact, amrex::Vector< amrex::MultiFab > &gradp)
ApplySurfaceTreatment_BulkCoeff_Mom
void ApplySurfaceTreatment_BulkCoeff_Mom(const amrex::Box &tbx, const amrex::Box &tby, const amrex::Array4< amrex::Real > &rho_u_rhs, const amrex::Array4< amrex::Real > &rho_v_rhs, const amrex::Array4< const amrex::Real > &rho_u, const amrex::Array4< const amrex::Real > &rho_v, const amrex::Array4< const amrex::Real > &cons_state, const amrex::Array4< const amrex::Real > &z_phys_nd, const amrex::Array4< const amrex::Real > &surface_state_arr)
make_sources
void make_sources(int level, int nrk, amrex::Real dt, amrex::Real time, const amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab &S_prim, amrex::MultiFab &cc_source, const amrex::MultiFab &base_state, const amrex::MultiFab *z_phys_cc, const amrex::MultiFab &xvel, const amrex::MultiFab &yvel, const amrex::MultiFab *qheating_rates, amrex::MultiFab *terrain_blank, const amrex::Geometry geom, const SolverChoice &solverChoice, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const amrex::MultiFab *rhotheta_src, const amrex::MultiFab *rhoqt_src, const amrex::Real *dptr_wbar_sub, const amrex::Vector< amrex::Real * > d_rayleigh_ptrs_at_lev, const amrex::Real *sinesq_at_lev_d, const amrex::MultiFab *surface_state_at_lev, InputSoundingData &input_sounding_data, TurbulentPerturbation &turbPert, bool is_slow_step)
compute_gradp
void compute_gradp(const amrex::MultiFab &p, const amrex::Geometry &geom, const amrex::MultiFab &z_phys_nd, const amrex::MultiFab &z_phys_cc, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const eb_ &ebfact, amrex::Vector< amrex::MultiFab > &gradp, const SolverChoice &solverChoice)
ApplyBndryForcing_Forecast
void ApplyBndryForcing_Forecast(const SolverChoice &solverChoice, const amrex::Geometry geom, const amrex::Box &tbx, const amrex::Box &tby, const amrex::Box &tbz, const amrex::Array4< const amrex::Real > &z_phys_nd, const amrex::Array4< amrex::Real > &rho_u_rhs, const amrex::Array4< amrex::Real > &rho_v_rhs, const amrex::Array4< amrex::Real > &rho_w_rhs, const amrex::Array4< const amrex::Real > &rho_u, const amrex::Array4< const amrex::Real > &rho_v, const amrex::Array4< const amrex::Real > &rho_w, const amrex::Array4< const amrex::Real > &rho_u_initial_state, const amrex::Array4< const amrex::Real > &rho_v_initial_state, const amrex::Array4< const amrex::Real > &rho_w_initial_state, const amrex::Array4< const amrex::Real > &cons_initial_state)
compute_gradp_z
void compute_gradp_z(const amrex::MultiFab &p, const amrex::Geometry &geom, const amrex::MultiFab &z_phys_nd, const eb_ &ebfact, amrex::Vector< amrex::MultiFab > &gradp, const SolverChoice &solverChoice)
add_thin_body_sources
void add_thin_body_sources(amrex::MultiFab &xmom_source, amrex::MultiFab &ymom_source, amrex::MultiFab &zmom_source, std::unique_ptr< amrex::iMultiFab > &xflux_imask_lev, std::unique_ptr< amrex::iMultiFab > &yflux_imask_lev, std::unique_ptr< amrex::iMultiFab > &zflux_imask_lev, std::unique_ptr< amrex::MultiFab > &thin_xforce_lev, std::unique_ptr< amrex::MultiFab > &thin_yforce_lev, std::unique_ptr< amrex::MultiFab > &thin_zforce_lev)
make_buoyancy
void make_buoyancy(int level, const amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab &S_prim, const amrex::MultiFab &qt, amrex::MultiFab &buoyancy, const amrex::Geometry geom, const SolverChoice &solverChoice, const amrex::MultiFab &base_state, const int n_qstate, const eb_ &ebfact, const int anelastic)
make_mom_sources
void make_mom_sources(amrex::Real time, amrex::Real dt, const amrex::Vector< amrex::MultiFab > &S_data, const amrex::MultiFab *z_phys_nd, const amrex::MultiFab *z_phys_cc, amrex::Vector< amrex::Real > &stretched_dz_h, const amrex::MultiFab &xvel, const amrex::MultiFab &yvel, const amrex::MultiFab &zvel, amrex::MultiFab &xmom_source, amrex::MultiFab &ymom_source, amrex::MultiFab &zmom_source, const amrex::MultiFab &base_state, amrex::MultiFab *forest_drag, amrex::MultiFab *terrain_blank, amrex::MultiFab *cosPhi_mf, amrex::MultiFab *sinPhi_mf, const amrex::Geometry geom, const SolverChoice &solverChoice, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const amrex::Real *dptr_rhotheta_src, const amrex::Real *dptr_rhoqt_src, const amrex::Real *dptr_wbar_sub, const amrex::Vector< amrex::Real * > d_rayleigh_ptrs_at_lev, const amrex::Real *sinesq_at_lev_d, const amrex::Real *sinesq_stag_at_lev_d, const amrex::Vector< amrex::Real * > d_sponge_ptrs_at_lev, const amrex::Vector< amrex::MultiFab > *forecast_state_at_lev, const amrex::MultiFab *surface_state_at_lev, InputSoundingData &input_sounding_data, const eb_ &ebfact, bool is_slow_step)
compute_gradp_interpz
void compute_gradp_interpz(const amrex::MultiFab &p, const amrex::Geometry &geom, const amrex::MultiFab &z_phys_nd, const amrex::MultiFab &z_phys_cc, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, amrex::Vector< amrex::MultiFab > &gradp, const SolverChoice &solverChoice)
ApplySpongeZoneBCsForCC
void ApplySpongeZoneBCsForCC(const SpongeChoice &spongeChoice, const amrex::Geometry geom, const amrex::Box &bx, const amrex::Array4< amrex::Real > &cell_rhs, const amrex::Array4< const amrex::Real > &cell_data, const amrex::Array4< const amrex::Real > &r0, const amrex::Array4< const amrex::Real > &th0, const amrex::Array4< const amrex::Real > &qv0, const amrex::Array4< const amrex::Real > &z_phys_cc, int n_qstate)
compute_gradp_xy
void compute_gradp_xy(const amrex::MultiFab &p, const amrex::Geometry &geom, const amrex::MultiFab &z_phys_cc, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const eb_ &ebfact, amrex::Vector< amrex::MultiFab > &gradp, const SolverChoice &solverChoice)
ApplySpongeZoneBCsForMom_ReadFromFile
void ApplySpongeZoneBCsForMom_ReadFromFile(const SpongeChoice &spongeChoice, const amrex::Geometry geom, const amrex::Box &tbx, const amrex::Box &tby, const amrex::Array4< const amrex::Real > &cell_data, const amrex::Array4< const amrex::Real > &z_phys_cc, const amrex::Array4< amrex::Real > &rho_u_rhs, const amrex::Array4< amrex::Real > &rho_v_rhs, const amrex::Array4< const amrex::Real > &rho_u, const amrex::Array4< const amrex::Real > &rho_v, const amrex::Vector< amrex::Real * > d_sponge_ptrs_at_lev)
ApplySurfaceTreatment_BulkCoeff_CC
void ApplySurfaceTreatment_BulkCoeff_CC(const amrex::Box &bx, const amrex::Array4< amrex::Real > &cell_rhs, const amrex::Array4< const amrex::Real > &cons_state, const amrex::Array4< const amrex::Real > &z_phys_cc, const amrex::Array4< const amrex::Real > &surface_state_arr)
ApplySpongeZoneBCsForMom
void ApplySpongeZoneBCsForMom(const SpongeChoice &spongeChoice, const amrex::Geometry geom, const amrex::Box &tbx, const amrex::Box &tby, const amrex::Box &tbz, const amrex::Array4< amrex::Real > &rho_u_rhs, const amrex::Array4< amrex::Real > &rho_v_rhs, const amrex::Array4< amrex::Real > &rho_w_rhs, const amrex::Array4< const amrex::Real > &rho_u, const amrex::Array4< const amrex::Real > &rho_v, const amrex::Array4< const amrex::Real > &rho_w, const amrex::Array4< const amrex::Real > &r0, const amrex::Array4< const amrex::Real > &z_phys_nd, const amrex::Array4< const amrex::Real > &z_phys_cc)
ERF_TurbPertStruct.H
eb_
Definition: ERF_EB.H:13
MicVar_Kess::qt
@ qt
Definition: ERF_Kessler.H:28
Vars::xvel
@ xvel
Definition: ERF_IndexDefines.H:175
Vars::zvel
@ zvel
Definition: ERF_IndexDefines.H:177
Vars::yvel
@ yvel
Definition: ERF_IndexDefines.H:176
WSM6Ind::p
@ p
Definition: ERF_WSM6.H:176
module_model_constants::p0
real(c_double), parameter p0
Definition: ERF_module_model_constants.F90:40
mp_wsm6::r0
real(kind=kind_phys), parameter, private r0
Definition: ERF_module_mp_wsm6.F90:21
InputSoundingData
Definition: ERF_InputSoundingData.H:22
SolverChoice
Definition: ERF_DataStruct.H:141
SpongeChoice
Definition: ERF_SpongeStruct.H:19
TurbulentPerturbation
Definition: ERF_TurbPertStruct.H:22