ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
ERF_EddyViscosity.H
Go to the documentation of this file.
1 /** \file ERF_EddyViscosity.H */
2 
3 #ifndef ERF_EDDY_VISCOSITY_H_
4 #define ERF_EDDY_VISCOSITY_H_
5 
6 #include "AMReX_BCRec.H"
7 #include "ERF_SurfaceLayer.H"
8 #include "ERF_DataStruct.H"
9 #include "ERF_IndexDefines.H"
10 #include "ERF_Constants.H"
11 #include "ERF_EOS.H"
12 #include "ERF_EB.H"
13 
14 #ifdef ERF_USE_EAMXX_SHOC
15 #include "ERF_ShocInterface.H"
16 #endif
17 
18 void
20  const amrex::MultiFab& xvel ,
21  const amrex::MultiFab& yvel ,
22  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
23  amrex::MultiFab& cons_in,
24  const amrex::MultiFab& wdist,
25  amrex::MultiFab& eddyViscosity,
26  amrex::MultiFab& Hfx1,
27  amrex::MultiFab& Hfx2,
28  amrex::MultiFab& Hfx3,
29  amrex::MultiFab& Diss,
30  const amrex::Geometry& geom,
31  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
32  const std::unique_ptr<amrex::MultiFab>& z_phys_nd,
33  const std::unique_ptr<amrex::MultiFab>& z_phys_cc,
34  const SolverChoice& solverChoice,
35  std::unique_ptr<SurfaceLayer>& SurfLayer,
36  const amrex::MultiFab* z_0,
37  const bool& use_terrain_fitted_coords,
38  const bool& use_moisture,
39  int level,
40  const amrex::BCRec* bc_ptr,
41  const eb_& ebfact,
42  bool vert_only = false,
43  const amrex::MultiFab* qheating_rates = nullptr);
44 
45 void
46 ComputeTurbulentViscosityLES (amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
47  const amrex::MultiFab& cons_in,
48  amrex::MultiFab& eddyViscosity,
49  amrex::MultiFab& Hfx1,
50  amrex::MultiFab& Hfx2,
51  amrex::MultiFab& Hfx3,
52  amrex::MultiFab& Diss,
53  const amrex::Geometry& geom,
54  bool use_terrain_fitted_coords,
55  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
56  const std::unique_ptr<amrex::MultiFab>& z_phys_nd,
57  const TurbChoice& turbChoice,
58  const amrex::Real const_grav,
59  std::unique_ptr<SurfaceLayer>& SurfLayer,
60  const MoistureComponentIndices& moisture_indices,
61  const amrex::MultiFab* xvel = nullptr,
62  const amrex::MultiFab* yvel = nullptr);
63 
64 void
65 ComputeTurbulentViscosityLES_EB (amrex::Vector<std::unique_ptr<amrex::MultiFab>>& Tau_lev,
66  const amrex::MultiFab& cons_in,
67  amrex::MultiFab& eddyViscosity,
68  amrex::MultiFab& Hfx1,
69  amrex::MultiFab& Hfx2,
70  amrex::MultiFab& Hfx3,
71  const amrex::Geometry& geom,
72  amrex::Vector<std::unique_ptr<amrex::MultiFab>>& mapfac,
73  const TurbChoice& turbChoice,
74  const amrex::Real const_grav,
75  const SolverChoice& solverChoice,
76  std::unique_ptr<SurfaceLayer>& SurfLayer,
77  const MoistureComponentIndices& moisture_indices,
78  const eb_& ebfact,
79  const amrex::MultiFab* xvel = nullptr,
80  const amrex::MultiFab* yvel = nullptr);
81 
82 AMREX_GPU_DEVICE
83 AMREX_FORCE_INLINE
85 ComputeSmnSmn (int& i, int& j, int& k,
86  const amrex::Array4<amrex::Real const>& tau11,
87  const amrex::Array4<amrex::Real const>& tau22,
88  const amrex::Array4<amrex::Real const>& tau33,
89  const amrex::Array4<amrex::Real const>& tau12,
90  const amrex::Array4<amrex::Real const>& tau13,
91  const amrex::Array4<amrex::Real const>& tau23)
92 {
93  amrex::Real s11bar = tau11(i,j,k);
94  amrex::Real s22bar = tau22(i,j,k);
95  amrex::Real s33bar = tau33(i,j,k);
96  amrex::Real s12bar = fourth * ( tau12(i , j , k ) + tau12(i , j+1, k )
97  + tau12(i+1, j , k ) + tau12(i+1, j+1, k ) );
98  amrex::Real s13bar = fourth * ( tau13(i , j , k ) + tau13(i , j , k+1)
99  + tau13(i+1, j , k ) + tau13(i+1, j , k+1) );
100  amrex::Real s23bar = fourth * ( tau23(i , j , k ) + tau23(i , j , k+1)
101  + tau23(i , j+1, k ) + tau23(i , j+1, k+1) );
102 
103  amrex::Real SmnSmn = s11bar*s11bar + s22bar*s22bar + s33bar*s33bar
104  + two*s12bar*s12bar + two*s13bar*s13bar + two*s23bar*s23bar;
105 
106  return SmnSmn;
107 }
108 
109 AMREX_GPU_DEVICE
110 AMREX_FORCE_INLINE
112 ComputeSmnSmn_EB (int& i, int& j, int& k,
113  const amrex::Array4<amrex::Real const>& tau11,
114  const amrex::Array4<amrex::Real const>& tau22,
115  const amrex::Array4<amrex::Real const>& tau33,
116  const amrex::Array4<amrex::Real const>& tau12,
117  const amrex::Array4<amrex::Real const>& tau13,
118  const amrex::Array4<amrex::Real const>& tau23,
119  const amrex::Array4<const amrex::EBCellFlag>& c_cflag,
120  const amrex::Array4<const amrex::EBCellFlag>& u_cflag,
121  const amrex::Array4<const amrex::EBCellFlag>& v_cflag,
122  const amrex::Array4<const amrex::EBCellFlag>& w_cflag)
123 {
124  amrex::Real SmnSmn = zero;
125  if (!c_cflag(i,j,k).isCovered()) {
126  amrex::Real s11bar = tau11(i,j,k);
127  amrex::Real s22bar = tau22(i,j,k);
128  amrex::Real s33bar = tau33(i,j,k);
129  amrex::Real s12bar = zero;
130  amrex::Real s13bar = zero;
131  amrex::Real s23bar = zero;
132 
133  amrex::Real count_s12 = zero;
134  if (!u_cflag(i,j,k).isCovered() || !v_cflag(i,j,k).isCovered()) {
135  s12bar += tau12(i,j,k);
136  count_s12 += one;
137  }
138  if (!u_cflag(i+1,j,k).isCovered() || !v_cflag(i,j,k).isCovered()) {
139  s12bar += tau12(i+1,j,k);
140  count_s12 += one;
141  }
142  if (!u_cflag(i,j,k).isCovered() || !v_cflag(i,j+1,k).isCovered()) {
143  s12bar += tau12(i,j+1,k);
144  count_s12 += one;
145  }
146  if (!u_cflag(i+1,j,k).isCovered() || !v_cflag(i,j+1,k).isCovered()) {
147  s12bar += tau12(i+1,j+1,k);
148  count_s12 += one;
149  }
150  if (count_s12 > zero) {
151  s12bar /= count_s12;
152  }
153 
154  amrex::Real count_s13 = zero;
155  if (!u_cflag(i,j,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
156  s13bar += tau13(i, j, k);
157  count_s13 += one;
158  }
159  if (!u_cflag(i,j,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
160  s13bar += tau13(i, j, k+1);
161  count_s13 += one;
162  }
163  if (!u_cflag(i+1,j,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
164  s13bar += tau13(i+1, j, k);
165  count_s13 += one;
166  }
167  if (!u_cflag(i+1,j,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
168  s13bar += tau13(i+1, j, k+1);
169  count_s13 += one;
170  }
171  if (count_s13 > zero) {
172  s13bar /= count_s13;
173  }
174 
175  amrex::Real count_s23 = zero;
176  if (!v_cflag(i,j,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
177  s23bar += tau23(i, j, k);
178  count_s23 += one;
179  }
180  if (!v_cflag(i,j,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
181  s23bar += tau23(i, j, k+1);
182  count_s23 += one;
183  }
184  if (!v_cflag(i,j+1,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
185  s23bar += tau23(i, j+1, k);
186  count_s23 += one;
187  }
188  if (!v_cflag(i,j+1,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
189  s23bar += tau23(i, j+1, k+1);
190  count_s23 += one;
191  }
192  if (count_s23 > zero) {
193  s23bar /= count_s23;
194  }
195 
196  SmnSmn = s11bar*s11bar + s22bar*s22bar + s33bar*s33bar
197  + two*s12bar*s12bar + two*s13bar*s13bar + two*s23bar*s23bar;
198  }
199 
200  return SmnSmn;
201 }
202 
203 AMREX_GPU_DEVICE
204 AMREX_FORCE_INLINE
206 ComputeSmnSmn2D (int& i, int& j, int& k,
207  const amrex::Array4<amrex::Real const>& tau11,
208  const amrex::Array4<amrex::Real const>& tau22,
209  const amrex::Array4<amrex::Real const>& tau12)
210 {
211  amrex::Real sdiff = tau11(i,j,k) - tau22(i,j,k);
212  amrex::Real s12bar = fourth * ( tau12(i , j , k ) + tau12(i , j+1, k )
213  + tau12(i+1, j , k ) + tau12(i+1, j+1, k ) );
214  return myhalf * sdiff*sdiff + two*s12bar*s12bar;
215 }
216 #endif
constexpr amrex::Real two
Definition: ERF_Constants.H:10
constexpr amrex::Real one
Definition: ERF_Constants.H:9
constexpr amrex::Real fourth
Definition: ERF_Constants.H:14
constexpr amrex::Real zero
Definition: ERF_Constants.H:8
constexpr amrex::Real myhalf
Definition: ERF_Constants.H:13
@ tau12
Definition: ERF_DataStruct.H:32
@ tau23
Definition: ERF_DataStruct.H:32
@ tau33
Definition: ERF_DataStruct.H:32
@ tau22
Definition: ERF_DataStruct.H:32
@ tau11
Definition: ERF_DataStruct.H:32
@ tau13
Definition: ERF_DataStruct.H:32
void ComputeTurbulentViscosity(double dt, const amrex::MultiFab &xvel, const amrex::MultiFab &yvel, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, amrex::MultiFab &cons_in, const amrex::MultiFab &wdist, amrex::MultiFab &eddyViscosity, amrex::MultiFab &Hfx1, amrex::MultiFab &Hfx2, amrex::MultiFab &Hfx3, amrex::MultiFab &Diss, const amrex::Geometry &geom, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const std::unique_ptr< amrex::MultiFab > &z_phys_nd, const std::unique_ptr< amrex::MultiFab > &z_phys_cc, const SolverChoice &solverChoice, std::unique_ptr< SurfaceLayer > &SurfLayer, const amrex::MultiFab *z_0, const bool &use_terrain_fitted_coords, const bool &use_moisture, int level, const amrex::BCRec *bc_ptr, const eb_ &ebfact, bool vert_only=false, const amrex::MultiFab *qheating_rates=nullptr)
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real ComputeSmnSmn2D(int &i, int &j, int &k, const amrex::Array4< amrex::Real const > &tau11, const amrex::Array4< amrex::Real const > &tau22, const amrex::Array4< amrex::Real const > &tau12)
Definition: ERF_EddyViscosity.H:206
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real ComputeSmnSmn_EB(int &i, int &j, int &k, const amrex::Array4< amrex::Real const > &tau11, const amrex::Array4< amrex::Real const > &tau22, const amrex::Array4< amrex::Real const > &tau33, const amrex::Array4< amrex::Real const > &tau12, const amrex::Array4< amrex::Real const > &tau13, const amrex::Array4< amrex::Real const > &tau23, const amrex::Array4< const amrex::EBCellFlag > &c_cflag, const amrex::Array4< const amrex::EBCellFlag > &u_cflag, const amrex::Array4< const amrex::EBCellFlag > &v_cflag, const amrex::Array4< const amrex::EBCellFlag > &w_cflag)
Definition: ERF_EddyViscosity.H:112
void ComputeTurbulentViscosityLES(amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, const amrex::MultiFab &cons_in, amrex::MultiFab &eddyViscosity, amrex::MultiFab &Hfx1, amrex::MultiFab &Hfx2, amrex::MultiFab &Hfx3, amrex::MultiFab &Diss, const amrex::Geometry &geom, bool use_terrain_fitted_coords, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const std::unique_ptr< amrex::MultiFab > &z_phys_nd, const TurbChoice &turbChoice, const amrex::Real const_grav, std::unique_ptr< SurfaceLayer > &SurfLayer, const MoistureComponentIndices &moisture_indices, const amrex::MultiFab *xvel=nullptr, const amrex::MultiFab *yvel=nullptr)
AMREX_GPU_DEVICE AMREX_FORCE_INLINE amrex::Real ComputeSmnSmn(int &i, int &j, int &k, const amrex::Array4< amrex::Real const > &tau11, const amrex::Array4< amrex::Real const > &tau22, const amrex::Array4< amrex::Real const > &tau33, const amrex::Array4< amrex::Real const > &tau12, const amrex::Array4< amrex::Real const > &tau13, const amrex::Array4< amrex::Real const > &tau23)
Definition: ERF_EddyViscosity.H:85
void ComputeTurbulentViscosityLES_EB(amrex::Vector< std::unique_ptr< amrex::MultiFab >> &Tau_lev, const amrex::MultiFab &cons_in, amrex::MultiFab &eddyViscosity, amrex::MultiFab &Hfx1, amrex::MultiFab &Hfx2, amrex::MultiFab &Hfx3, const amrex::Geometry &geom, amrex::Vector< std::unique_ptr< amrex::MultiFab >> &mapfac, const TurbChoice &turbChoice, const amrex::Real const_grav, const SolverChoice &solverChoice, std::unique_ptr< SurfaceLayer > &SurfLayer, const MoistureComponentIndices &moisture_indices, const eb_ &ebfact, const amrex::MultiFab *xvel=nullptr, const amrex::MultiFab *yvel=nullptr)
const bool use_moisture
Definition: ERF_InitCustomPert_Bomex.H:14
TurbChoice turbChoice
Definition: ERF_SetupVertDiff.H:6
amrex::Real Real
Definition: ERF_ShocInterface.H:19
Real z_0
Definition: ERF_UpdateWSubsidence_Bomex.H:10
Definition: ERF_EB.H:13
@ xvel
Definition: ERF_IndexDefines.H:176
@ yvel
Definition: ERF_IndexDefines.H:177
Definition: ERF_DataStruct.H:106
Definition: ERF_DataStruct.H:141
Definition: ERF_TurbStruct.H:82