#include <advectionDiffusionDynamics.h>

Inheritance diagram for olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >:

Collaboration diagram for olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >:

Public Types
using	MomentaF = typename MOMENTA::template type<DESCRIPTOR>

using	EquilibriumF = typename DYNAMICS::EquilibriumF

using	parameters = typename DYNAMICS::parameters

template<typename NEW_T >
using	exchange_value_type

template<typename M >
using	exchange_momenta = CombinedAdvectionDiffusionRLBdynamics<T,DESCRIPTOR,DYNAMICS,M>

Public Types inherited from olb::dynamics::CustomCollision< T, DESCRIPTOR, momenta::AdvectionDiffusionBulkTuple >
using	value_t

using	descriptor_t

using	MomentaF

Public Types inherited from olb::Dynamics< T, DESCRIPTOR >
using	value_t = T

using	descriptor_t = DESCRIPTOR

Public Member Functions
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.

template<typename CELL , typename PARAMETERS , typename V = typename CELL::value_t>
CellStatistic< V >	collide (CELL &cell, PARAMETERS &parameters) any_platform

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::string	getName () const override
	Return human-readable name.

Public Member Functions inherited from olb::dynamics::CustomCollision< T, DESCRIPTOR, momenta::AdvectionDiffusionBulkTuple >
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 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.

Detailed Description

template<typename T, typename DESCRIPTOR, typename DYNAMICS, typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>
class olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >

Definition at line 113 of file advectionDiffusionDynamics.h.

Member Typedef Documentation

◆ EquilibriumF

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

using olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::EquilibriumF = typename DYNAMICS::EquilibriumF

Definition at line 116 of file advectionDiffusionDynamics.h.

◆ exchange_momenta

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

template<typename M >

using olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::exchange_momenta = CombinedAdvectionDiffusionRLBdynamics<T,DESCRIPTOR,DYNAMICS,M>

Definition at line 128 of file advectionDiffusionDynamics.h.

◆ exchange_value_type

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

template<typename NEW_T >

using olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::exchange_value_type

Initial value:

 CombinedAdvectionDiffusionRLBdynamics<
    NEW_T, DESCRIPTOR,
    typename DYNAMICS::template exchange_value_type<NEW_T>,
    MOMENTA
  >

Definition at line 121 of file advectionDiffusionDynamics.h.

◆ MomentaF

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

using olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::MomentaF = typename MOMENTA::template type<DESCRIPTOR>

Definition at line 115 of file advectionDiffusionDynamics.h.

◆ parameters

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

using olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::parameters = typename DYNAMICS::parameters

Definition at line 118 of file advectionDiffusionDynamics.h.

Member Function Documentation

◆ collide()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

template<typename CELL , typename PARAMETERS , typename V = typename CELL::value_t>

CellStatistic< V > olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::collide	(	CELL &	cell,
		PARAMETERS &	parameters )

inline

Definition at line 139 of file advectionDiffusionDynamics.h.

                                                                            {
    V jNeq[DESCRIPTOR::d] { };
 
    const V rho = MomentaF().computeRho(cell);
    const auto u = cell.template getField<descriptors::VELOCITY>();
    MomentaF().computeJ(cell, jNeq);
 
    for (int iD = 0; iD < DESCRIPTOR::d; ++iD) {
      jNeq[iD] -= u[iD] * rho;
    }
 
    V fEq[DESCRIPTOR::q] { };
    EquilibriumF().compute(cell, rho, u, fEq);
    for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
      cell[iPop] = fEq[iPop] + equilibrium<DESCRIPTOR>::template fromJneqToFneq<V>(iPop, jNeq);
    }
 
    return typename DYNAMICS::CollisionO().apply(cell, parameters);
  };

◆ computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

void olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, 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 >.

Definition at line 159 of file advectionDiffusionDynamics.h.

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

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

Here is the call graph for this function:

◆ getName()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

std::string olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::getName ( ) const

inlineoverridevirtual

Return human-readable name.

Reimplemented from olb::Dynamics< T, DESCRIPTOR >.

Definition at line 165 of file advectionDiffusionDynamics.h.

                                     {
    return "CombinedAdvectionDiffusionRLBdynamics<" + MomentaF().getName() + ">";
  };

◆ getParameters()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

AbstractParameters< T, DESCRIPTOR > & olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::getParameters ( BlockLattice< T, DESCRIPTOR > & block )

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 134 of file advectionDiffusionDynamics.h.

                                                                                              {
    return block.template getData<OperatorParameters<CombinedAdvectionDiffusionRLBdynamics>>();
  }

◆ id()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>

std::type_index olb::CombinedAdvectionDiffusionRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::id ( )

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 130 of file advectionDiffusionDynamics.h.

                              {
    return typeid(CombinedAdvectionDiffusionRLBdynamics);
  };

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

src/dynamics/advectionDiffusionDynamics.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ EquilibriumF

◆ exchange_momenta

◆ exchange_value_type

◆ MomentaF

◆ parameters

Member Function Documentation

◆ collide()

◆ computeEquilibrium()

◆ getName()

◆ getParameters()

◆ id()