waLBerla 7.3
Loading...
Searching...
No Matches
walberla::lbm::collision_model::SRTField< OmegaField_T > Class Template Reference

#include <CollisionModel.h>

Public Types

using tag = SRT_tag

Public Member Functions

 SRTField ()
 SRTField (const BlockDataID &omegaFieldId, const uint_t _level=uint_t{0})
void setFieldId (const BlockDataID &omegaFieldId, const uint_t _level=uint_t{0})
void pack (mpi::SendBuffer &buffer) const
void unpack (mpi::RecvBuffer &buffer)
void configure (IBlock &block, StructuredBlockStorage &sbs)
void reset (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const real_t _omega, const uint_t _omega_level=uint_t{0})
 Only call this function if you know what you're doing (changes the viscosity!) "_omega_level" is the level that corresponds to "_omega".
real_t omega (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const Vector3< real_t > &=Vector3< real_t >(), const real_t=1_r) const
real_t viscosity (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z) const
uint_t level () const

Static Public Attributes

static const bool constant = false

Private Attributes

BlockDataID omegaFieldId_
OmegaField_T * omegaField_
uint_t level_

Member Typedef Documentation

◆ tag

template<typename OmegaField_T>
using walberla::lbm::collision_model::SRTField< OmegaField_T >::tag = SRT_tag

Constructor & Destructor Documentation

◆ SRTField() [1/2]

template<typename OmegaField_T>
walberla::lbm::collision_model::SRTField< OmegaField_T >::SRTField ( )
inline

◆ SRTField() [2/2]

template<typename OmegaField_T>
walberla::lbm::collision_model::SRTField< OmegaField_T >::SRTField ( const BlockDataID & omegaFieldId,
const uint_t _level = uint_t{0} )
inline

Member Function Documentation

◆ configure()

template<typename OmegaField_T>
void walberla::lbm::collision_model::SRTField< OmegaField_T >::configure ( IBlock & block,
StructuredBlockStorage & sbs )
inline

◆ level()

template<typename OmegaField_T>
uint_t walberla::lbm::collision_model::SRTField< OmegaField_T >::level ( ) const
inline

◆ omega()

template<typename OmegaField_T>
real_t walberla::lbm::collision_model::SRTField< OmegaField_T >::omega ( const cell_idx_t x,
const cell_idx_t y,
const cell_idx_t z,
const Vector3< real_t > & = Vector3<real_t>(),
const real_t = 1_r ) const
inline

◆ pack()

template<typename OmegaField_T>
void walberla::lbm::collision_model::SRTField< OmegaField_T >::pack ( mpi::SendBuffer & buffer) const
inline

◆ reset()

template<typename OmegaField_T>
void walberla::lbm::collision_model::SRTField< OmegaField_T >::reset ( const cell_idx_t x,
const cell_idx_t y,
const cell_idx_t z,
const real_t _omega,
const uint_t _omega_level = uint_t{0} )
inline

Only call this function if you know what you're doing (changes the viscosity!) "_omega_level" is the level that corresponds to "_omega".

◆ setFieldId()

template<typename OmegaField_T>
void walberla::lbm::collision_model::SRTField< OmegaField_T >::setFieldId ( const BlockDataID & omegaFieldId,
const uint_t _level = uint_t{0} )
inline

◆ unpack()

template<typename OmegaField_T>
void walberla::lbm::collision_model::SRTField< OmegaField_T >::unpack ( mpi::RecvBuffer & buffer)
inline

◆ viscosity()

template<typename OmegaField_T>
real_t walberla::lbm::collision_model::SRTField< OmegaField_T >::viscosity ( const cell_idx_t x,
const cell_idx_t y,
const cell_idx_t z ) const
inline

Member Data Documentation

◆ constant

template<typename OmegaField_T>
const bool walberla::lbm::collision_model::SRTField< OmegaField_T >::constant = false
static

◆ level_

template<typename OmegaField_T>
uint_t walberla::lbm::collision_model::SRTField< OmegaField_T >::level_
private

◆ omegaField_

template<typename OmegaField_T>
OmegaField_T* walberla::lbm::collision_model::SRTField< OmegaField_T >::omegaField_
private

◆ omegaFieldId_

template<typename OmegaField_T>
BlockDataID walberla::lbm::collision_model::SRTField< OmegaField_T >::omegaFieldId_
private

The documentation for this class was generated from the following file:
  • /builds/administration/walberla-website/walberla/src/lbm/lattice_model/CollisionModel.h