ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_ShocEnergyFixer.H
Go to the documentation of this file.
1 #ifndef ERF_SHOC_ENERGY_FIXER_H_
2 #define ERF_SHOC_ENERGY_FIXER_H_
3 
4 #include "ERF_ShocColumnData.H"
5 #include "ERF_ShocConstants.H"
6 #include "ERF_ShocThermoUtils.H"
7 
8 #include "ERF_Constants.H"
9 
10 namespace shoc {
11 
13 {
14  amrex::Array4<const amrex::Real> rho;
15  amrex::Array4<const amrex::Real> dz;
16  amrex::Array4<const amrex::Real> zt;
17  amrex::Array4<const amrex::Real> exner;
18  amrex::Array4<const amrex::Real> surf_sens_flux;
19  amrex::Array4<const amrex::Real> surf_lat_flux;
20 
21  amrex::Array4<const amrex::Real> thetal_base;
22  amrex::Array4<const amrex::Real> qv_base;
23  amrex::Array4<const amrex::Real> qc_base;
24  amrex::Array4<const amrex::Real> qi_base;
25  amrex::Array4<const amrex::Real> u_base;
26  amrex::Array4<const amrex::Real> v_base;
27  amrex::Array4<const amrex::Real> tke_base;
28 
29  amrex::Array4<amrex::Real> thetal;
30  amrex::Array4<const amrex::Real> qw;
31  amrex::Array4<const amrex::Real> u;
32  amrex::Array4<const amrex::Real> v;
33  amrex::Array4<const amrex::Real> tke;
34  amrex::Array4<const amrex::Real> shoc_ql;
35 
36  int nlev = 0;
37 };
38 
41 {
42  return {
43  col.rho.const_array(),
44  col.dz.const_array(),
45  col.zt.const_array(),
46  col.exner.const_array(),
47  col.surf_sens_flux.const_array(),
48  col.surf_lat_flux.const_array(),
49  col.thetal_base.const_array(),
50  col.qv_base.const_array(),
51  col.qc_base.const_array(),
52  col.qi_base.const_array(),
53  col.u_base.const_array(),
54  col.v_base.const_array(),
55  col.tke_base_state.const_array(),
56  col.thetal.array(),
57  col.qw.const_array(),
58  col.u.const_array(),
59  col.v.const_array(),
60  col.tke.const_array(),
61  col.shoc_ql.const_array(),
62  col.layout.nlev
63  };
64 }
65 
66 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
67 int
68 diagnose_active_top (const amrex::Array4<const amrex::Real>& tke,
69  int ic,
70  int nlev) noexcept
71 {
72  int shoc_top = -1;
73  for (int k = nlev - 1; k >= 0; --k) {
74  if (tke(ic,k,0) > constants::min_tke()) {
75  shoc_top = k;
76  break;
77  }
78  }
79  return shoc_top;
80 }
81 
82 AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
83 void
85  int ic,
86  amrex::Real dt) noexcept
87 {
88  const int shoc_top = diagnose_active_top(v.tke, ic, v.nlev);
89  if (shoc_top < 0) {
90  return;
91  }
92 
93  amrex::Real energy_before = amrex::Real(0.0);
94  amrex::Real energy_after = amrex::Real(0.0);
95  amrex::Real air_mass = amrex::Real(0.0);
96 
97  for (int k = 0; k <= shoc_top; ++k) {
98  const amrex::Real mass = v.rho(ic,k,0) * v.dz(ic,k,0);
99  const amrex::Real tabs_old = shoc::temperature_from_thetal(v.thetal_base(ic,k,0),
100  v.qc_base(ic,k,0),
101  v.qi_base(ic,k,0),
102  v.exner(ic,k,0));
103 
104  amrex::Real tabs_new = amrex::Real(0.0);
105  amrex::Real qv_new = amrex::Real(0.0);
106  amrex::Real qc_new = amrex::Real(0.0);
107  amrex::Real qi_new = amrex::Real(0.0);
108  shoc::reconstruct_pdf_state(v.thetal(ic,k,0), v.qw(ic,k,0), v.exner(ic,k,0),
109  v.qi_base(ic,k,0), v.shoc_ql(ic,k,0),
110  tabs_new, qv_new, qc_new, qi_new);
111 
112  energy_before += mass * moist_energy(tabs_old, v.zt(ic,k,0),
113  v.qv_base(ic,k,0), v.qc_base(ic,k,0), v.qi_base(ic,k,0),
114  v.u_base(ic,k,0), v.v_base(ic,k,0), v.tke_base(ic,k,0));
115  energy_after += mass * moist_energy(tabs_new, v.zt(ic,k,0),
116  qv_new, qc_new, qi_new,
117  v.u(ic,k,0), v.v(ic,k,0), v.tke(ic,k,0));
118  air_mass += mass;
119  }
120 
121  if (air_mass <= amrex::Real(0.0)) {
122  return;
123  }
124 
125  const amrex::Real latent_flux_coeff = L_v + constants::latent_ice();
126  const amrex::Real energy_target = energy_before
127  + dt * v.rho(ic,0,0)
128  * (Cp_d * v.exner(ic,0,0) * v.surf_sens_flux(ic,0,0)
129  + latent_flux_coeff * v.surf_lat_flux(ic,0,0));
130  const amrex::Real delta_tabs = (energy_target - energy_after) / (Cp_d * air_mass);
131 
132  for (int k = 0; k <= shoc_top; ++k) {
133  v.thetal(ic,k,0) += delta_tabs / amrex::max(v.exner(ic,k,0), amrex::Real(1.0e-12));
134  }
135 }
136 
137 } // namespace shoc
138 
140 {
141 public:
142  static int diagnose_active_top (const amrex::Vector<amrex::Real>& tke);
143 
144  AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE
145  static int diagnose_active_top (const amrex::Array4<const amrex::Real>& tke,
146  int ic,
147  int nlev) noexcept
148  {
149  return shoc::diagnose_active_top(tke, ic, nlev);
150  }
151 
152  static void apply_column (const ShocColumnData& col,
153  int ic,
154  amrex::Real dt,
155  const amrex::Vector<amrex::Real>& thl_old,
156  const amrex::Vector<amrex::Real>& qv_old,
157  const amrex::Vector<amrex::Real>& qc_old,
158  const amrex::Vector<amrex::Real>& qi_old,
159  const amrex::Vector<amrex::Real>& u_old,
160  const amrex::Vector<amrex::Real>& v_old,
161  const amrex::Vector<amrex::Real>& tke_old,
162  amrex::Vector<amrex::Real>& thl_new,
163  const amrex::Vector<amrex::Real>& qv_new,
164  const amrex::Vector<amrex::Real>& qc_new,
165  const amrex::Vector<amrex::Real>& qi_new,
166  const amrex::Vector<amrex::Real>& u_new,
167  const amrex::Vector<amrex::Real>& v_new,
168  const amrex::Vector<amrex::Real>& tke_new);
169 };
170 
171 #endif
constexpr amrex::Real Cp_d
Definition: ERF_Constants.H:44
constexpr amrex::Real L_v
Definition: ERF_Constants.H:48
amrex::Real Real
Definition: ERF_ShocInterface.H:19
Definition: ERF_ShocEnergyFixer.H:140
AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE int diagnose_active_top(const amrex::Array4< const amrex::Real > &tke, int ic, int nlev) noexcept
Definition: ERF_ShocEnergyFixer.H:145
static int diagnose_active_top(const amrex::Vector< amrex::Real > &tke)
static void apply_column(const ShocColumnData &col, int ic, amrex::Real dt, const amrex::Vector< amrex::Real > &thl_old, const amrex::Vector< amrex::Real > &qv_old, const amrex::Vector< amrex::Real > &qc_old, const amrex::Vector< amrex::Real > &qi_old, const amrex::Vector< amrex::Real > &u_old, const amrex::Vector< amrex::Real > &v_old, const amrex::Vector< amrex::Real > &tke_old, amrex::Vector< amrex::Real > &thl_new, const amrex::Vector< amrex::Real > &qv_new, const amrex::Vector< amrex::Real > &qc_new, const amrex::Vector< amrex::Real > &qi_new, const amrex::Vector< amrex::Real > &u_new, const amrex::Vector< amrex::Real > &v_new, const amrex::Vector< amrex::Real > &tke_new)
Definition: ERF_ShocEnergyFixer.cpp:19
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real latent_ice() noexcept
Definition: ERF_ShocConstants.H:13
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real min_tke() noexcept
Definition: ERF_ShocConstants.H:10
Definition: ERF_ShocConstants.H:7
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void apply_energy_fix_column(const ShocEnergyFixerView &v, int ic, amrex::Real dt) noexcept
Definition: ERF_ShocEnergyFixer.H:84
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE int diagnose_active_top(const amrex::Array4< const amrex::Real > &tke, int ic, int nlev) noexcept
Definition: ERF_ShocEnergyFixer.H:68
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void reconstruct_pdf_state(amrex::Real thetal, amrex::Real qw, amrex::Real exner, amrex::Real qi_seed, amrex::Real pdf_ql, amrex::Real &tabs, amrex::Real &qv, amrex::Real &qc, amrex::Real &qi) noexcept
Definition: ERF_ShocThermoUtils.H:86
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real moist_energy(amrex::Real tabs, amrex::Real z, amrex::Real qv, amrex::Real qc, amrex::Real qi, amrex::Real u, amrex::Real v, amrex::Real tke) noexcept
Definition: ERF_ShocThermoUtils.H:64
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amrex::Real temperature_from_thetal(amrex::Real thetal, amrex::Real qc, amrex::Real qi, amrex::Real exner) noexcept
Definition: ERF_ShocThermoUtils.H:40
ShocEnergyFixerView make_energy_fixer_view(ShocColumnData &col)
Definition: ERF_ShocEnergyFixer.H:40
Definition: ERF_ShocTypes.H:204
amrex::FArrayBox dz
Definition: ERF_ShocTypes.H:210
amrex::FArrayBox surf_lat_flux
Definition: ERF_ShocTypes.H:277
amrex::FArrayBox v_base
Definition: ERF_ShocTypes.H:266
amrex::FArrayBox rho
Definition: ERF_ShocTypes.H:213
amrex::FArrayBox tke_base_state
Definition: ERF_ShocTypes.H:267
amrex::FArrayBox qv_base
Definition: ERF_ShocTypes.H:262
amrex::FArrayBox shoc_ql
Definition: ERF_ShocTypes.H:243
amrex::FArrayBox tke
Definition: ERF_ShocTypes.H:223
amrex::FArrayBox qi_base
Definition: ERF_ShocTypes.H:264
amrex::FArrayBox exner
Definition: ERF_ShocTypes.H:215
amrex::FArrayBox u_base
Definition: ERF_ShocTypes.H:265
amrex::FArrayBox qc_base
Definition: ERF_ShocTypes.H:263
ShocColumnLayout layout
Definition: ERF_ShocTypes.H:205
amrex::FArrayBox surf_sens_flux
Definition: ERF_ShocTypes.H:276
amrex::FArrayBox qw
Definition: ERF_ShocTypes.H:221
amrex::FArrayBox v
Definition: ERF_ShocTypes.H:225
amrex::FArrayBox zt
Definition: ERF_ShocTypes.H:208
amrex::FArrayBox u
Definition: ERF_ShocTypes.H:224
amrex::FArrayBox thetal_base
Definition: ERF_ShocTypes.H:260
amrex::FArrayBox thetal
Definition: ERF_ShocTypes.H:217
int nlev
Definition: ERF_ShocTypes.H:196
Definition: ERF_ShocEnergyFixer.H:13
amrex::Array4< const amrex::Real > rho
Definition: ERF_ShocEnergyFixer.H:14
amrex::Array4< const amrex::Real > qc_base
Definition: ERF_ShocEnergyFixer.H:23
amrex::Array4< amrex::Real > thetal
Definition: ERF_ShocEnergyFixer.H:29
amrex::Array4< const amrex::Real > surf_lat_flux
Definition: ERF_ShocEnergyFixer.H:19
int nlev
Definition: ERF_ShocEnergyFixer.H:36
amrex::Array4< const amrex::Real > u
Definition: ERF_ShocEnergyFixer.H:31
amrex::Array4< const amrex::Real > zt
Definition: ERF_ShocEnergyFixer.H:16
amrex::Array4< const amrex::Real > tke
Definition: ERF_ShocEnergyFixer.H:33
amrex::Array4< const amrex::Real > tke_base
Definition: ERF_ShocEnergyFixer.H:27
amrex::Array4< const amrex::Real > u_base
Definition: ERF_ShocEnergyFixer.H:25
amrex::Array4< const amrex::Real > exner
Definition: ERF_ShocEnergyFixer.H:17
amrex::Array4< const amrex::Real > surf_sens_flux
Definition: ERF_ShocEnergyFixer.H:18
amrex::Array4< const amrex::Real > qv_base
Definition: ERF_ShocEnergyFixer.H:22
amrex::Array4< const amrex::Real > v_base
Definition: ERF_ShocEnergyFixer.H:26
amrex::Array4< const amrex::Real > v
Definition: ERF_ShocEnergyFixer.H:32
amrex::Array4< const amrex::Real > shoc_ql
Definition: ERF_ShocEnergyFixer.H:34
amrex::Array4< const amrex::Real > qi_base
Definition: ERF_ShocEnergyFixer.H:24
amrex::Array4< const amrex::Real > thetal_base
Definition: ERF_ShocEnergyFixer.H:21
amrex::Array4< const amrex::Real > dz
Definition: ERF_ShocEnergyFixer.H:15
amrex::Array4< const amrex::Real > qw
Definition: ERF_ShocEnergyFixer.H:30