ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
Functions
ERF_EddyViscosity.H File Reference
#include "AMReX_BCRec.H"
#include "ERF_SurfaceLayer.H"
#include "ERF_DataStruct.H"
#include "ERF_IndexDefines.H"
#include "ERF_Constants.H"
#include "ERF_EOS.H"
#include "ERF_EB.H"
Include dependency graph for ERF_EddyViscosity.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

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)
 
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)
 
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)
 
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)
 
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)
 
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)
 

Function Documentation

◆ ComputeSmnSmn()

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 
)

Compute twice-contracted strain-rate magnitude from stress-like strain components.

Parameters
[in]icell-centered i-index
[in]jcell-centered j-index
[in]kcell-centered k-index
[in]tau1111 strain component
[in]tau2222 strain component
[in]tau3333 strain component
[in]tau1212 strain component
[in]tau1313 strain component
[in]tau2323 strain component
Returns
S_mn S_mn at cell centers
109 {
110  amrex::Real s11bar = tau11(i,j,k);
111  amrex::Real s22bar = tau22(i,j,k);
112  amrex::Real s33bar = tau33(i,j,k);
113  amrex::Real s12bar = fourth * ( tau12(i , j , k ) + tau12(i , j+1, k )
114  + tau12(i+1, j , k ) + tau12(i+1, j+1, k ) );
115  amrex::Real s13bar = fourth * ( tau13(i , j , k ) + tau13(i , j , k+1)
116  + tau13(i+1, j , k ) + tau13(i+1, j , k+1) );
117  amrex::Real s23bar = fourth * ( tau23(i , j , k ) + tau23(i , j , k+1)
118  + tau23(i , j+1, k ) + tau23(i , j+1, k+1) );
119 
120  amrex::Real SmnSmn = s11bar*s11bar + s22bar*s22bar + s33bar*s33bar
121  + two*s12bar*s12bar + two*s13bar*s13bar + two*s23bar*s23bar;
122 
123  return SmnSmn;
124 }
two
constexpr amrex::Real two
Definition: ERF_Constants.H:10
fourth
constexpr amrex::Real fourth
Definition: ERF_Constants.H:14
tau12
@ tau12
Definition: ERF_DataStruct.H:38
tau23
@ tau23
Definition: ERF_DataStruct.H:38
tau33
@ tau33
Definition: ERF_DataStruct.H:38
tau22
@ tau22
Definition: ERF_DataStruct.H:38
tau11
@ tau11
Definition: ERF_DataStruct.H:38
tau13
@ tau13
Definition: ERF_DataStruct.H:38
Real
amrex::Real Real
Definition: ERF_ShocInterface.H:19

Referenced by ComputeTurbulentViscosityLES(), ComputeTurbulentViscosityLES_EB(), and erf_make_tau_terms().

Here is the caller graph for this function:

◆ ComputeSmnSmn2D()

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 
)

Compute horizontal two-dimensional strain-rate magnitude.

Parameters
[in]icell-centered i-index
[in]jcell-centered j-index
[in]kcell-centered k-index
[in]tau1111 strain component
[in]tau2222 strain component
[in]tau1212 strain component
Returns
horizontal S_mn S_mn contribution
256 {
257  amrex::Real sdiff = tau11(i,j,k) - tau22(i,j,k);
258  amrex::Real s12bar = fourth * ( tau12(i , j , k ) + tau12(i , j+1, k )
259  + tau12(i+1, j , k ) + tau12(i+1, j+1, k ) );
260  return myhalf * sdiff*sdiff + two*s12bar*s12bar;
261 }
myhalf
constexpr amrex::Real myhalf
Definition: ERF_Constants.H:13

Referenced by ComputeTurbulentViscosityLES().

Here is the caller graph for this function:

◆ ComputeSmnSmn_EB()

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 
)

Compute twice-contracted strain-rate magnitude for embedded-boundary cells.

