Tuple of momenta components forming a moment system. More...

#include <interface.h>

Collaboration diagram for olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >:

Public Types
using	descriptor = DESCRIPTOR

using	type = ConcreteTuple

using	density = DENSITY

using	momentum = MOMENTUM

using	stress = STRESS

using	definition = DefinitionRule

using	abstract = Tuple<DENSITY,MOMENTUM,STRESS,DefinitionRule>

Public Member Functions
template<concepts::Cell CELL, typename V = typename CELL::value_t>
V	computeRho (CELL &cell) const any_platform

template<concepts::Cell CELL, typename U >
void	computeU (CELL &cell, U &u) const any_platform

template<concepts::Cell CELL, typename J >
void	computeJ (CELL &cell, J &j) const any_platform

template<concepts::Cell CELL, typename RHO , typename U , typename PI >
void	computeStress (CELL &cell, const RHO &rho, const U &u, PI &pi) const any_platform

template<concepts::Cell CELL, typename PI , typename V = typename CELL::value_t>
void	computeStress (CELL &cell, PI &pi) const any_platform

template<concepts::Cell CELL, typename RHO , typename J >
void	computeRhoJ (CELL &cell, RHO &rho, J &j) const any_platform

template<concepts::Cell CELL, typename RHO , typename U >
void	computeRhoU (CELL &cell, RHO &rho, U &u) const any_platform

template<concepts::Cell CELL, typename RHO , typename U , typename PI >
void	computeAllMomenta (CELL &cell, RHO &rho, U &u, PI &pi) const any_platform

template<concepts::Cell CELL, typename PINEQNORMSQR , typename V = typename CELL::value_t>
void	computePiNeqNormSqr (CELL &cell, PINEQNORMSQR &piNeqNormSqr) const any_platform

template<concepts::Cell CELL, typename RHO >
void	defineRho (CELL &cell, const RHO &rho) any_platform

template<concepts::Cell CELL, typename U >
void	defineU (CELL &cell, const U &u) any_platform

template<concepts::Cell CELL, typename RHO , typename U >
void	defineRhoU (CELL &cell, const RHO &rho, const U &u) any_platform

template<concepts::Cell CELL, typename RHO , typename U , typename PI >
void	defineAllMomenta (CELL &cell, const RHO &rho, const U &u, const PI &pi) any_platform

template<typename CELL >
void	initialize (CELL &cell)

template<concepts::Cell CELL, typename RHO >
void	inverseShiftRho (CELL &cell, RHO &rho) any_platform

template<concepts::Cell CELL, typename U >
void	inverseShiftU (CELL &cell, U &u) any_platform

template<concepts::Cell CELL, typename RHO , typename U >
void	inverseShiftRhoU (CELL &cell, RHO &rho, U &u) any_platform

std::string	getName () const

Detailed Description

template<typename DESCRIPTOR, typename DENSITY, typename MOMENTUM, typename STRESS, typename DefinitionRule>
struct olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >

Tuple of momenta components forming a moment system.

Momenta are reduced on their components DENSITY, MOMETUM, STRESS A generic momenta tuple consists of single "submomenta" (0th moment = density, 1st velocity, 2nd moment = stress). These give a rule how to compute a certain moment and how to set the corresponding data, e.g. a velocity field, in case that this is necessary. DefinitionRule describes how to modify the momenta, e.g. the populations could be transformed to a new equilibrium or non-equilibrium state.

Definition at line 95 of file interface.h.

Member Typedef Documentation

◆ abstract

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::abstract = Tuple<DENSITY,MOMENTUM,STRESS,DefinitionRule>

Definition at line 103 of file interface.h.

◆ definition

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::definition = DefinitionRule

Definition at line 101 of file interface.h.

◆ density

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::density = DENSITY

Definition at line 98 of file interface.h.

◆ descriptor

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::descriptor = DESCRIPTOR

Definition at line 96 of file interface.h.

◆ momentum

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::momentum = MOMENTUM

Definition at line 99 of file interface.h.

◆ stress

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::stress = STRESS

Definition at line 100 of file interface.h.

◆ type

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

using olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::type = ConcreteTuple

Definition at line 97 of file interface.h.

Member Function Documentation

