ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_ShocInterface.H
Go to the documentation of this file.
1 #ifndef ERF_SHOCINTERFACE_H
2 #define ERF_SHOCINTERFACE_H
3 
4 /*
5  * SHOC model interface to ERF -- we use this interface to link to the SHOC code
6  * as cloned from the E3SM git repository: https://github.com/E3SM-Project/E3SM/components/eamxx/src/physics/shoc
7  */
8 
9 #include "physics/shoc/shoc_constants.hpp"
10 #include "physics/shoc/shoc_functions.hpp"
11 #include "share/util/eamxx_common_physics_functions.hpp"
12 
13 #include "ekat_subview_utils.hpp"
14 #include "ekat_parameter_list.hpp"
15 #include "ekat_assert.hpp"
16 #include "ekat_team_policy_utils.hpp"
17 #include "ekat_reduction_utils.hpp"
18 
20 using Int=int;
21 
22 #include <string>
23 
24 #include <Kokkos_Core.hpp>
25 #include <AMReX_ParmParse.H>
26 #include <AMReX_MultiFabUtil.H>
27 #include <ERF_DataStruct.H>
28 #include <ERF_Kokkos.H>
29 #include <ERF_IndexDefines.H>
30 #include <ERF_EOS.H>
31 
32 //#include "share/atm_process/atmosphere_process.hpp"
33 //#include "share/atm_process/ATMBufferManager.hpp"
34 
36 {
37  using SHF = scream::shoc::Functions<Real, KokkosDefaultDevice>;
38  using PF = scream::PhysicsFunctions<KokkosDefaultDevice>;
39  using C = scream::physics::Constants<Real>;
40  using KT = ekat::KokkosTypes<KokkosDefaultDevice>;
41  using SC = scream::shoc::Constants<Real>;
42 
43  using Spack = typename SHF::Spack;
44  using IntSmallPack = typename SHF::IntSmallPack;
45  using Smask = typename SHF::Smask;
46  using view_1d_int = typename KT::template view_1d<Int>;
47  using view_1d = typename SHF::view_1d<Real>;
48  using view_1d_const = typename SHF::view_1d<const Real>;
49  using view_2d = typename SHF::view_2d<SHF::Spack>;
50  using view_2d_const = typename SHF::view_2d<const Spack>;
51  using sview_2d = typename ekat::KokkosTypes<KokkosDefaultDevice>::template view_2d<Real>;
52  using sview_2d_const = typename ekat::KokkosTypes<KokkosDefaultDevice>::template view_2d<const Real>;
53  using view_3d = typename SHF::view_3d<Spack>;
54  using view_3d_const = typename SHF::view_3d<const Spack>;
55  using view_3d_strided = typename SHF::view_3d_strided<Spack>;
56 
57  using WSM = ekat::WorkspaceManager<Spack, KT::Device>;
58 
59  template<typename ScalarT>
60  using uview_1d = ekat::Unmanaged<typename KT::template view_1d<ScalarT>>;
61  template<typename ScalarT>
62  using uview_2d = ekat::Unmanaged<typename KT::template view_2d<ScalarT>>;
63 
64 public:
65 
66  // Constructor
67  SHOCInterface (const int& lev,
68  SolverChoice& sc);
69 
70  // Set the grid
71  void
72  set_grids (int& level,
73  const amrex::BoxArray& ba,
74  amrex::Geometry& geom,
75  amrex::MultiFab* cons,
76  amrex::MultiFab* z_phys);
77 
78  // Initialize the implementation
79  void
80  initialize_impl ();
81 
82  // Run the implementation
83  void
84  run_impl (const Real dt);
85 
86  // Finalize the implementation
87  void
88  finalize_impl ();
89 
90  // Allocate buffer space
91  void
92  alloc_buffers ();
93 
94  // De-allocate buffer space
95  void
96  dealloc_buffers ();
97 
98  // Fill KOKKOS Views from AMReX MultiFabs
99  void
101 
102  // Fill AMReX MultiFabs from KOKKOS Views
103  void
105 
106  // The name of the subcomponent
107  std::string name () const { return "shoc"; }
108 
109 #ifndef KOKKOS_ENABLE_CUDA
110  // Cuda requires methods enclosing __device__ lambda's to be public
111 protected:
112 #endif
113 
114  /*--------------------------------------------------------------------------------------------*/
115  // Most individual processes have a pre-processing step that constructs needed variables from
116  // the set of fields stored in the field manager. A structure like this defines those operations,
117  // which can then be called during run_impl in the main .cpp code.
118  // Structure to handle the local generation of data needed by shoc_main in run_impl
119  struct SHOCPreprocess {
120  SHOCPreprocess () = default;
121 
122  KOKKOS_INLINE_FUNCTION
123  void operator()(const Kokkos::TeamPolicy<KT::ExeSpace>::member_type& team) const
124  {
125  const int i = team.league_rank();
126 
127  const Real zvir = C::ZVIR;
128  const Real cpair = C::Cpair;
129  const Real ggr = C::gravit;
130  const Real inv_ggr = 1/ggr;
131  const Real mintke = SC::mintke;
132 
133  const int nlev_packs = ekat::npack<Spack>(nlev);
134 
135  Kokkos::parallel_for(Kokkos::TeamVectorRange(team, nlev_packs), [&] (const Int& k)
136  {
137  cldfrac_liq_prev(i,k)=cldfrac_liq(i,k);
138 
139  // Inverse of Exner. In non-rel builds, assert that exner != 0 when in range before computing.
140  const Spack exner = PF::exner_function(p_mid(i,k));
141  const Smask nonzero = (exner != 0);
142  EKAT_KERNEL_ASSERT((nonzero || !(ekat::range<IntSmallPack>(k*Spack::n) < nlev)).all());
143  inv_exner(i,k).set(nonzero, 1/exner);
144 
145  tke(i,k) = ekat::max(mintke, tke(i,k));
146 
147  // Tracers are updated as a group. The tracers tke and qc act as separate inputs to shoc_main()
148  // and are therefore updated differently to the tracers group's monolithic field. Here, we make
149  // a copy if each of these tracers and pass to shoc_main() so that changes to the tracer group
150  // does not alter tke or qc values. Then during post processing, we copy back correct values of
151  // tke and qc to tracer group in postprocessing.
152  // TODO: remove *_copy views once SHOC can request a subset of tracers.
153  tke_copy(i,k) = tke(i,k);
154  qc_copy(i,k) = qc(i,k);
155 
156  qw(i,k) = qv(i,k) + qc(i,k);
157 
158  // Temperature
159  // NOTE: theta_v (thv) is intentionally different from one in HOMME
160  const auto theta_zt = PF::calculate_theta_from_T(T_mid(i,k),p_mid(i,k));
161  thlm(i,k) = PF::calculate_thetal_from_theta(theta_zt,T_mid(i,k),qc(i,k));
162  thv(i,k) = theta_zt*(1 + zvir*qv(i,k) - qc(i,k));
163 
164  // Vertical layer thickness
165  dz(i,k) = PF::calculate_dz(pseudo_density(i,k), p_mid(i,k), T_mid(i,k), qv(i,k));
166 
167  rrho(i,k) = inv_ggr*(pseudo_density(i,k)/dz(i,k));
168  wm_zt(i,k) = -1*omega(i,k)/(rrho(i,k)*ggr);
169  });
170  team.team_barrier();
171 
172  // Compute vertical layer heights
173  const auto dz_s = ekat::subview(dz, i);
174  const auto z_int_s = ekat::subview(z_int, i);
175  const auto z_mid_s = ekat::subview(z_mid, i);
176  PF::calculate_z_int(team,nlev,dz_s,z_surf,z_int_s);
177  team.team_barrier();
178  PF::calculate_z_mid(team,nlev,z_int_s,z_mid_s);
179  team.team_barrier();
180 
181  const int nlevi_v = nlev/Spack::n;
182  const int nlevi_p = nlev%Spack::n;
183  Kokkos::parallel_for(Kokkos::TeamVectorRange(team, nlev_packs), [&] (const Int& k)
184  {
185  zt_grid(i,k) = z_mid(i,k) - z_int(i, nlevi_v)[nlevi_p];
186  zi_grid(i,k) = z_int(i,k) - z_int(i, nlevi_v)[nlevi_p];
187 
188  // Dry static energy
189  shoc_s(i,k) = PF::calculate_dse(T_mid(i,k),z_mid(i,k),phis(i));
190 
191  if (k+1 == nlev_packs) zi_grid(i,nlevi_v)[nlevi_p] = 0;
192  });
193  team.team_barrier();
194 
195  const auto zt_grid_s = ekat::subview(zt_grid, i);
196  const auto zi_grid_s = ekat::subview(zi_grid, i);
197  const auto rrho_s = ekat::subview(rrho, i);
198  const auto rrho_i_s = ekat::subview(rrho_i, i);
199  SHF::linear_interp(team,zt_grid_s,zi_grid_s,rrho_s,rrho_i_s,nlev,nlev+1,0);
200  team.team_barrier();
201 
202  const auto exner_int = PF::exner_function(p_int(i,nlevi_v)[nlevi_p]);
203  const auto inv_exner_int_surf = 1/exner_int;
204 
205  wpthlp_sfc(i) = (surf_sens_flux(i)/(cpair*rrho_i(i,nlevi_v)[nlevi_p]))*inv_exner_int_surf;
206  wprtp_sfc(i) = surf_evap(i)/rrho_i(i,nlevi_v)[nlevi_p];
207  upwp_sfc(i) = surf_mom_flux(i,0)/rrho_i(i,nlevi_v)[nlevi_p];
208  vpwp_sfc(i) = surf_mom_flux(i,1)/rrho_i(i,nlevi_v)[nlevi_p];
209  } // operator
210 
211  // Local variables
212  int ncol, nlev;
250 
251  // Assigning local variables
252  void set_variables(const int ncol_, const int nlev_,
253  const Real z_surf_,
254  const view_2d_const& T_mid_, const view_2d_const& p_mid_, const view_2d_const& p_int_, const view_2d_const& pseudo_density_,
255  const view_2d_const& omega_,
256  const view_1d_const& phis_, const view_1d_const& surf_sens_flux_, const view_1d_const& surf_evap_,
257  const sview_2d_const& surf_mom_flux_,
258  const view_3d_strided& qtracers_,
259  const view_2d& qv_, const view_2d_const& qc_, const view_2d& qc_copy_,
260  const view_2d& tke_, const view_2d& tke_copy_,
261  const view_2d& z_mid_, const view_2d& z_int_,
262  const view_2d& dse_, const view_2d& rrho_, const view_2d& rrho_i_,
263  const view_2d& thv_, const view_2d& dz_,const view_2d& zt_grid_,const view_2d& zi_grid_, const view_1d& wpthlp_sfc_,
264  const view_1d& wprtp_sfc_,const view_1d& upwp_sfc_,const view_1d& vpwp_sfc_, const view_2d& wtracer_sfc_,
265  const view_2d& wm_zt_,const view_2d& inv_exner_,const view_2d& thlm_,const view_2d& qw_,
266  const view_2d& cldfrac_liq_, const view_2d& cldfrac_liq_prev_)
267  {
268  ncol = ncol_;
269  nlev = nlev_;
270  z_surf = z_surf_;
271  // IN
272  T_mid = T_mid_;
273  p_mid = p_mid_;
274  p_int = p_int_;
275  pseudo_density = pseudo_density_;
276  omega = omega_;
277  phis = phis_;
278  surf_sens_flux = surf_sens_flux_;
279  surf_evap = surf_evap_;
280  surf_mom_flux = surf_mom_flux_;
281  qv = qv_;
282  // OUT
283  qtracers = qtracers_;
284  qc = qc_;
285  qc_copy = qc_copy_;
286  shoc_s = dse_;
287  tke = tke_;
288  tke_copy = tke_copy_;
289  z_mid = z_mid_;
290  z_int = z_int_;
291  rrho = rrho_;
292  rrho_i = rrho_i_;
293  thv = thv_;
294  dz = dz_;
295  zt_grid = zt_grid_;
296  zi_grid = zi_grid_;
297  wpthlp_sfc = wpthlp_sfc_;
298  wprtp_sfc = wprtp_sfc_;
299  upwp_sfc = upwp_sfc_;
300  vpwp_sfc = vpwp_sfc_;
301  wtracer_sfc = wtracer_sfc_;
302  wm_zt = wm_zt_;
303  inv_exner = inv_exner_;
304  thlm = thlm_;
305  qw = qw_;
306  cldfrac_liq=cldfrac_liq_;
307  cldfrac_liq_prev=cldfrac_liq_prev_;
308  } // set_variables
309  }; // SHOCPreprocess
310  /* --------------------------------------------------------------------------------------------*/
311 
312  /*--------------------------------------------------------------------------------------------*/
313  // Structure to handle the generation of data needed by the rest of the model based on output from
314  // shoc_main.
316  SHOCPostprocess () = default;
317 
318  KOKKOS_INLINE_FUNCTION
319  void operator()(const Kokkos::TeamPolicy<KT::ExeSpace>::member_type& team) const
320  {
321  const int i = team.league_rank();
322 
323  const Real inv_qc_relvar_max = 10;
324  const Real inv_qc_relvar_min = 0.001;
325 
326  const int nlev_packs = ekat::npack<Spack>(nlev);
327  Kokkos::parallel_for(Kokkos::TeamVectorRange(team, nlev_packs), [&] (const Int& k)
328  {
329  // See comment in SHOCPreprocess::operator() about the necessity of *_copy views
330  tke(i,k) = tke_copy(i,k);
331  qc(i,k) = qc_copy(i,k);
332 
333  qv(i,k) = qw(i,k) - qc(i,k);
334 
335  cldfrac_liq(i,k) = ekat::min(cldfrac_liq(i,k), 1);
336 
337  //P3 uses inv_qc_relvar, P3 is using dry mmrs, but
338  //wet<->dry conversion is a constant factor that cancels out in mean(qc)^2/mean(qc'*qc').
339  inv_qc_relvar(i,k) = 1;
340  const auto condition = (qc(i,k) != 0 && qc2(i,k) != 0);
341  if (condition.any()) {
342  inv_qc_relvar(i,k).set(condition,
343  ekat::min(inv_qc_relvar_max,
344  ekat::max(inv_qc_relvar_min,
345  ekat::square(qc(i,k))/qc2(i,k))));
346  }
347 
348  // Temperature
349  const Spack dse_ik(dse(i,k));
350  const Spack z_mid_ik(z_mid(i,k));
351  const Real phis_i(phis(i));
352  T_mid(i,k) = PF::calculate_temperature_from_dse(dse_ik,z_mid_ik,phis_i);
353 
354  });
355 
356  // If necessary, set appropriate boundary fluxes for energy and mass conservation checks.
357  // Any boundary fluxes not included in SHOC interface are set to 0.
359  vapor_flux(i) = surf_evap(i);
360  water_flux(i) = 0.0;
361  ice_flux(i) = 0.0;
362  heat_flux(i) = surf_sens_flux(i);
363  }
364  } // operator
365 
366  // Local variables
367  int ncol, nlev;
385 
386  // Assigning local variables
387  void set_variables (const int ncol_, const int nlev_,
388  const view_2d_const& rrho_,
389  const view_2d& qv_, const view_2d_const& qw_, const view_2d& qc_, const view_2d_const& qc_copy_,
390  const view_2d& tke_, const view_2d_const& tke_copy_, const view_3d_strided& qtracers_, const view_2d_const& qc2_,
391  const view_2d& cldfrac_liq_, const view_2d& inv_qc_relvar_,
392  const view_2d& T_mid_, const view_2d_const& dse_, const view_2d_const& z_mid_, const view_1d_const phis_)
393  {
394  ncol = ncol_;
395  nlev = nlev_;
396  rrho = rrho_;
397  qv = qv_;
398  qw = qw_;
399  qc = qc_;
400  qc_copy = qc_copy_;
401  tke = tke_;
402  tke_copy = tke_copy_;
403  qtracers = qtracers_;
404  qc2 = qc2_;
405  cldfrac_liq = cldfrac_liq_;
406  inv_qc_relvar = inv_qc_relvar_;
407  T_mid = T_mid_;
408  dse = dse_;
409  z_mid = z_mid_;
410  phis = phis_;
411  } // set_variables
412 
413  void set_mass_and_energy_fluxes (const view_1d_const& surf_evap_, const view_1d_const& surf_sens_flux_,
414  const view_1d& vapor_flux_, const view_1d& water_flux_,
415  const view_1d& ice_flux_, const view_1d& heat_flux_)
416  {
418  surf_evap = surf_evap_;
419  surf_sens_flux = surf_sens_flux_;
420  vapor_flux = vapor_flux_;
421  water_flux = water_flux_;
422  ice_flux = ice_flux_;
423  heat_flux = heat_flux_;
424  }
425  }; // SHOCPostprocess
426  /* --------------------------------------------------------------------------------------------*/
427 
428  // Structure for storing local variables initialized using the ATMBufferManager
429  struct Buffer {
430 #ifndef SCREAM_SHOC_SMALL_KERNELS
431  static constexpr int num_1d_scalar_ncol = 4;
432 #else
433  static constexpr int num_1d_scalar_ncol = 15;
434 #endif
435  static constexpr int num_1d_scalar_nlev = 1;
436 #ifndef SCREAM_SHOC_SMALL_KERNELS
437  static constexpr int num_2d_vector_mid = 19;
438  static constexpr int num_2d_vector_int = 12;
439 #else
440  static constexpr int num_2d_vector_mid = 23;
441  static constexpr int num_2d_vector_int = 13;
442 #endif
443  static constexpr int num_2d_vector_tr = 1;
444 
449 #ifdef SCREAM_SHOC_SMALL_KERNELS
461 #endif
463 
464  uview_2d<Spack> unused; // Placeholder for unused views
496 #ifdef SCREAM_SHOC_SMALL_KERNELS
503 #endif
504 
506  }; // BUFFER
507  /* --------------------------------------------------------------------------------------------*/
508 
509 #ifndef KOKKOS_ENABLE_CUDA
510  // Cuda requires methods enclosing __device__ lambda's to be public
511 protected:
512 #endif
513 
514  // Update flux (if necessary)
515  void check_flux_state_consistency (const double dt);
516 
517  // Apply TMS drag coeff to shoc_main inputs (if necessary)
519 
520 protected:
521 
522  // SHOC updates the 'tracers' group.
524 
525  // Computes total number of bytes needed for local variables
527 
528  // Set local variables
529  void init_buffers ();
530 
531  // Offsets for MultiFab <-> KOKKOS transfer
532  amrex::Vector<int> m_col_offsets;
533 
534  // Keep track of field dimensions and other scalar values
535  // needed in shoc_main
543 
544  // Grid level
545  int m_lev;
546 
547  // Step number
548  int m_step;
549 
550  // Geometry at given level
551  amrex::Geometry m_geom;
552 
553  // Boxarray at given level
554  amrex::BoxArray m_ba;
555 
556  // Pointer to the CC conserved vars
557  amrex::MultiFab* m_cons = nullptr;
558 
559  // Pointer to the terrain heights
560  amrex::MultiFab* m_z_phys = nullptr;
561 
562  // Flag for first step
563  bool m_first_step = true;
564 
565  // Struct which contains local variables
567 
568  // Store the structures for each argument to shoc_main;
569  SHF::SHOCInput input;
570  SHF::SHOCInputOutput input_output;
571  SHF::SHOCOutput output;
572  SHF::SHOCHistoryOutput history_output;
573  SHF::SHOCRuntime runtime_options;
574 #ifdef SCREAM_SHOC_SMALL_KERNELS
575  SHF::SHOCTemporaries temporaries;
576 #endif
577 
578  // Structures which compute pre/post process
581 
582  // WSM for internal local variables
583  ekat::WorkspaceManager<Spack, KT::Device> workspace_mgr;
584 
585  // Runtime options
586  //=======================================================
587  bool apply_tms = false;
588  bool check_flux_state = false;
589 
590  // SHOCPreprocess data structures
591  //=======================================================
600 
629 
631 
632  // SHOCPostprocess data structures
633  //=======================================================
636 
637  // SHOC InputOutput data structures
638  //=======================================================
642 
643  // SHOC Output data structures
644  //=======================================================
649 
650  // SHOC HistoryOutput data structures
651  //=======================================================
668 
669  // SHOC Miscellaneous data structures
670  //=======================================================
671  // Small kernels
689 }; // SHOCInterface
690 #endif
int Int
Definition: ERF_ShocInterface.H:20
amrex::Real Real
Definition: ERF_ShocInterface.H:19
Definition: ERF_ShocInterface.H:36
view_2d tabs
Definition: ERF_ShocInterface.H:686
view_2d p_int
Definition: ERF_ShocInterface.H:603
typename SHF::view_1d< const Real > view_1d_const
Definition: ERF_ShocInterface.H:48
bool check_flux_state
Definition: ERF_ShocInterface.H:588
SHOCPreprocess shoc_preprocess
Definition: ERF_ShocInterface.H:579
view_2d wqw_sec
Definition: ERF_ShocInterface.H:658
scream::shoc::Constants< Real > SC
Definition: ERF_ShocInterface.H:41
view_1d surf_drag_coeff_tms
Definition: ERF_ShocInterface.H:683
view_2d dz_zi
Definition: ERF_ShocInterface.H:688
view_2d inv_exner
Definition: ERF_ShocInterface.H:623
amrex::Geometry m_geom
Definition: ERF_ShocInterface.H:551
void set_computed_group_impl()
view_1d wl_b
Definition: ERF_ShocInterface.H:675
void alloc_buffers()
Definition: ERF_ShocInterface.cpp:154
view_1d wv_a
Definition: ERF_ShocInterface.H:678
view_2d wtke_sec
Definition: ERF_ShocInterface.H:659
view_2d thl_sec
Definition: ERF_ShocInterface.H:654
view_2d tkh
Definition: ERF_ShocInterface.H:648
view_2d cldfrac_liq
Definition: ERF_ShocInterface.H:627
amrex::MultiFab * m_z_phys
Definition: ERF_ShocInterface.H:560
void init_buffers()
Int m_num_layers
Definition: ERF_ShocInterface.H:537
view_2d vw_sec
Definition: ERF_ShocInterface.H:661
view_2d thv
Definition: ERF_ShocInterface.H:616
view_2d shoc_qv
Definition: ERF_ShocInterface.H:685
size_t requested_buffer_size_in_bytes() const
view_2d shoc_cond
Definition: ERF_ShocInterface.H:666
typename ekat::KokkosTypes< KokkosDefaultDevice >::template view_2d< Real > sview_2d
Definition: ERF_ShocInterface.H:51
view_1d vpwp_sfc
Definition: ERF_ShocInterface.H:596
view_2d brunt
Definition: ERF_ShocInterface.H:664
Int m_num_vel_comp
Definition: ERF_ShocInterface.H:541
bool apply_tms
Definition: ERF_ShocInterface.H:587
view_2d dens
Definition: ERF_ShocInterface.H:604
view_1d surf_sens_flux
Definition: ERF_ShocInterface.H:597
view_1d pblh
Definition: ERF_ShocInterface.H:645
Int m_num_cols
Definition: ERF_ShocInterface.H:536
view_1d wstar
Definition: ERF_ShocInterface.H:682
view_1d se_b
Definition: ERF_ShocInterface.H:672
view_2d sgs_buoy_flux
Definition: ERF_ShocInterface.H:639
SHF::SHOCOutput output
Definition: ERF_ShocInterface.H:571
typename KT::template view_1d< Int > view_1d_int
Definition: ERF_ShocInterface.H:46
ekat::WorkspaceManager< Spack, KT::Device > workspace_mgr
Definition: ERF_ShocInterface.H:583
view_2d p_mid
Definition: ERF_ShocInterface.H:602
view_2d rho_zt
Definition: ERF_ShocInterface.H:684
view_2d uw_sec
Definition: ERF_ShocInterface.H:660
view_2d dse
Definition: ERF_ShocInterface.H:618
Int m_nadv
Definition: ERF_ShocInterface.H:539
view_2d qc
Definition: ERF_ShocInterface.H:607
view_1d kbfs
Definition: ERF_ShocInterface.H:680
view_2d dz
Definition: ERF_ShocInterface.H:617
view_2d qwthl_sec
Definition: ERF_ShocInterface.H:656
view_1d ke_a
Definition: ERF_ShocInterface.H:677
void run_impl(const Real dt)
Definition: ERF_ShocInterface.cpp:652
view_1d wl_a
Definition: ERF_ShocInterface.H:679
Int m_npbl
Definition: ERF_ShocInterface.H:538
view_2d shoc_mix
Definition: ERF_ShocInterface.H:652
view_2d qw_sec
Definition: ERF_ShocInterface.H:655
view_2d cldfrac_liq_prev
Definition: ERF_ShocInterface.H:628
scream::physics::Constants< Real > C
Definition: ERF_ShocInterface.H:39
view_2d qw
Definition: ERF_ShocInterface.H:625
SHF::SHOCInput input
Definition: ERF_ShocInterface.H:569
SHOCInterface(const int &lev, SolverChoice &sc)
Definition: ERF_ShocInterface.cpp:6
view_2d cloud_frac
Definition: ERF_ShocInterface.H:626
view_2d omega
Definition: ERF_ShocInterface.H:605
typename SHF::view_2d< const Spack > view_2d_const
Definition: ERF_ShocInterface.H:50
ekat::Unmanaged< typename KT::template view_1d< ScalarT > > uview_1d
Definition: ERF_ShocInterface.H:60
typename SHF::Smask Smask
Definition: ERF_ShocInterface.H:45
typename SHF::view_3d_strided< Spack > view_3d_strided
Definition: ERF_ShocInterface.H:55
view_1d ustar2
Definition: ERF_ShocInterface.H:681
view_2d rrho_i
Definition: ERF_ShocInterface.H:615
view_1d obklen
Definition: ERF_ShocInterface.H:647
void kokkos_buffers_to_mf()
Definition: ERF_ShocInterface.cpp:533
view_2d z_mid
Definition: ERF_ShocInterface.H:609
view_2d qc_copy
Definition: ERF_ShocInterface.H:608
scream::shoc::Functions< Real, KokkosDefaultDevice > SHF
Definition: ERF_ShocInterface.H:37
SHF::SHOCRuntime runtime_options
Definition: ERF_ShocInterface.H:573
view_2d rrho
Definition: ERF_ShocInterface.H:614
view_2d inv_qc_relvar
Definition: ERF_ShocInterface.H:635
view_1d surf_evap
Definition: ERF_ShocInterface.H:598
view_2d w_sec
Definition: ERF_ShocInterface.H:653
void set_grids(int &level, const amrex::BoxArray &ba, amrex::Geometry &geom, amrex::MultiFab *cons, amrex::MultiFab *z_phys)
Definition: ERF_ShocInterface.cpp:112
view_1d phis
Definition: ERF_ShocInterface.H:592
view_2d shoc_evap
Definition: ERF_ShocInterface.H:667
typename ekat::KokkosTypes< KokkosDefaultDevice >::template view_2d< const Real > sview_2d_const
Definition: ERF_ShocInterface.H:52
view_3d horiz_wind
Definition: ERF_ShocInterface.H:641
void check_flux_state_consistency(const double dt)
Definition: ERF_ShocInterface.cpp:751
typename SHF::view_1d< Real > view_1d
Definition: ERF_ShocInterface.H:47
view_2d wqls_sec
Definition: ERF_ShocInterface.H:663
amrex::MultiFab * m_cons
Definition: ERF_ShocInterface.H:557
view_1d ke_b
Definition: ERF_ShocInterface.H:673
view_3d_strided qtracers
Definition: ERF_ShocInterface.H:630
ekat::KokkosTypes< KokkosDefaultDevice > KT
Definition: ERF_ShocInterface.H:40
view_1d upwp_sfc
Definition: ERF_ShocInterface.H:595
view_1d ustar
Definition: ERF_ShocInterface.H:646
view_2d tke_copy
Definition: ERF_ShocInterface.H:613
view_2d wm_zt
Definition: ERF_ShocInterface.H:622
scream::PhysicsFunctions< KokkosDefaultDevice > PF
Definition: ERF_ShocInterface.H:38
void finalize_impl()
Definition: ERF_ShocInterface.cpp:722
view_2d w3
Definition: ERF_ShocInterface.H:662
view_1d se_a
Definition: ERF_ShocInterface.H:676
void initialize_impl()
Definition: ERF_ShocInterface.cpp:538
ekat::Unmanaged< typename KT::template view_2d< ScalarT > > uview_2d
Definition: ERF_ShocInterface.H:62
view_1d wv_b
Definition: ERF_ShocInterface.H:674
ekat::WorkspaceManager< Spack, KT::Device > WSM
Definition: ERF_ShocInterface.H:57
typename SHF::view_3d< const Spack > view_3d_const
Definition: ERF_ShocInterface.H:54
bool m_first_step
Definition: ERF_ShocInterface.H:563
Int m_num_tracers
Definition: ERF_ShocInterface.H:540
std::string name() const
Definition: ERF_ShocInterface.H:107
int m_step
Definition: ERF_ShocInterface.H:548
sview_2d surf_mom_flux
Definition: ERF_ShocInterface.H:599
typename SHF::view_2d< SHF::Spack > view_2d
Definition: ERF_ShocInterface.H:49
view_2d zi_grid
Definition: ERF_ShocInterface.H:620
view_2d thlm
Definition: ERF_ShocInterface.H:624
int m_lev
Definition: ERF_ShocInterface.H:545
view_2d wtracer_sfc
Definition: ERF_ShocInterface.H:621
SHOCPostprocess shoc_postprocess
Definition: ERF_ShocInterface.H:580
typename SHF::Spack Spack
Definition: ERF_ShocInterface.H:43
SHF::SHOCInputOutput input_output
Definition: ERF_ShocInterface.H:570
Buffer m_buffer
Definition: ERF_ShocInterface.H:566
void mf_to_kokkos_buffers()
Definition: ERF_ShocInterface.cpp:376
view_2d shoc_ql2
Definition: ERF_ShocInterface.H:634
view_2d tk
Definition: ERF_ShocInterface.H:640
view_2d qv
Definition: ERF_ShocInterface.H:606
view_2d wthl_sec
Definition: ERF_ShocInterface.H:657
amrex::BoxArray m_ba
Definition: ERF_ShocInterface.H:554
view_2d tke
Definition: ERF_ShocInterface.H:612
view_2d zt_grid
Definition: ERF_ShocInterface.H:619
view_2d T_mid
Definition: ERF_ShocInterface.H:601
view_2d shoc_s
Definition: ERF_ShocInterface.H:611
void dealloc_buffers()
Definition: ERF_ShocInterface.cpp:268
Int hdtime
Definition: ERF_ShocInterface.H:542
view_2d z_int
Definition: ERF_ShocInterface.H:610
void apply_turbulent_mountain_stress()
Definition: ERF_ShocInterface.cpp:735
typename SHF::view_3d< Spack > view_3d
Definition: ERF_ShocInterface.H:53
view_2d isotropy
Definition: ERF_ShocInterface.H:665
typename SHF::IntSmallPack IntSmallPack
Definition: ERF_ShocInterface.H:44
view_2d dz_zt
Definition: ERF_ShocInterface.H:687
amrex::Vector< int > m_col_offsets
Definition: ERF_ShocInterface.H:532
SHF::SHOCHistoryOutput history_output
Definition: ERF_ShocInterface.H:572
view_1d wpthlp_sfc
Definition: ERF_ShocInterface.H:593
view_1d wprtp_sfc
Definition: ERF_ShocInterface.H:594
@ cons
Definition: ERF_IndexDefines.H:140
Definition: ERF_ShocInterface.H:429
uview_2d< Spack > w3
Definition: ERF_ShocInterface.H:493
uview_2d< Spack > qc_copy
Definition: ERF_ShocInterface.H:480
uview_2d< Spack > dse
Definition: ERF_ShocInterface.H:478
uview_1d< Real > upwp_sfc
Definition: ERF_ShocInterface.H:447
uview_2d< Spack > vw_sec
Definition: ERF_ShocInterface.H:492
uview_1d< Real > wpthlp_sfc
Definition: ERF_ShocInterface.H:445
uview_2d< Spack > thv
Definition: ERF_ShocInterface.H:469
uview_2d< Spack > wqls_sec
Definition: ERF_ShocInterface.H:494
uview_2d< Spack > wthl_sec
Definition: ERF_ShocInterface.H:488
uview_2d< Spack > thlm
Definition: ERF_ShocInterface.H:476
uview_2d< Spack > uw_sec
Definition: ERF_ShocInterface.H:491
uview_2d< Spack > z_mid
Definition: ERF_ShocInterface.H:465
uview_1d< Real > vpwp_sfc
Definition: ERF_ShocInterface.H:448
uview_2d< Spack > rrho
Definition: ERF_ShocInterface.H:467
uview_2d< Spack > wtke_sec
Definition: ERF_ShocInterface.H:490
uview_2d< Spack > rrho_i
Definition: ERF_ShocInterface.H:468
uview_2d< Spack > unused
Definition: ERF_ShocInterface.H:464
Spack * wsm_data
Definition: ERF_ShocInterface.H:505
static constexpr int num_2d_vector_int
Definition: ERF_ShocInterface.H:438
uview_2d< Spack > wtracer_sfc
Definition: ERF_ShocInterface.H:473
static constexpr int num_2d_vector_tr
Definition: ERF_ShocInterface.H:443
static constexpr int num_1d_scalar_nlev
Definition: ERF_ShocInterface.H:435
uview_2d< Spack > inv_exner
Definition: ERF_ShocInterface.H:475
uview_2d< Spack > qwthl_sec
Definition: ERF_ShocInterface.H:487
uview_2d< Spack > qw
Definition: ERF_ShocInterface.H:477
uview_2d< Spack > brunt
Definition: ERF_ShocInterface.H:495
uview_2d< Spack > shoc_mix
Definition: ERF_ShocInterface.H:482
uview_2d< Spack > tke_copy
Definition: ERF_ShocInterface.H:479
static constexpr int num_1d_scalar_ncol
Definition: ERF_ShocInterface.H:431
uview_2d< Spack > isotropy
Definition: ERF_ShocInterface.H:483
uview_2d< Spack > zt_grid
Definition: ERF_ShocInterface.H:471
uview_2d< Spack > w_sec
Definition: ERF_ShocInterface.H:484
uview_2d< Spack > thl_sec
Definition: ERF_ShocInterface.H:485
uview_2d< Spack > wm_zt
Definition: ERF_ShocInterface.H:474
uview_2d< Spack > qw_sec
Definition: ERF_ShocInterface.H:486
uview_2d< Spack > wqw_sec
Definition: ERF_ShocInterface.H:489
uview_2d< Spack > z_int
Definition: ERF_ShocInterface.H:466
uview_2d< Spack > shoc_ql2
Definition: ERF_ShocInterface.H:481
uview_1d< Real > wprtp_sfc
Definition: ERF_ShocInterface.H:446
uview_2d< Spack > zi_grid
Definition: ERF_ShocInterface.H:472
static constexpr int num_2d_vector_mid
Definition: ERF_ShocInterface.H:437
uview_1d< Spack > pref_mid
Definition: ERF_ShocInterface.H:462
uview_2d< Spack > dz
Definition: ERF_ShocInterface.H:470
Definition: ERF_ShocInterface.H:315
view_1d_const surf_sens_flux
Definition: ERF_ShocInterface.H:380
view_1d ice_flux
Definition: ERF_ShocInterface.H:383
view_1d vapor_flux
Definition: ERF_ShocInterface.H:381
view_1d_const phis
Definition: ERF_ShocInterface.H:377
int nlev
Definition: ERF_ShocInterface.H:367
view_1d heat_flux
Definition: ERF_ShocInterface.H:384
view_2d cldfrac_liq
Definition: ERF_ShocInterface.H:373
view_2d_const rrho
Definition: ERF_ShocInterface.H:368
KOKKOS_INLINE_FUNCTION void operator()(const Kokkos::TeamPolicy< KT::ExeSpace >::member_type &team) const
Definition: ERF_ShocInterface.H:319
view_3d_strided qtracers
Definition: ERF_ShocInterface.H:371
void set_variables(const int ncol_, const int nlev_, const view_2d_const &rrho_, const view_2d &qv_, const view_2d_const &qw_, const view_2d &qc_, const view_2d_const &qc_copy_, const view_2d &tke_, const view_2d_const &tke_copy_, const view_3d_strided &qtracers_, const view_2d_const &qc2_, const view_2d &cldfrac_liq_, const view_2d &inv_qc_relvar_, const view_2d &T_mid_, const view_2d_const &dse_, const view_2d_const &z_mid_, const view_1d_const phis_)
Definition: ERF_ShocInterface.H:387
view_2d_const qw
Definition: ERF_ShocInterface.H:370
bool compute_mass_and_energy_fluxes
Definition: ERF_ShocInterface.H:378
view_1d water_flux
Definition: ERF_ShocInterface.H:382
view_1d_const surf_evap
Definition: ERF_ShocInterface.H:379
view_2d_const qc_copy
Definition: ERF_ShocInterface.H:370
view_2d_const z_mid
Definition: ERF_ShocInterface.H:376
view_2d_const dse
Definition: ERF_ShocInterface.H:376
view_2d tke
Definition: ERF_ShocInterface.H:369
view_2d T_mid
Definition: ERF_ShocInterface.H:375
view_2d inv_qc_relvar
Definition: ERF_ShocInterface.H:374
view_2d qc
Definition: ERF_ShocInterface.H:369
void set_mass_and_energy_fluxes(const view_1d_const &surf_evap_, const view_1d_const &surf_sens_flux_, const view_1d &vapor_flux_, const view_1d &water_flux_, const view_1d &ice_flux_, const view_1d &heat_flux_)
Definition: ERF_ShocInterface.H:413
view_2d qv
Definition: ERF_ShocInterface.H:369
int ncol
Definition: ERF_ShocInterface.H:367
view_2d_const qc2
Definition: ERF_ShocInterface.H:372
view_2d_const tke_copy
Definition: ERF_ShocInterface.H:370
Definition: ERF_ShocInterface.H:119
int ncol
Definition: ERF_ShocInterface.H:212
view_3d_strided qtracers
Definition: ERF_ShocInterface.H:223
int nlev
Definition: ERF_ShocInterface.H:212
view_2d cldfrac_liq_prev
Definition: ERF_ShocInterface.H:249
view_2d rrho
Definition: ERF_ShocInterface.H:232
view_2d_const pseudo_density
Definition: ERF_ShocInterface.H:217
sview_2d_const surf_mom_flux
Definition: ERF_ShocInterface.H:222
view_2d_const qc
Definition: ERF_ShocInterface.H:225
view_2d thlm
Definition: ERF_ShocInterface.H:245
view_1d_const phis
Definition: ERF_ShocInterface.H:219
view_1d_const surf_evap
Definition: ERF_ShocInterface.H:221
view_2d zt_grid
Definition: ERF_ShocInterface.H:236
view_2d cldfrac_liq
Definition: ERF_ShocInterface.H:248
view_2d inv_exner
Definition: ERF_ShocInterface.H:244
view_1d_const surf_sens_flux
Definition: ERF_ShocInterface.H:220
view_2d wm_zt
Definition: ERF_ShocInterface.H:243
KOKKOS_INLINE_FUNCTION void operator()(const Kokkos::TeamPolicy< KT::ExeSpace >::member_type &team) const
Definition: ERF_ShocInterface.H:123
view_2d qc_copy
Definition: ERF_ShocInterface.H:226
view_2d wtracer_sfc
Definition: ERF_ShocInterface.H:242
view_2d z_mid
Definition: ERF_ShocInterface.H:227
view_2d rrho_i
Definition: ERF_ShocInterface.H:233
view_2d_const omega
Definition: ERF_ShocInterface.H:218
view_2d_const T_mid
Definition: ERF_ShocInterface.H:214
view_2d cloud_frac
Definition: ERF_ShocInterface.H:247
Real z_surf
Definition: ERF_ShocInterface.H:213
view_2d_const p_int
Definition: ERF_ShocInterface.H:216
view_2d tke
Definition: ERF_ShocInterface.H:230
view_1d wprtp_sfc
Definition: ERF_ShocInterface.H:239
view_2d qw
Definition: ERF_ShocInterface.H:246
view_1d upwp_sfc
Definition: ERF_ShocInterface.H:240
view_1d wpthlp_sfc
Definition: ERF_ShocInterface.H:238
view_2d z_int
Definition: ERF_ShocInterface.H:228
view_2d_const p_mid
Definition: ERF_ShocInterface.H:215
view_1d vpwp_sfc
Definition: ERF_ShocInterface.H:241
view_2d dz
Definition: ERF_ShocInterface.H:235
view_2d shoc_s
Definition: ERF_ShocInterface.H:229
view_2d tke_copy
Definition: ERF_ShocInterface.H:231
view_2d zi_grid
Definition: ERF_ShocInterface.H:237
view_2d qv
Definition: ERF_ShocInterface.H:224
view_2d thv
Definition: ERF_ShocInterface.H:234
void set_variables(const int ncol_, const int nlev_, const Real z_surf_, const view_2d_const &T_mid_, const view_2d_const &p_mid_, const view_2d_const &p_int_, const view_2d_const &pseudo_density_, const view_2d_const &omega_, const view_1d_const &phis_, const view_1d_const &surf_sens_flux_, const view_1d_const &surf_evap_, const sview_2d_const &surf_mom_flux_, const view_3d_strided &qtracers_, const view_2d &qv_, const view_2d_const &qc_, const view_2d &qc_copy_, const view_2d &tke_, const view_2d &tke_copy_, const view_2d &z_mid_, const view_2d &z_int_, const view_2d &dse_, const view_2d &rrho_, const view_2d &rrho_i_, const view_2d &thv_, const view_2d &dz_, const view_2d &zt_grid_, const view_2d &zi_grid_, const view_1d &wpthlp_sfc_, const view_1d &wprtp_sfc_, const view_1d &upwp_sfc_, const view_1d &vpwp_sfc_, const view_2d &wtracer_sfc_, const view_2d &wm_zt_, const view_2d &inv_exner_, const view_2d &thlm_, const view_2d &qw_, const view_2d &cldfrac_liq_, const view_2d &cldfrac_liq_prev_)
Definition: ERF_ShocInterface.H:252
Definition: ERF_DataStruct.H:123