ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_Kessler.H
Go to the documentation of this file.
1 #ifndef ERF_Kessler_H
2 #define ERF_Kessler_H
3 
4 #include <string>
5 #include <vector>
6 #include <memory>
7 
8 #include <AMReX_FArrayBox.H>
9 #include <AMReX_Geometry.H>
10 #include <AMReX_TableData.H>
11 #include <AMReX_MultiFabUtil.H>
12 
13 #include "ERF_Constants.H"
14 #include "ERF_MicrophysicsUtils.H"
15 #include "ERF_IndexDefines.H"
16 #include "ERF_DataStruct.H"
17 #include "ERF_NullMoist.H"
18 
19 namespace MicVar_Kess {
20  enum {
21  // independent variables
22  rho=0, // density
23  theta, // liquid/ice water potential temperature
24  tabs, // temperature
25  pres, // pressure
26  // non-precipitating vars
27  qt, // total cloud
28  qv, // cloud vapor
29  qcl, // cloud water
30  // precipitating vars
31  qp, // total precip
32  // derived vars
34  NumVars
35  };
36 }
37 
38 class Kessler : public NullMoist {
39 
40  using FabPtr = std::shared_ptr<amrex::MultiFab>;
41 
42 public:
43  // constructor
44  Kessler () {}
45 
46  // destructor
47  virtual ~Kessler () = default;
48 
49  // cloud physics
50  void AdvanceKessler (const SolverChoice &solverChoice);
51 
52  // Set up for first time
53  void
54  Define (SolverChoice& sc) override
55  {
56  m_fac_cond = lcond / sc.c_p;
57  m_fac_fus = lfus / sc.c_p;
58  m_fac_sub = lsub / sc.c_p;
59  m_gOcp = CONST_GRAV / sc.c_p;
60  m_axis = sc.ave_plane;
61  m_do_cond = (!sc.use_shoc);
62  }
63 
64  // init
65  void
66  Init (const amrex::MultiFab& cons_in,
67  const amrex::BoxArray& grids,
68  const amrex::Geometry& geom,
69  const amrex::Real& dt_advance,
70  std::unique_ptr<amrex::MultiFab>& z_phys_nd,
71  std::unique_ptr<amrex::MultiFab>& detJ_cc) override;
72 
73  // Copy state into micro vars
74  void
75  Copy_State_to_Micro (const amrex::MultiFab& cons_in) override;
76 
77  // Copy state into micro vars
78  void
79  Copy_Micro_to_State (amrex::MultiFab& cons_in) override;
80 
81  // update micro vars
82  void
83  Update_Micro_Vars (amrex::MultiFab& cons_in) override
84  {
85  this->Copy_State_to_Micro(cons_in);
86  }
87 
88  // update state vars
89  void
90  Update_State_Vars (amrex::MultiFab& cons_in) override
91  {
92  this->Copy_Micro_to_State(cons_in);
93  }
94 
95  // wrapper to advance micro vars
96  void
97  Advance (const amrex::Real& dt_advance,
98  const SolverChoice& solverChoice) override
99  {
100  dt = dt_advance;
101 
102  this->AdvanceKessler(solverChoice);
103  }
104 
105  amrex::MultiFab*
106  Qmoist_Ptr (const int& varIdx) override
107  {
108  AMREX_ALWAYS_ASSERT(varIdx < m_qmoist_size);
109  return mic_fab_vars[MicVarMap[varIdx]].get();
110  }
111 
112  int
113  Qmoist_Size () override { return Kessler::m_qmoist_size; }
114 
115  int
117 
118  void
120  std::vector<int>& a_idx,
121  std::vector<std::string>& a_names) const override
122  {
123  a_idx.clear();
124  a_names.clear();
125 
126  // NOTE: These are the indices to access into qmoist (not mic_fab_vars)
127  a_idx.push_back(0); a_names.push_back("RainAccum");
128  }
129 
130 private:
131  // Number of qmoist variables (rain_accum)
132  int m_qmoist_size = 1;
133 
134  // Number of qstate variables
136 
137  // CFL MAX for vertical advection
138  static constexpr amrex::Real CFL_MAX = 0.5;
139 
140  // MicVar map (Qmoist indices -> MicVar enum)
141  amrex::Vector<int> MicVarMap;
142 
143  // geometry
144  amrex::Geometry m_geom;
145 
146  // valid boxes on which to evolve the solution
147  amrex::BoxArray m_gtoe;
148 
149  // timestep
151 
152  // number of vertical levels
153  int nlev, zlo, zhi;
154 
155  // plane average axis
156  int m_axis;
157 
158  // constants
163  bool m_do_cond;
164 
165  // Pointer to terrain data
166  amrex::MultiFab* m_z_phys_nd;
167  amrex::MultiFab* m_detJ_cc;
168 
169  // independent variables
170  amrex::Array<FabPtr, MicVar_Kess::NumVars> mic_fab_vars;
171 };
172 #endif
constexpr amrex::Real lfus
Definition: ERF_Constants.H:67
constexpr amrex::Real lsub
Definition: ERF_Constants.H:68
constexpr amrex::Real lcond
Definition: ERF_Constants.H:66
constexpr amrex::Real CONST_GRAV
Definition: ERF_Constants.H:21
amrex::Real Real
Definition: ERF_ShocInterface.H:19
Definition: ERF_Kessler.H:38
int zlo
Definition: ERF_Kessler.H:153
void Update_Micro_Vars(amrex::MultiFab &cons_in) override
Definition: ERF_Kessler.H:83
amrex::MultiFab * Qmoist_Ptr(const int &varIdx) override
Definition: ERF_Kessler.H:106
amrex::Vector< int > MicVarMap
Definition: ERF_Kessler.H:141
void Copy_State_to_Micro(const amrex::MultiFab &cons_in) override
Definition: ERF_InitKessler.cpp:64
amrex::Real m_fac_sub
Definition: ERF_Kessler.H:161
void Qmoist_Restart_Vars(const SolverChoice &, std::vector< int > &a_idx, std::vector< std::string > &a_names) const override
Definition: ERF_Kessler.H:119
int Qmoist_Size() override
Definition: ERF_Kessler.H:113
int n_qstate_moist_size
Definition: ERF_Kessler.H:135
virtual ~Kessler()=default
amrex::Geometry m_geom
Definition: ERF_Kessler.H:144
Kessler()
Definition: ERF_Kessler.H:44
amrex::MultiFab * m_detJ_cc
Definition: ERF_Kessler.H:167
void Define(SolverChoice &sc) override
Definition: ERF_Kessler.H:54
int Qstate_Moist_Size() override
Definition: ERF_Kessler.H:116
amrex::Real m_fac_cond
Definition: ERF_Kessler.H:159
void Copy_Micro_to_State(amrex::MultiFab &cons_in) override
Definition: ERF_UpdateKessler.cpp:14
amrex::Real dt
Definition: ERF_Kessler.H:150
int zhi
Definition: ERF_Kessler.H:153
int nlev
Definition: ERF_Kessler.H:153
bool m_do_cond
Definition: ERF_Kessler.H:163
amrex::Array< FabPtr, MicVar_Kess::NumVars > mic_fab_vars
Definition: ERF_Kessler.H:170
amrex::Real m_gOcp
Definition: ERF_Kessler.H:162
amrex::MultiFab * m_z_phys_nd
Definition: ERF_Kessler.H:166
void Init(const amrex::MultiFab &cons_in, const amrex::BoxArray &grids, const amrex::Geometry &geom, const amrex::Real &dt_advance, std::unique_ptr< amrex::MultiFab > &z_phys_nd, std::unique_ptr< amrex::MultiFab > &detJ_cc) override
Definition: ERF_InitKessler.cpp:22
static constexpr amrex::Real CFL_MAX
Definition: ERF_Kessler.H:138
void AdvanceKessler(const SolverChoice &solverChoice)
Definition: ERF_Kessler.cpp:11
amrex::Real m_fac_fus
Definition: ERF_Kessler.H:160
std::shared_ptr< amrex::MultiFab > FabPtr
Definition: ERF_Kessler.H:40
void Advance(const amrex::Real &dt_advance, const SolverChoice &solverChoice) override
Definition: ERF_Kessler.H:97
void Update_State_Vars(amrex::MultiFab &cons_in) override
Definition: ERF_Kessler.H:90
amrex::BoxArray m_gtoe
Definition: ERF_Kessler.H:147
int m_qmoist_size
Definition: ERF_Kessler.H:132
int m_axis
Definition: ERF_Kessler.H:156
Definition: ERF_NullMoist.H:8
Definition: ERF_Kessler.H:19
@ qp
Definition: ERF_Kessler.H:31
@ qcl
Definition: ERF_Kessler.H:29
@ tabs
Definition: ERF_Kessler.H:24
@ pres
Definition: ERF_Kessler.H:25
@ rho
Definition: ERF_Kessler.H:22
@ theta
Definition: ERF_Kessler.H:23
@ qt
Definition: ERF_Kessler.H:27
@ rain_accum
Definition: ERF_Kessler.H:33
@ NumVars
Definition: ERF_Kessler.H:34
@ qv
Definition: ERF_Kessler.H:28
Definition: ERF_DataStruct.H:123
amrex::Real c_p
Definition: ERF_DataStruct.H:865
bool use_shoc
Definition: ERF_DataStruct.H:895
int ave_plane
Definition: ERF_DataStruct.H:926