olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA > Class Template Reference

This approach contains a slight error in the diffusion term. More...

#include <porousAdvectionDiffusionDynamics.h>

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

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

Public Types
template<typename M >
using	exchange_momenta = PorousAdvectionDiffusionBGKdynamics<T,DESCRIPTOR,M>
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

Public Member Functions
	PorousAdvectionDiffusionBGKdynamics (T omega, T tSolid)
	Constructor.
	PorousAdvectionDiffusionBGKdynamics (const UnitConverter< T, DESCRIPTOR > &converter, T tSolid)
T	computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) const override
	Compute equilibrium distribution function.
CellStatistic< T >	collide (Cell< T, DESCRIPTOR > &cell) override
	Collision step.
T	getOmega () const
	Get local relaxation parameter of the dynamics.
void	setOmega (T omega)
	Set local relaxation parameter of the dynamics.
Public Member Functions inherited from olb::legacy::BasicDynamics< T, DESCRIPTOR, 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.
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 = momenta::AdvectionDiffusionBulkTuple>
class olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >

This approach contains a slight error in the diffusion term.

Definition at line 40 of file porousAdvectionDiffusionDynamics.h.

Member Typedef Documentation

exchange_momenta

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

template<typename M >

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

Definition at line 43 of file porousAdvectionDiffusionDynamics.h.

Constructor & Destructor Documentation

PorousAdvectionDiffusionBGKdynamics() [1/2]

template<typename T , typename DESCRIPTOR , typename MOMENTA >

olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::PorousAdvectionDiffusionBGKdynamics	(	T	omega,
		T	tSolid )

Constructor.

Definition at line 46 of file porousAdvectionDiffusionDynamics.hh.

  : legacy::BasicDynamics<T, DESCRIPTOR, MOMENTA>( ),
    _omega(omega), _tSolid(tSolid)
{
  this->getName() = "PorousAdvectionDiffusionBGKdynamics";
}

References olb::Dynamics< T, DESCRIPTOR >::getName().

Here is the call graph for this function:

PorousAdvectionDiffusionBGKdynamics() [2/2]

template<typename T , typename DESCRIPTOR , typename MOMENTA >

olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::PorousAdvectionDiffusionBGKdynamics	(	const UnitConverter< T, DESCRIPTOR > &	converter,
		T	tSolid )

Definition at line 55 of file porousAdvectionDiffusionDynamics.hh.

  : legacy::BasicDynamics<T, DESCRIPTOR, MOMENTA>( ),
    _omega(converter.getLatticeRelaxationFrequency()), _tSolid(tSolid)
{
  this->getName() = "PorousAdvectionDiffusionBGKdynamics";
}

References olb::Dynamics< T, DESCRIPTOR >::getName().

Here is the call graph for this function:

Member Function Documentation

collide()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

CellStatistic< T > olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::collide ( Cell< T, DESCRIPTOR > & cell )

overridevirtual

Collision step.

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

Definition at line 73 of file porousAdvectionDiffusionDynamics.hh.

{
  T temperature = MomentaF().computeRho( cell );
 
  // apply temperature scaling
  auto porosity = cell.template getField<descriptors::POROSITY>();
  temperature = scaleTemp(temperature, porosity);
 
  auto u = cell.template getField<descriptors::VELOCITY>();
 
  T uSqr = lbm<DESCRIPTOR>::bgkCollision(cell, temperature, u, _omega);
 
  return {temperature, uSqr};
}

References olb::lbm< DESCRIPTOR >::bgkCollision().

Here is the call graph for this function:

computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

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

overridevirtual

Compute equilibrium distribution function.

Reimplemented from olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >.

Definition at line 64 of file porousAdvectionDiffusionDynamics.hh.

{
  // does temperature need to be considered here?
  return equilibrium<DESCRIPTOR>::firstOrder( iPop, rho, u );
}

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

Here is the call graph for this function:

getOmega()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

T olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::getOmega

(

)

const

Get local relaxation parameter of the dynamics.

Definition at line 89 of file porousAdvectionDiffusionDynamics.hh.

{
  return _omega;
}

setOmega()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::PorousAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >::setOmega

(

T

omega

)

Set local relaxation parameter of the dynamics.

Definition at line 95 of file porousAdvectionDiffusionDynamics.hh.

{
  _omega = omega;
}

---

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

• src/dynamics/porousAdvectionDiffusionDynamics.h
• src/dynamics/porousAdvectionDiffusionDynamics.hh