waLBerla 7.3
Loading...
Searching...
No Matches
walberla::lbm::ShearRate< LatticeModel_T > Struct Template Reference

#include <ShearRate.h>

Public Types

using Stencil = typename LatticeModel_T::Stencil
using ShearRelaxationParameter = typename internal::ShearRelaxationParameter<typename LatticeModel_T::CollisionModel>

Static Public Member Functions

template<typename FieldPtrOrIterator>
static real_t get (const LatticeModel_T &latticeModel, const FieldPtrOrIterator &it, const Vector3< real_t > &velocity, const real_t rho)
template<typename PdfField_T>
static real_t get (const LatticeModel_T &latticeModel, const PdfField_T &pdf, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const Vector3< real_t > &velocity, const real_t rho)
static real_t get (const std::vector< real_t > &nonEquilibrium, const real_t relaxationParam, const real_t rho=1_r)
 For incompressible LB you don't have to pass a value for 'rho' since for incompressible LB 'rho' is not used in this function!

Member Typedef Documentation

◆ ShearRelaxationParameter

template<typename LatticeModel_T>
using walberla::lbm::ShearRate< LatticeModel_T >::ShearRelaxationParameter = typename internal::ShearRelaxationParameter<typename LatticeModel_T::CollisionModel>

◆ Stencil

template<typename LatticeModel_T>
using walberla::lbm::ShearRate< LatticeModel_T >::Stencil = typename LatticeModel_T::Stencil

Member Function Documentation

◆ get() [1/3]

template<typename LatticeModel_T>
template<typename FieldPtrOrIterator>
real_t walberla::lbm::ShearRate< LatticeModel_T >::get ( const LatticeModel_T & latticeModel,
const FieldPtrOrIterator & it,
const Vector3< real_t > & velocity,
const real_t rho )
inlinestatic

◆ get() [2/3]

template<typename LatticeModel_T>
template<typename PdfField_T>
real_t walberla::lbm::ShearRate< LatticeModel_T >::get ( const LatticeModel_T & latticeModel,
const PdfField_T & pdf,
const cell_idx_t x,
const cell_idx_t y,
const cell_idx_t z,
const Vector3< real_t > & velocity,
const real_t rho )
inlinestatic

◆ get() [3/3]

template<typename LatticeModel_T>
real_t walberla::lbm::ShearRate< LatticeModel_T >::get ( const std::vector< real_t > & nonEquilibrium,
const real_t relaxationParam,
const real_t rho = 1_r )
inlinestatic

For incompressible LB you don't have to pass a value for 'rho' since for incompressible LB 'rho' is not used in this function!


The documentation for this struct was generated from the following file:
  • /builds/administration/walberla-website/walberla/src/lbm/field/ShearRate.h