◆ computeAllMomenta()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename U , typename PI >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeAllMomenta	(	CELL &	cell,
		RHO &	rho,
		U &	u,
		PI &	pi ) const

inline

Definition at line 157 of file interface.h.

  {
    computeRhoU(cell, rho, u);
    STRESS().template compute<type>(cell, rho, u, pi);
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeRhoU().

Here is the call graph for this function:

◆ computeJ()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename J >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeJ	(	CELL &	cell,
		J &	j ) const

inline

Definition at line 120 of file interface.h.

  {
    MOMENTUM().template compute<type>(cell, j);
  }

◆ computePiNeqNormSqr()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename PINEQNORMSQR , typename V = typename CELL::value_t>

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computePiNeqNormSqr	(	CELL &	cell,
		PINEQNORMSQR &	piNeqNormSqr ) const

inline

Definition at line 164 of file interface.h.

  {
    V rho, u[DESCRIPTOR::d], pi[util::TensorVal<DESCRIPTOR>::n] { };
    computeRhoU(cell, rho, u);
    STRESS().template compute<type>(cell, rho, u, pi);
    piNeqNormSqr = pi[0]*pi[0] + 2.*pi[1]*pi[1] + pi[2]*pi[2];
    if constexpr (util::TensorVal<DESCRIPTOR>::n == 6) {
      piNeqNormSqr += pi[2]*pi[2] + pi[3]*pi[3] + 2.*pi[4]*pi[4] +pi[5]*pi[5];
    }
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeRhoU().

Here is the call graph for this function:

◆ computeRho()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename V = typename CELL::value_t>

V olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeRho ( CELL & cell ) const

inline

Definition at line 106 of file interface.h.

  {
    V rho{};
    DENSITY().template compute<type>(cell, rho);
    return rho;
  }

◆ computeRhoJ()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename J >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeRhoJ	(	CELL &	cell,
		RHO &	rho,
		J &	j ) const

inline

Definition at line 144 of file interface.h.

  {
    DENSITY().template compute<type>(cell, rho);
    MOMENTUM().template compute<type>(cell, j);
  }

◆ computeRhoU()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename U >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeRhoU	(	CELL &	cell,
		RHO &	rho,
		U &	u ) const

inline

Definition at line 151 of file interface.h.

  {
    ComputeRhoU<type,DENSITY,MOMENTUM>()(cell, rho, u);
  }

Here is the caller graph for this function:

◆ computeStress() [1/2]

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename U , typename PI >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeStress	(	CELL &	cell,
		const RHO &	rho,
		const U &	u,
		PI &	pi ) const

inline

Definition at line 128 of file interface.h.

  {
    STRESS().template compute<type>(cell, rho, u, pi);
  }

◆ computeStress() [2/2]

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename PI , typename V = typename CELL::value_t>

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeStress	(	CELL &	cell,
		PI &	pi ) const

inline

Definition at line 136 of file interface.h.

  {
    V rho, u[DESCRIPTOR::d];
    computeRhoU(cell, rho, u);
    STRESS().template compute<type>(cell, rho, u, pi);
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeRhoU().

Here is the call graph for this function:

◆ computeU()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename U >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeU	(	CELL &	cell,
		U &	u ) const

inline

Definition at line 114 of file interface.h.

  {
    MOMENTUM().template computeU<type>(cell, u);
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::computeU().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defineAllMomenta()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename U , typename PI >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineAllMomenta	(	CELL &	cell,
		const RHO &	rho,
		const U &	u,
		const PI &	pi )

inline

Definition at line 212 of file interface.h.

  {
    DENSITY().template define<type>(cell, rho);
    MOMENTUM().template define<type>(cell, u);
 
    RHO rhoShift = rho;
    using U_ARITH = std::remove_const_t<std::remove_pointer_t<std::remove_extent_t<U>>>;
    U_ARITH uShift[DESCRIPTOR::d];
    util::copyN(uShift, u, DESCRIPTOR::d);
    inverseShiftRhoU(cell, rhoShift, uShift);
    DefinitionRule().template defineAllMomenta<type>(cell, rhoShift, uShift, pi);
  }

References olb::util::copyN(), olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineAllMomenta(), and olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftRhoU().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defineRho()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineRho	(	CELL &	cell,
		const RHO &	rho )

inline

Definition at line 176 of file interface.h.

  {
    DENSITY().template define<type>(cell, rho);
 
    RHO rhoShift = rho;
    inverseShiftRho(cell, rhoShift);
    DefinitionRule().template defineRho<type>(cell, rho);
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineRho(), and olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftRho().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defineRhoU()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename U >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineRhoU	(	CELL &	cell,
		const RHO &	rho,
		const U &	u )

inline

Definition at line 198 of file interface.h.

  {
    DENSITY().template define<type>(cell, rho);
    MOMENTUM().template define<type>(cell, u);
 
    RHO rhoShift = rho;
    using U_ARITH = std::remove_const_t<std::remove_pointer_t<std::remove_extent_t<U>>>;
    U_ARITH uShift[DESCRIPTOR::d];
    util::copyN(uShift, u, DESCRIPTOR::d);
    inverseShiftRhoU(cell, rhoShift, uShift);
    DefinitionRule().template defineRhoU<type>(cell, rhoShift, uShift);
  }

References olb::util::copyN(), olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineRhoU(), and olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftRhoU().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defineU()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename U >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineU	(	CELL &	cell,
		const U &	u )

inline

Definition at line 186 of file interface.h.

  {
    MOMENTUM().template define<type>(cell, u);
 
    using U_ARITH = std::remove_const_t<std::remove_pointer_t<std::remove_extent_t<U>>>;
    U_ARITH uShift[DESCRIPTOR::d];
    util::copyN(uShift, u, DESCRIPTOR::d);
    inverseShiftU(cell, uShift);
    DefinitionRule().template defineU<type>(cell, u);
  }

References olb::util::copyN(), olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::defineU(), and olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftU().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getName()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

std::string olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::getName ( ) const

inline

Definition at line 251 of file interface.h.

  {
    return "Momenta<"
      + density().getName() + ","
      + momentum().getName() + ","
      + stress().getName() + ","
      + definition().getName() +
    ">";
  }

◆ initialize()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<typename CELL >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::initialize ( CELL & cell )

inline

Definition at line 226 of file interface.h.

  {
    DENSITY().template initialize<type>(cell);
    MOMENTUM().template initialize<type>(cell);
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inverseShiftRho()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftRho	(	CELL &	cell,
		RHO &	rho )

inline

Definition at line 233 of file interface.h.

  {
    DENSITY().template inverseShift<type>(cell, rho);
  }

Here is the caller graph for this function:

◆ inverseShiftRhoU()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename RHO , typename U >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftRhoU	(	CELL &	cell,
		RHO &	rho,
		U &	u )

inline

Definition at line 245 of file interface.h.

  {
    inverseShiftRho(cell, rho);
    inverseShiftU(cell, u);
  }

References olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftRho(), and olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftU().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inverseShiftU()

template<typename DESCRIPTOR , typename DENSITY , typename MOMENTUM , typename STRESS , typename DefinitionRule >

template<concepts::Cell CELL, typename U >

void olb::momenta::ConcreteTuple< DESCRIPTOR, DENSITY, MOMENTUM, STRESS, DefinitionRule >::inverseShiftU	(	CELL &	cell,
		U &	u )

inline

Definition at line 239 of file interface.h.

  {
    MOMENTUM().template inverseShift<type>(cell, u);
  }

Here is the caller graph for this function:

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

src/dynamics/momenta/interface.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ abstract

◆ definition

◆ density

◆ descriptor

◆ momentum

◆ stress

◆ type

Member Function Documentation

◆ computeAllMomenta()

◆ computeJ()

◆ computePiNeqNormSqr()

◆ computeRho()

◆ computeRhoJ()

◆ computeRhoU()

◆ computeStress() [1/2]

◆ computeStress() [2/2]

◆ computeU()

◆ defineAllMomenta()

◆ defineRho()

◆ defineRhoU()

◆ defineU()

◆ getName()

◆ initialize()

◆ inverseShiftRho()

◆ inverseShiftRhoU()

◆ inverseShiftU()