olb::momenta::DefineToNEq Struct Reference

When momenta are changed, the equilibrium part of the population is modified while the non-equilibrium part is kept. More...

#include <definitionRule.h>

Collaboration diagram for olb::momenta::DefineToNEq:

Public Member Functions
template<typename TYPE , typename CELL , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineRho (CELL &cell, V rho) any_platform
template<typename TYPE , typename CELL , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineU (CELL &cell, const V u[DESCRIPTOR::d]) any_platform
template<typename TYPE , typename CELL , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineRhoU (CELL &cell, V rho, const V u[DESCRIPTOR::d]) any_platform
template<typename TYPE , typename CELL , typename V = typename CELL::value_t, typename DESCRIPTOR = typename CELL::descriptor_t>
void	defineAllMomenta (CELL &cell, V rho, const V u[DESCRIPTOR::d], const V pi[util::TensorVal< DESCRIPTOR >::n]) any_platform

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

Detailed Description

When momenta are changed, the equilibrium part of the population is modified while the non-equilibrium part is kept.

Definition at line 96 of file definitionRule.h.

Member Function Documentation

defineAllMomenta()

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

void olb::momenta::DefineToNEq::defineAllMomenta ( CELL & cell, V rho, const V u[DESCRIPTOR::d], const V pi[util::TensorVal< DESCRIPTOR >::n] )

inline

Definition at line 133 of file definitionRule.h.

  {
    lbm<DESCRIPTOR>::defineNEqFromPi(cell, rho, u, pi);
  }

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

Here is the call graph for this function:

Here is the caller graph for this function:

defineRho()

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

void olb::momenta::DefineToNEq::defineRho ( CELL & cell, V rho )

inline

Definition at line 98 of file definitionRule.h.

  {
    // get old equilibrium data (oldRho, u)
    V oldRho, u[DESCRIPTOR::d];
    TYPE().computeRhoU(cell, oldRho, u);
    TYPE().inverseShiftRhoU(cell, oldRho, u);
 
    // modify the equilibrium part of the population from (oldRho, u) to (rho, u)
    lbm<DESCRIPTOR>::defineNEq(cell, oldRho, u, rho, u);
  }

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

Here is the call graph for this function:

Here is the caller graph for this function:

defineRhoU()

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

void olb::momenta::DefineToNEq::defineRhoU ( CELL & cell, V rho, const V u[DESCRIPTOR::d] )

inline

Definition at line 122 of file definitionRule.h.

  {
    V oldRho, oldU[DESCRIPTOR::d];
    TYPE().computeRhoU(cell, oldRho, oldU);
    TYPE().inverseShiftRhoU(cell, oldRho, oldU);
 
    lbm<DESCRIPTOR>::defineNEq(cell, oldRho, oldU, rho, u);
  }

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

Here is the call graph for this function:

defineU()

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

void olb::momenta::DefineToNEq::defineU ( CELL & cell, const V u[DESCRIPTOR::d] )

inline

Definition at line 110 of file definitionRule.h.

  {
    // get old equilibrium data (rho, oldU)
    V rho, oldU[DESCRIPTOR::d];
    TYPE().computeRhoU(cell, rho, oldU);
    TYPE().inverseShiftRhoU(cell, rho, oldU);
 
    // modify the equilibrium part of the population from (rho, oldU) to (rho, u)
    lbm<DESCRIPTOR>::defineNEq(cell, rho, oldU, rho, u);
  }

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

Here is the call graph for this function:

getName()

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

inlinestatic

Definition at line 140 of file definitionRule.h.

                            {
    return "DefineToNEq";
  }

---

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

• src/dynamics/momenta/definitionRule.h