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