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 
)
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 }
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:32
tau23
@ tau23
Definition: ERF_DataStruct.H:32
tau33
@ tau33
Definition: ERF_DataStruct.H:32
tau22
@ tau22
Definition: ERF_DataStruct.H:32
tau11
@ tau11
Definition: ERF_DataStruct.H:32
tau13
@ tau13
Definition: ERF_DataStruct.H:32
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 
)
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 }
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 
)
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 }
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 
)

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

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