#include <advectionDiffusionDynamics.h>

Inheritance diagram for olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >:

Collaboration diagram for olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >:

Public Types
using	MomentaF

using	EquilibriumF = typename equilibria::FirstOrder::template type<DESCRIPTOR,MOMENTA>

using	parameters = meta::list<descriptors::OMEGA>

template<typename NEW_T >
using	exchange_value_type = SourcedLimitedAdvectionDiffusionBGKdynamics<NEW_T,DESCRIPTOR,MOMENTA>

template<typename M >
using	exchange_momenta = SourcedLimitedAdvectionDiffusionBGKdynamics<T,DESCRIPTOR,M>

Public Types inherited from olb::dynamics::CustomCollision< T, DESCRIPTOR, momenta::Tuple< momenta::SourcedDensity< momenta::AdvectionDiffusionBulkTuple::density >, momenta::AdvectionDiffusionBulkTuple::momentum, momenta::AdvectionDiffusionBulkTuple::stress, momenta::AdvectionDiffusionBulkTuple::definition > >
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::Tuple< momenta::SourcedDensity< momenta::AdvectionDiffusionBulkTuple::density >, momenta::AdvectionDiffusionBulkTuple::momentum, momenta::AdvectionDiffusionBulkTuple::stress, momenta::AdvectionDiffusionBulkTuple::definition > >
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.

Static Public Attributes
static constexpr bool	is_vectorizable = false

Detailed Description

template<typename T, typename DESCRIPTOR, typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>
struct olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >

Definition at line 269 of file advectionDiffusionDynamics.h.

Member Typedef Documentation

◆ EquilibriumF

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

using olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::EquilibriumF = typename equilibria::FirstOrder::template type<DESCRIPTOR,MOMENTA>

Definition at line 284 of file advectionDiffusionDynamics.h.

◆ exchange_momenta

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

template<typename M >

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

Definition at line 294 of file advectionDiffusionDynamics.h.

◆ exchange_value_type

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

template<typename NEW_T >

using olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::exchange_value_type = SourcedLimitedAdvectionDiffusionBGKdynamics<NEW_T,DESCRIPTOR,MOMENTA>

Definition at line 291 of file advectionDiffusionDynamics.h.

◆ MomentaF

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

using olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::MomentaF

Initial value:

 typename momenta::Tuple<
    momenta::SourcedDensity<typename MOMENTA::density>,
    typename MOMENTA::momentum,
    typename MOMENTA::stress,
    typename MOMENTA::definition
  >::template type<DESCRIPTOR>

Definition at line 278 of file advectionDiffusionDynamics.h.

◆ parameters

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

using olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::parameters = meta::list<descriptors::OMEGA>

Definition at line 286 of file advectionDiffusionDynamics.h.

Member Function Documentation

◆ collide()

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

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

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

inline

Definition at line 305 of file advectionDiffusionDynamics.h.

                                                                            {
    const auto u = cell.template getField<descriptors::VELOCITY>();
    V temperature = MomentaF().computeRho(cell);
    if (temperature < V{1.e-8}) temperature = V{1.e-8};
    const V omega = cell.template getField<descriptors::OMEGA>();
 
    const V uSqr = lbm<DESCRIPTOR>::adeBgkCollision(cell, temperature, u, omega);
    const V sourceMod = cell.template getField<descriptors::SOURCE>() * (V{1} - V{0.5} * omega);
 
    for ( int iPop = 0; iPop < DESCRIPTOR::q; iPop++ ) {
      cell[iPop] += sourceMod * descriptors::t<T,DESCRIPTOR>(iPop);
    }
 
    return {temperature, uSqr};
  };

References olb::lbm< DESCRIPTOR >::adeBgkCollision(), and olb::descriptors::t().

Here is the call graph for this function:

◆ computeEquilibrium()

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

void olb::SourcedLimitedAdvectionDiffusionBGKdynamics< 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 >.

Definition at line 321 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 MOMENTA = momenta::AdvectionDiffusionBulkTuple>

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

inlineoverridevirtual

Return human-readable name.

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

Definition at line 327 of file advectionDiffusionDynamics.h.

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

◆ getParameters()

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

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

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 300 of file advectionDiffusionDynamics.h.

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

◆ id()

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

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

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 296 of file advectionDiffusionDynamics.h.

                              {
    return typeid(SourcedLimitedAdvectionDiffusionBGKdynamics);
  };

Member Data Documentation

◆ is_vectorizable

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

bool olb::SourcedLimitedAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::is_vectorizable = false

staticconstexpr

Definition at line 288 of file advectionDiffusionDynamics.h.

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

src/dynamics/advectionDiffusionDynamics.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ EquilibriumF

◆ exchange_momenta

◆ exchange_value_type

◆ MomentaF

◆ parameters

Member Function Documentation

◆ collide()

◆ computeEquilibrium()

◆ getName()

◆ getParameters()

◆ id()

Member Data Documentation

◆ is_vectorizable