#include <interface.h>

Inheritance diagram for olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >:

Collaboration diagram for olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >:

Public Types
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

Public Member Functions
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::type_index	id ()=0
	Expose unique type-identifier for RTTI.

virtual std::string	getName () const
	Return human-readable name.

virtual AbstractParameters< T, DESCRIPTOR > &	getParameters (BlockLattice< T, DESCRIPTOR > &block)=0
	Parameters access for legacy post processors.

virtual CellStatistic< T >	collide (Cell< T, DESCRIPTOR > &cell)
	Perform purely-local collision step on Cell interface (legacy, to be deprecated)

virtual T	computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) const any_platform=0
	Return iPop equilibrium for given first and second momenta.

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 MOMENTA>
struct olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >

Definition at line 295 of file interface.h.

Member Typedef Documentation

◆ descriptor_t

template<typename T , typename DESCRIPTOR , typename MOMENTA >

using olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::descriptor_t = DESCRIPTOR

Definition at line 297 of file interface.h.

◆ MomentaF

template<typename T , typename DESCRIPTOR , typename MOMENTA >

using olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::MomentaF = typename MOMENTA::template type<DESCRIPTOR>

Definition at line 299 of file interface.h.

◆ value_t

template<typename T , typename DESCRIPTOR , typename MOMENTA >

using olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::value_t = T

Definition at line 296 of file interface.h.

Member Function Documentation

◆ computeAllMomenta()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::computeAllMomenta	(	ConstCell< T, DESCRIPTOR > &	cell,
		T &	rho,
		T	u[DESCRIPTOR::d],
		T	pi[util::TensorVal< DESCRIPTOR >::n] ) const

inlineoverridevirtual

Compute all momenta up to second order.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 321 of file interface.h.

                                                                                                     {
    MomentaF().computeAllMomenta(cell, rho, u, pi);
  };

◆ computeJ()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::computeJ	(	ConstCell< T, DESCRIPTOR > &	cell,
		T	j[DESCRIPTOR::d] ) const

inlineoverridevirtual

Compute fluid momentum.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 311 of file interface.h.

                                                                                {
    MomentaF().computeJ(cell, j);
  };

◆ computeRho()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

T olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::computeRho ( ConstCell< T, DESCRIPTOR > & cell ) const

inlineoverridevirtual

Compute particle density.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 305 of file interface.h.

                                                             {
    return MomentaF().computeRho(cell);
  };

◆ computeRhoU()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::computeRhoU	(	ConstCell< T, DESCRIPTOR > &	cell,
		T &	rho,
		T	u[DESCRIPTOR::d] ) const

inlineoverridevirtual

Compute fluid velocity and particle density.

Implements olb::Dynamics< T, DESCRIPTOR >.

Reimplemented in olb::ForcedVANSBGKdynamics< T, DESCRIPTOR, MOMENTA >, and olb::ForcedPSMBGKdynamics< T, DESCRIPTOR, MOMENTA >.

Definition at line 318 of file interface.h.

                                                                                           {
    MomentaF().computeRhoU(cell, rho, u);
  };

◆ computeStress()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::computeStress	(	ConstCell< T, DESCRIPTOR > &	cell,
		T	rho,
		const T	u[DESCRIPTOR::d],
		T	pi[util::TensorVal< DESCRIPTOR >::n] ) const

inlineoverridevirtual

Compute stress tensor.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 314 of file interface.h.

                                                                                                      {
    MomentaF().computeStress(cell, rho, u, pi);
  };

◆ computeU()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::computeU	(	ConstCell< T, DESCRIPTOR > &	cell,
		T	u[DESCRIPTOR::d] ) const

inlineoverridevirtual

Compute fluid velocity.

Implements olb::Dynamics< T, DESCRIPTOR >.

Reimplemented in olb::ForcedVANSBGKdynamics< T, DESCRIPTOR, MOMENTA >, and olb::ForcedPSMBGKdynamics< T, DESCRIPTOR, MOMENTA >.

Definition at line 308 of file interface.h.

                                                                                {
    MomentaF().computeU(cell, u);
  };

◆ defineAllMomenta()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::defineAllMomenta	(	Cell< T, DESCRIPTOR > &	cell,
		T	rho,
		const T	u[DESCRIPTOR::d],
		const T	pi[util::TensorVal< DESCRIPTOR >::n] )

inlineoverridevirtual

Define all momenta up to second order.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 335 of file interface.h.

                                                                                                         {
    MomentaF().defineAllMomenta(cell, rho, u, pi);
  };

◆ defineRho()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::defineRho	(	Cell< T, DESCRIPTOR > &	cell,
		T	rho )

inlineoverridevirtual

Set particle density.

Implements olb::Dynamics< T, DESCRIPTOR >.

Reimplemented in olb::opti::DualForcedBGKdynamics< T, DESCRIPTOR, MOMENTA >, and olb::opti::DualPorousBGKdynamics< T, DESCRIPTOR, MOMENTA >.

Definition at line 326 of file interface.h.

                                                           {
    MomentaF().defineRho(cell, rho);
  };

◆ defineRhoU()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::defineRhoU	(	Cell< T, DESCRIPTOR > &	cell,
		T	rho,
		const T	u[DESCRIPTOR::d] )

inlineoverridevirtual

Define fluid velocity and particle density.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 332 of file interface.h.

                                                                                    {
    MomentaF().defineRhoU(cell, rho, u);
  };

◆ defineU()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::defineU	(	Cell< T, DESCRIPTOR > &	cell,
		const T	u[DESCRIPTOR::d] )

inlineoverridevirtual

Set fluid velocity.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 329 of file interface.h.

                                                                          {
    MomentaF().defineU(cell, u);
  };

◆ initialize()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::initialize ( Cell< T, DESCRIPTOR > & cell )

inlineoverridevirtual

Initialize dynamics-specific data for cell.

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

Definition at line 301 of file interface.h.

                                                     {
    MomentaF().initialize(cell);
  };

◆ inverseShiftRhoU()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >::inverseShiftRhoU	(	ConstCell< T, DESCRIPTOR > &	cell,
		T &	rho,
		T	u[DESCRIPTOR::d] ) const

inlineoverridevirtual

Calculate population momenta s.t. the physical momenta are reproduced by the computeRhoU.

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

Definition at line 339 of file interface.h.

                                                                                                {
    MomentaF().inverseShiftRhoU(cell, rho, u);
  }

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

src/dynamics/interface.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ descriptor_t

◆ MomentaF

◆ value_t

Member Function Documentation

◆ computeAllMomenta()

◆ computeJ()

◆ computeRho()

◆ computeRhoU()

◆ computeStress()

◆ computeU()

◆ defineAllMomenta()

◆ defineRho()

◆ defineRhoU()

◆ defineU()

◆ initialize()

◆ inverseShiftRhoU()