olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA > Struct Template Reference

#include <dynamics.h>

Inheritance diagram for olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >:

Collaboration diagram for olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >:

Public Member Functions
void	computeEquilibrium (ConstCell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d], T fEq[DESCRIPTOR::q]) const override
	Return iPop equilibrium for given first and second momenta.
std::type_index	id () override
	Expose unique type-identifier for RTTI.
AbstractParameters< T, DESCRIPTOR > &	getParameters (BlockLattice< T, DESCRIPTOR > &block) override
	Parameters access for legacy post processors.
Public Member Functions inherited from olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >
void	initialize (Cell< T, DESCRIPTOR > &cell) override
	Initialize dynamics-specific data for cell.
T	computeRho (ConstCell< T, DESCRIPTOR > &cell) const override
	Compute particle density.
void	computeU (ConstCell< T, DESCRIPTOR > &cell, T u[DESCRIPTOR::d]) const override
	Compute fluid velocity.
void	computeJ (ConstCell< T, DESCRIPTOR > &cell, T j[DESCRIPTOR::d]) const override
	Compute fluid momentum.
void	computeStress (ConstCell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d], T pi[util::TensorVal< DESCRIPTOR >::n]) const override
	Compute stress tensor.
void	computeRhoU (ConstCell< T, DESCRIPTOR > &cell, T &rho, T u[DESCRIPTOR::d]) const override
	Compute fluid velocity and particle density.
void	computeAllMomenta (ConstCell< T, DESCRIPTOR > &cell, T &rho, T u[DESCRIPTOR::d], T pi[util::TensorVal< DESCRIPTOR >::n]) const override
	Compute all momenta up to second order.
void	defineRho (Cell< T, DESCRIPTOR > &cell, T rho) override
	Set particle density.
void	defineU (Cell< T, DESCRIPTOR > &cell, const T u[DESCRIPTOR::d]) override
	Set fluid velocity.
void	defineRhoU (Cell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d]) override
	Define fluid velocity and particle density.
void	defineAllMomenta (Cell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d], const T pi[util::TensorVal< DESCRIPTOR >::n]) override
	Define all momenta up to second order.
void	inverseShiftRhoU (ConstCell< T, DESCRIPTOR > &cell, T &rho, T u[DESCRIPTOR::d]) const override
	Calculate population momenta s.t. the physical momenta are reproduced by the computeRhoU.
Public Member Functions inherited from olb::Dynamics< T, DESCRIPTOR >
virtual	~Dynamics () any_platform
virtual std::string	getName () const
	Return human-readable name.
virtual CellStatistic< T >	collide (Cell< T, DESCRIPTOR > &cell)
	Perform purely-local collision step on Cell interface (legacy, to be deprecated)
void	iniEquilibrium (Cell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d])
	Initialize to equilibrium distribution.
void	iniRegularized (Cell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d], const T pi[util::TensorVal< DESCRIPTOR >::n])
	Initialize cell to equilibrium and non-equilibrum part.

Additional Inherited Members
Public Types inherited from olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >
using	value_t = T
using	descriptor_t = DESCRIPTOR
using	MomentaF = typename MOMENTA::template type<DESCRIPTOR>
Public Types inherited from olb::Dynamics< T, DESCRIPTOR >
using	value_t = T
using	descriptor_t = DESCRIPTOR

Detailed Description

template<typename T, typename DESCRIPTOR, typename MOMENTA>
struct olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >

Definition at line 35 of file dynamics.h.

Member Function Documentation

computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >::computeEquilibrium ( ConstCell< T, DESCRIPTOR > & cell, T rho, const T u[DESCRIPTOR::d], T fEq[DESCRIPTOR::q] ) const

inlineoverridevirtual

Return iPop equilibrium for given first and second momenta.

Implements olb::Dynamics< T, DESCRIPTOR >.

Reimplemented in olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >, and olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >.

Definition at line 36 of file dynamics.h.

                                                                                                                           {
    for ( int iPop = 0; iPop < DESCRIPTOR::q; iPop++ ) {
      fEq[iPop] = equilibrium<DESCRIPTOR>::secondOrder(iPop, rho, u);
    }
  };

References olb::equilibrium< DESCRIPTOR >::secondOrder().

Here is the call graph for this function:

getParameters()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

AbstractParameters< T, DESCRIPTOR > & olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >::getParameters ( BlockLattice< T, DESCRIPTOR > & block )

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Reimplemented in olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >, and olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >.

Definition at line 46 of file dynamics.h.

                                                                                              {
    throw std::bad_function_call();
  }

id()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

std::type_index olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >::id ( )

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Reimplemented in olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >, and olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >.

Definition at line 42 of file dynamics.h.

                              {
    return typeid(BasicDynamics<T,DESCRIPTOR,MOMENTA>);
  }

---

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

• src/dynamics/legacy/dynamics.h