Models a density sink by enforcing a zero distribution on the cell. More...

#include <dynamics.h>

Inheritance diagram for olb::ZeroDistributionDynamics< T, DESCRIPTOR >:

Collaboration diagram for olb::ZeroDistributionDynamics< T, DESCRIPTOR >:

Public Types
using	parameters = meta::list<>

Public Types inherited from olb::dynamics::CustomCollision< T, DESCRIPTOR, momenta::Tuple< momenta::BulkDensity, momenta::ZeroMomentum, momenta::ZeroStress, momenta::DefineSeparately > >
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 >	apply (CELL &cell, PARAMETERS &parameters) any_platform

T	computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) const any_platform 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::BulkDensity, momenta::ZeroMomentum, momenta::ZeroStress, momenta::DefineSeparately > >
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>
struct olb::ZeroDistributionDynamics< T, DESCRIPTOR >

Models a density sink by enforcing a zero distribution on the cell.

Definition at line 343 of file dynamics.h.

Member Typedef Documentation

◆ parameters

template<typename T , typename DESCRIPTOR >

using olb::ZeroDistributionDynamics< T, DESCRIPTOR >::parameters = meta::list<>

Definition at line 352 of file dynamics.h.

Member Function Documentation

◆ apply()

template<typename T , typename DESCRIPTOR >

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

CellStatistic< V > olb::ZeroDistributionDynamics< T, DESCRIPTOR >::apply	(	CELL &	cell,
		PARAMETERS &	parameters )

inline

Definition at line 363 of file dynamics.h.

                                                                          {
    for (int iPop=0; iPop < DESCRIPTOR::q; ++iPop) {
      cell[iPop] = -descriptors::t<T,DESCRIPTOR>(iPop);
    }
    return {-1, -1};
  };

◆ computeEquilibrium()

template<typename T , typename DESCRIPTOR >

T olb::ZeroDistributionDynamics< T, DESCRIPTOR >::computeEquilibrium	(	int	iPop,
		T	rho,
		const T	u[DESCRIPTOR::d] ) const

inlineoverridevirtual

Return iPop equilibrium for given first and second momenta.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 370 of file dynamics.h.

                                                                                            {
    return 0;
  };

◆ getName()

template<typename T , typename DESCRIPTOR >

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

inlineoverridevirtual

Return human-readable name.

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

Definition at line 374 of file dynamics.h.

                                     {
    return "ZeroDistributionDynamics";
  };

◆ getParameters()

template<typename T , typename DESCRIPTOR >

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

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 358 of file dynamics.h.

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

◆ id()

template<typename T , typename DESCRIPTOR >

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

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 354 of file dynamics.h.

                              {
    return typeid(ZeroDistributionDynamics);
  };

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

src/dynamics/dynamics.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ parameters

Member Function Documentation

◆ apply()

◆ computeEquilibrium()

◆ getName()

◆ getParameters()

◆ id()