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