olb::momenta::DefineToEq Struct Reference

When momenta are changed, a new equilibrium state is set. More...

#include <definitionRule.h>

Collaboration diagram for olb::momenta::DefineToEq:

Public Member Functions
template<typename TYPE , typename CELL , typename RHO , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineRho (CELL &cell, const RHO &rho) any_platform
template<typename TYPE , typename CELL , typename U , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineU (CELL &cell, const U &u) any_platform
template<typename TYPE , typename CELL , typename RHO , typename U , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineRhoU (CELL &cell, const RHO &rho, const U &u) any_platform
template<typename TYPE , typename CELL , typename RHO , typename U , typename PI , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineAllMomenta (CELL &cell, const RHO &rho, const U &u, const PI &pi) any_platform

Static Public Member Functions
static std::string	getName ()

Detailed Description

When momenta are changed, a new equilibrium state is set.

This struct is specific for advection-diffusion applications since it applies the external field descriptors::VELOCITY directly.

Definition at line 60 of file definitionRule.h.

Member Function Documentation

defineAllMomenta()

template<typename TYPE , typename CELL , typename RHO , typename U , typename PI , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>

void olb::momenta::DefineToEq::defineAllMomenta ( CELL & cell, const RHO & rho, const U & u, const PI & pi )

inline

Definition at line 83 of file definitionRule.h.

  {
    defineRho<TYPE>(cell, rho);
  }

defineRho()

template<typename TYPE , typename CELL , typename RHO , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>

void olb::momenta::DefineToEq::defineRho ( CELL & cell, const RHO & rho )

inline

Definition at line 62 of file definitionRule.h.

  {
    // get fluid velocity u
    const auto u = cell.template getField<descriptors::VELOCITY>();
 
    // set new equilibrium state with rho and u
    lbm<DESCRIPTOR>::defineEqFirstOrder(cell, rho, u);
  }

References olb::lbm< DESCRIPTOR >::defineEqFirstOrder().

Here is the call graph for this function:

defineRhoU()

template<typename TYPE , typename CELL , typename RHO , typename U , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>

void olb::momenta::DefineToEq::defineRhoU ( CELL & cell, const RHO & rho, const U & u )

inline

Definition at line 76 of file definitionRule.h.

  {
    defineRho<TYPE>(cell, rho);
  }

defineU()

template<typename TYPE , typename CELL , typename U , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>

void olb::momenta::DefineToEq::defineU ( CELL & cell, const U & u )

inline

Definition at line 72 of file definitionRule.h.

  { }

getName()

static std::string olb::momenta::DefineToEq::getName ( )

inlinestatic

Definition at line 89 of file definitionRule.h.

                            {
    return "DefineToEq";
  }

---

The documentation for this struct was generated from the following file:

• src/dynamics/momenta/definitionRule.h