Parameters
[in]icell-centered i-index
[in]jcell-centered j-index
[in]kcell-centered k-index
[in]tau1111 strain component
[in]tau2222 strain component
[in]tau3333 strain component
[in]tau1212 strain component
[in]tau1313 strain component
[in]tau2323 strain component
[in]c_cflagcell-centered EB flags
[in]u_cflagx-face EB flags
[in]v_cflagy-face EB flags
[in]w_cflagz-face EB flags
Returns
S_mn S_mn at uncovered cell centers
158 {
159  amrex::Real SmnSmn = zero;
160  if (!c_cflag(i,j,k).isCovered()) {
161  amrex::Real s11bar = tau11(i,j,k);
162  amrex::Real s22bar = tau22(i,j,k);
163  amrex::Real s33bar = tau33(i,j,k);
164  amrex::Real s12bar = zero;
165  amrex::Real s13bar = zero;
166  amrex::Real s23bar = zero;
167 
168  amrex::Real count_s12 = zero;
169  if (!u_cflag(i,j,k).isCovered() || !v_cflag(i,j,k).isCovered()) {
170  s12bar += tau12(i,j,k);
171  count_s12 += one;
172  }
173  if (!u_cflag(i+1,j,k).isCovered() || !v_cflag(i,j,k).isCovered()) {
174  s12bar += tau12(i+1,j,k);
175  count_s12 += one;
176  }
177  if (!u_cflag(i,j,k).isCovered() || !v_cflag(i,j+1,k).isCovered()) {
178  s12bar += tau12(i,j+1,k);
179  count_s12 += one;
180  }
181  if (!u_cflag(i+1,j,k).isCovered() || !v_cflag(i,j+1,k).isCovered()) {
182  s12bar += tau12(i+1,j+1,k);
183  count_s12 += one;
184  }
185  if (count_s12 > zero) {
186  s12bar /= count_s12;
187  }
188 
189  amrex::Real count_s13 = zero;
190  if (!u_cflag(i,j,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
191  s13bar += tau13(i, j, k);
192  count_s13 += one;
193  }
194  if (!u_cflag(i,j,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
195  s13bar += tau13(i, j, k+1);
196  count_s13 += one;
197  }
198  if (!u_cflag(i+1,j,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
199  s13bar += tau13(i+1, j, k);
200  count_s13 += one;
201  }
202  if (!u_cflag(i+1,j,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
203  s13bar += tau13(i+1, j, k+1);
204  count_s13 += one;
205  }
206  if (count_s13 > zero) {
207  s13bar /= count_s13;
208  }
209 
210  amrex::Real count_s23 = zero;
211  if (!v_cflag(i,j,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
212  s23bar += tau23(i, j, k);
213  count_s23 += one;
214  }
215  if (!v_cflag(i,j,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
216  s23bar += tau23(i, j, k+1);
217  count_s23 += one;
218  }
219  if (!v_cflag(i,j+1,k).isCovered() || !w_cflag(i,j,k).isCovered()) {
220  s23bar += tau23(i, j+1, k);
221  count_s23 += one;
222  }
223  if (!v_cflag(i,j+1,k).isCovered() || !w_cflag(i,j,k+1).isCovered()) {
224  s23bar += tau23(i, j+1, k+1);
225  count_s23 += one;
226  }
227  if (count_s23 > zero) {
228  s23bar /= count_s23;
229  }
230 
231  SmnSmn = s11bar*s11bar + s22bar*s22bar + s33bar*s33bar
232  + two*s12bar*s12bar + two*s13bar*s13bar + two*s23bar*s23bar;
233  }
234 
235  return SmnSmn;
236 }
one
constexpr amrex::Real one
Definition: ERF_Constants.H:9
zero
constexpr amrex::Real zero
Definition: ERF_Constants.H:8

Referenced by ComputeTurbulentViscosityLES_EB().

Here is the caller graph for this function:

◆ ComputeTurbulentViscosity()

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 
)

Compute turbulent viscosity and related flux fields for the configured turbulence model.

◆ ComputeTurbulentViscosityLES()

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 
)

Compute LES turbulent viscosity, heat fluxes, and dissipation.

◆ ComputeTurbulentViscosityLES_EB()

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 
)

Compute LES turbulent viscosity and heat fluxes for embedded-boundary cells.