ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_TI_slow_rhs_post.H
Go to the documentation of this file.
1 #include "ERF_SrcHeaders.H"
2 
3  auto slow_rhs_fun_post = [&,bogus_large_value_d=bogus_large_value](Vector<MultiFab>& S_rhs,
4  Vector<MultiFab>& S_old,
5  Vector<MultiFab>& S_new,
6  Vector<MultiFab>& S_data,
7  const double old_step_time,
8  const double old_stage_time,
9  const double new_stage_time,
10  const int nrk)
11  {
12  // Note that the "old" and "new" metric terms correspond to
13  // t^n and the RK stage (either t^*, t^** or t^{n+1} that this source
14  // will be used to advance to
15  double slow_dt = new_stage_time - old_step_time;
16 
17  if (verbose) amrex::Print() << "Time integration of scalars at level " << level
18  << std::setprecision(timeprecision)
19  << " from " << old_step_time << " to " << new_stage_time
20  << " with dt = " << slow_dt
21  << " using RHS created at " << old_stage_time << std::endl;
22 
23  const GpuArray<Real, AMREX_SPACEDIM> dxInv = fine_geom.InvCellSizeArray();
24 
25  // *************************************************************************
26  // Set up flux registers if using two_way coupling
27  // *************************************************************************
28  YAFluxRegister* fr_as_crse = nullptr;
29  YAFluxRegister* fr_as_fine = nullptr;
30  if (solverChoice.coupling_type == CouplingType::TwoWay && finest_level > 0)
31  {
32  if (level < finest_level) {
33  fr_as_crse = getAdvFluxReg(level+1);
34  }
35  if (level > 0) {
36  fr_as_fine = getAdvFluxReg(level);
37  }
38  }
39 
40  MultiFab* new_detJ =
41  (solverChoice.terrain_type == TerrainType::MovingFittedMesh) ? (detJ_cc_new[level].get()) : (detJ_cc[level].get());
42 
43  // Immersed Forcing
44  MultiFab* terrain_blank = (solverChoice.terrain_type == TerrainType::ImmersedForcing ||
45  solverChoice.buildings_type == BuildingsType::ImmersedForcing) ?
46  terrain_blanking[level].get() : nullptr;
47  MultiFab* terrain_blank_xface = (solverChoice.terrain_type == TerrainType::ImmersedForcing ||
48  solverChoice.buildings_type == BuildingsType::ImmersedForcing) ?
49  terrain_blanking_xface[level].get() : nullptr;
50  MultiFab* terrain_blank_yface = (solverChoice.terrain_type == TerrainType::ImmersedForcing ||
51  solverChoice.buildings_type == BuildingsType::ImmersedForcing) ?
52  terrain_blanking_yface[level].get() : nullptr;
53  MultiFab* terrain_blank_zface = (solverChoice.terrain_type == TerrainType::ImmersedForcing ||
54  solverChoice.buildings_type == BuildingsType::ImmersedForcing) ?
55  terrain_blanking_zface[level].get() : nullptr;
56 
57  erf_slow_rhs_post(level, finest_level, nrk,
58  old_step_time, old_stage_time, new_stage_time, slow_dt,
59  micro->Get_Qstate_Moist_Size(),
60  S_rhs, S_old, S_new, S_data, S_prim, avg_xmom[level], avg_ymom[level], avg_zmom[level],
61  xvel_new, yvel_new, zvel_new, cc_src, terrain_blank,
62  terrain_blank_xface, terrain_blank_yface, terrain_blank_zface,
63  SmnSmn, eddyDiffs,
64  Hfx1, Hfx2, Hfx3, Q1fx1, Q1fx2, Q1fx3, Q2fx3, Diss,
65  Tau[level][TauType::tau13].get(), Tau[level][TauType::tau23].get(),
66  fine_geom, solverChoice, m_SurfaceLayer, domain_bcs_type_d, domain_bcs_type,
67  z_phys_nd[level], z_phys_cc[level], ax[level], ay[level], az[level],
68  detJ_cc[level], new_detJ, stretched_dz_d[level], mapfac[level], get_eb(level),
69 #ifdef ERF_USE_EAMXX_SHOC
70  eamxx_shoc_interface[level].get(),
71 #endif
72  native_shoc_driver[level].get(),
73  fr_as_crse, fr_as_fine,
74  m_r2d, &base_state[level],
75  cloud_chamber_config.active ? &cloud_chamber_config : nullptr,
76  cloud_chamber_budget.get(), auxiliary_inert_tracer.get(),
77  sbm_state_manager.get(), sbm_transport.get());
78 
79  // Implicit diffusion of moisture
80  #include "ERF_ImplicitPost.H"
81 
82  // Apply state redistribution for cons states
83 
84  if (solverChoice.terrain_type == TerrainType::EB)
85  {
86  Vector<int> is_valid_slow_var; is_valid_slow_var.resize(RhoQ1_comp+1,0);
87  if (solverChoice.turbChoice[level].use_tke) {is_valid_slow_var[ RhoKE_comp] = 1;}
88  is_valid_slow_var[RhoScalar_comp] = 1;
89  if (solverChoice.moisture_type != MoistureType::None) {
90  is_valid_slow_var[RhoQ1_comp] = 1;
91  }
92  const int num_comp_total = S_rhs[IntVars::cons].nComp();
93  const int num_grow = S_rhs[IntVars::cons].nGrow();
94  const int nvars = S_data[IntVars::cons].nComp();
95 
96  MultiFab dUdt_tmp(ba, dm, num_comp_total, num_grow, MFInfo(), EBFactory(level));
97  dUdt_tmp.setVal(0, 0, num_comp_total, num_grow);
98 
99  int start_comp;
100  int num_comp;
101 
102  for (int ivar(RhoKE_comp); ivar<= RhoQ1_comp; ++ivar)
103  {
104  if (is_valid_slow_var[ivar])
105  {
106  start_comp = ivar;
107  num_comp = 1;
108  if (ivar == RhoQ1_comp) {
109  num_comp = nvars - RhoQ1_comp;
110  } else if (ivar == RhoScalar_comp) {
111  num_comp = NSCALARS;
112  }
113  MultiFab::Copy(dUdt_tmp, S_rhs[IntVars::cons], start_comp, start_comp, num_comp, 0);
114  }
115  }
116  dUdt_tmp.FillBoundary(fine_geom.periodicity());
117  dUdt_tmp.setDomainBndry(bogus_large_value_d, 0, num_comp_total, fine_geom);
118 
119  const BCRec* bc_ptr_d = domain_bcs_type_d.data();
120 
121  // Update S_rhs by Redistribution.
122  // To-do: Currently, redistributing all the scalar variables.
123  // This needs to be redistributed only for num_comp variables starting from ivar, for efficiency.
124  redistribute_term ( num_comp_total, fine_geom, S_rhs[IntVars::cons], dUdt_tmp,
125  S_old[IntVars::cons], EBFactory(level), bc_ptr_d, slow_dt);
126 
127  // Update state using the updated S_rhs. (NOTE: redistribute_term returns RHS not state variables.)
128  for ( MFIter mfi(S_new[IntVars::cons],TilingIfNotGPU()); mfi.isValid(); ++mfi)
129  {
130  Box tbx = mfi.tilebox();
131  const Array4<Real>& snew = S_new[IntVars::cons].array(mfi);
132  const Array4<Real>& sold = S_old[IntVars::cons].array(mfi);
133  const Array4<Real>& srhs = S_rhs[IntVars::cons].array(mfi);
134  Array4<const Real> detJ_arr = EBFactory(level).getVolFrac().const_array(mfi);
135 
136  for (int ivar(RhoKE_comp); ivar<= RhoQ1_comp; ++ivar)
137  {
138  if (is_valid_slow_var[ivar])
139  {
140  start_comp = ivar;
141  num_comp = 1;
142  if (ivar == RhoQ1_comp) {
143  num_comp = nvars - RhoQ1_comp;
144  } else if (ivar == RhoScalar_comp) {
145  num_comp = NSCALARS;
146  }
147  Real sdt = static_cast<Real>(slow_dt);
148  ParallelFor(tbx, num_comp, [=] AMREX_GPU_DEVICE (int i, int j, int k, int nn)
149  {
150  if (detJ_arr(i,j,k) > zero) {
151  const int n = start_comp + nn;
152  snew(i,j,k,n) = sold(i,j,k,n) + sdt * srhs(i,j,k,n);
153  }
154  });
155  }
156  }
157  }
158  } // EB
159 
160  // Limit KE and Q now that the explicit update, implicit diffusion and
161  // redistribution have all been applied
162  #include "ERF_ScalarLimitPost.H"
163 
164  // Apply boundary conditions on all the state variables that have been updated
165  // in both the fast and slow integrators
166  apply_bcs(S_new, new_stage_time, S_new[IntVars::cons].nGrow(), S_new[IntVars::xmom].nGrow(),
167  fast_only=false, vel_and_mom_synced=false);
168 
169  if (solverChoice.moisture_tight_coupling) {
170  // TODO: need iteration var for lagrangian microphysics
171  // call signature in ERF::Advance() is
172  //advance_microphysics(lev, S_new, dt_lev, iteration, time);
173  advance_microphysics(level, S_new[0], slow_dt, 123456789, old_step_time);
174  }
175  }; // end slow_rhs_fun_post
constexpr amrex::Real bogus_large_value
Definition: ERF_Constants.H:19
@ tau23
Definition: ERF_DataStruct.H:48
@ tau13
Definition: ERF_DataStruct.H:48
@ nvars
Definition: ERF_DataStruct.H:194
void redistribute_term(int ncomp, const Geometry &geom, MultiFab &result, MultiFab &result_tmp, MultiFab const &state, EBFactType const &ebfact, BCRec const *bc, double local_dt_d, int const igrid)
Apply EB state redistribution to result_tmp and write the redistributed result.
Definition: ERF_EBRedistribute.cpp:21
#define RhoScalar_comp
Definition: ERF_IndexDefines.H:46
#define NSCALARS
Definition: ERF_IndexDefines.H:16
#define RhoQ1_comp
Definition: ERF_IndexDefines.H:48
#define RhoKE_comp
Definition: ERF_IndexDefines.H:44
amrex::GpuArray< Real, AMREX_SPACEDIM > dxInv
Definition: ERF_InitCustomPertVels_ParticleTests.H:17
pp get("wavelength", wavelength)
ParallelFor(fab_box, [=] AMREX_GPU_DEVICE(int i, int j, int k) { qrcuten_arr(i, j, k)=Real(0);qscuten_arr(i, j, k)=Real(0);qicuten_arr(i, j, k)=Real(0);})
constexpr amrex::Real zero
Definition: ERF_NumericalConstants.H:36
amrex::Real Real
Definition: ERF_ShocInterface.H:19
void erf_slow_rhs_post(int level, int finest_level, int nrk, double step_old_time, double input_time, double target_time, double dt_d, int n_qstate, Vector< MultiFab > &S_rhs, Vector< MultiFab > &S_old, Vector< MultiFab > &S_new, Vector< MultiFab > &S_data, const MultiFab &S_prim, MultiFab &avg_xmom, MultiFab &avg_ymom, MultiFab &avg_zmom, const MultiFab &xvel, const MultiFab &yvel, const MultiFab &zvel, const MultiFab &source, MultiFab *terrain_blank, MultiFab *terrain_blank_xface, MultiFab *terrain_blank_yface, MultiFab *terrain_blank_zface, const MultiFab *SmnSmn, const MultiFab *eddyDiffs, MultiFab *Hfx1, MultiFab *Hfx2, MultiFab *Hfx3, MultiFab *Q1fx1, MultiFab *Q1fx2, MultiFab *Q1fx3, MultiFab *Q2fx3, MultiFab *Diss, MultiFab *Tau13, MultiFab *Tau23, const Geometry geom, const SolverChoice &solverChoice, const Vector< std::unique_ptr< SurfaceLayer >> &SurfLayer, const Gpu::DeviceVector< BCRec > &domain_bcs_type_d, const Vector< BCRec > &domain_bcs_type_h, std::unique_ptr< MultiFab > &z_phys_nd, std::unique_ptr< MultiFab > &z_phys_cc, std::unique_ptr< MultiFab > &ax, std::unique_ptr< MultiFab > &ay, std::unique_ptr< MultiFab > &az, std::unique_ptr< MultiFab > &detJ, MultiFab *detJ_new, Gpu::DeviceVector< Real > &stretched_dz_d, Vector< std::unique_ptr< MultiFab >> &mapfac, const eb_ &ebfact, ShocDriver *native_shoc_lev, YAFluxRegister *fr_as_crse, YAFluxRegister *fr_as_fine, std::unique_ptr< ReadBndryPlanes > &m_r2d, const MultiFab *cloud_chamber_base_state, const erf_cloud_chamber::Config *cloud_chamber_config, CloudChamberBudget *cloud_budget, erf_auxiliary::AuxiliaryInertTracer *auxiliary_inert_tracer, erf_sbm::SBMStateManager *sbm_state_manager, erf_sbm::SBMTransport *sbm_transport)
Definition: ERF_SlowRhsPost.cpp:59
auto slow_rhs_fun_post
Definition: ERF_TI_slow_rhs_post.H:3
auto apply_bcs
Definition: ERF_TI_utils.H:34
@ cons
Definition: ERF_IndexDefines.H:235
@ xmom
Definition: ERF_IndexDefines.H:236
@ None
Definition: ERF_LSM_Types.H:6
@ nn
Definition: ERF_WDM6.H:32