Solves RTE according Christopher McHardy et al 2016. More...

#include <rtlbmDynamics.h>

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

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

Public Types
template<typename M >
using	exchange_momenta = RTLBMdynamicsMcHardy<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
	RTLBMdynamicsMcHardy (T latticeAbsorption, T latticeScattering, std::array< std::array< T, DESCRIPTOR::q >, DESCRIPTOR::q > &anisoMatrix)
	Constructor.

T	computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d], T uSqr) const override
	Compute equilibrium distribution function.

CellStatistic< T >	collide (Cell< T, DESCRIPTOR > &cell, LatticeStatistics< T > &statistics) override
	Collision step.

T	getOmega () const
	Get local relaxation parameter of the dynamics.

void	setOmega (T omega)
	Set local relaxation parameter of the dynamics.

T	getSink () const

Public Member Functions inherited from olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >
T	computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) const override
	Return iPop equilibrium for given first and second 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.

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.

Protected Attributes
T	_absorption

T	_scattering

std::array< std::array< T, DESCRIPTOR::q >, DESCRIPTOR::q > &	_anisoMatrix

Detailed Description

template<typename T, typename DESCRIPTOR, typename MOMENTA = momenta::BulkTuple>
class olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >

Solves RTE according Christopher McHardy et al 2016.

absorption and scattering coefficient: $\sigma_a$ and $\sigma_s$

Parameters

omega	change into beta the extinction coefficient
singleScatAlbedo	is the single scattering albedo, given by $\frac{\sigma_s}{\sigma_a + \sigma_s}$

Definition at line 46 of file rtlbmDynamics.h.

Member Typedef Documentation

◆ exchange_momenta

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

template<typename M >

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

Definition at line 49 of file rtlbmDynamics.h.

Constructor & Destructor Documentation

◆ RTLBMdynamicsMcHardy()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::RTLBMdynamicsMcHardy	(	T	latticeAbsorption,
		T	latticeScattering,
		std::array< std::array< T, DESCRIPTOR::q >, DESCRIPTOR::q > &	anisoMatrix )

Constructor.

Definition at line 44 of file rtlbmDynamics.hh.

  : legacy::BasicDynamics<T, DESCRIPTOR, MOMENTA>(), _absorption(latticeAbsorption), _scattering(latticeScattering), _anisoMatrix(anisoMatrix)
{
  this->getName() = "RTLBMdynamicsMcHardy";
}

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::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::collide	(	Cell< T, DESCRIPTOR > &	cell,
		LatticeStatistics< T > &	statistics )

override

Collision step.

Definition at line 59 of file rtlbmDynamics.hh.

{
  std::array<double, DESCRIPTOR::q> feq = {};
  for ( int iPop = 0; iPop < DESCRIPTOR::q; ++iPop ) {
    for ( int jPop = 0; jPop < DESCRIPTOR::q; ++jPop ) {
      feq[iPop] += (cell[jPop] + descriptors::t<T,DESCRIPTOR>(jPop)) * _anisoMatrix[jPop][iPop];
    }
    feq[iPop] *= descriptors::t<T,DESCRIPTOR>(iPop);
  }
  // execute collision
  for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
    cell[iPop] = (cell[iPop]+descriptors::t<T,DESCRIPTOR>(iPop))
                 - descriptors::norm_c<T,DESCRIPTOR>(iPop)*(_absorption+_scattering) * ( (cell[iPop]+descriptors::t<T,DESCRIPTOR>(iPop))- feq[iPop] )
                 - _absorption*descriptors::norm_c<T,DESCRIPTOR>(iPop) *(cell[iPop]+descriptors::t<T,DESCRIPTOR>(iPop))
                 - descriptors::t<T,DESCRIPTOR>(iPop);
  }
  T temperature = lbm<DESCRIPTOR>::computeRho(cell);
  statistics.incrementStats( temperature, T() );
}

References olb::lbm< DESCRIPTOR >::computeRho(), and olb::LatticeStatistics< T >::incrementStats().

Here is the call graph for this function:

◆ computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

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

override

Compute equilibrium distribution function.

Definition at line 52 of file rtlbmDynamics.hh.

{
  return rho*descriptors::t<T,DESCRIPTOR>(iPop) - descriptors::t<T,DESCRIPTOR>(iPop);
}

◆ getOmega()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

T olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::getOmega ( ) const

Get local relaxation parameter of the dynamics.

Definition at line 80 of file rtlbmDynamics.hh.

{
  return -1;
}

◆ getSink()

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

T olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::getSink ( ) const

◆ setOmega()

template<typename T , typename DESCRIPTOR , typename MOMENTA >

void olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::setOmega ( T omega )

Set local relaxation parameter of the dynamics.

Definition at line 86 of file rtlbmDynamics.hh.

87{

88}

Member Data Documentation

◆ _absorption

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

T olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::_absorption

protected

Definition at line 65 of file rtlbmDynamics.h.

◆ _anisoMatrix

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

std::array<std::array<T,DESCRIPTOR::q>, DESCRIPTOR::q>& olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::_anisoMatrix

protected

Definition at line 67 of file rtlbmDynamics.h.

◆ _scattering

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

T olb::RTLBMdynamicsMcHardy< T, DESCRIPTOR, MOMENTA >::_scattering

protected

Definition at line 66 of file rtlbmDynamics.h.

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

src/dynamics/rtlbmDynamics.h
src/dynamics/rtlbmDynamics.hh

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ exchange_momenta

Constructor & Destructor Documentation

◆ RTLBMdynamicsMcHardy()

Member Function Documentation

◆ collide()

◆ computeEquilibrium()

◆ getOmega()

◆ getSink()

◆ setOmega()

Member Data Documentation

◆ _absorption

◆ _anisoMatrix

◆ _scattering