Implementation of the Partially Saturated Method (PSM), see Krüger, Timm, et al. More...

#include <porousBGKdynamics.h>

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

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

Public Types
using	MomentaF = typename MOMENTA::template type<DESCRIPTOR>

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

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

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
void	setMomentaParameters (decltype(_parameters) parameters)

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.

void	computeU (ConstCell< T, DESCRIPTOR > &cell, T u[DESCRIPTOR::d]) const override
	Compute fluid velocity.

void	computeRhoU (ConstCell< T, DESCRIPTOR > &cell, T &rho, T u[DESCRIPTOR::d]) const override
	Compute fluid velocity and particle density.

template<typename CELL , typename PARAMETERS , typename V = typename CELL::value_t>
CellStatistic< V >	apply (CELL &cell, PARAMETERS &parameters)

T	computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) 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 >
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	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	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

static constexpr bool	has_parametrized_momenta = true

Detailed Description

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

Implementation of the Partially Saturated Method (PSM), see Krüger, Timm, et al.

The Lattice Boltzmann Method. Springer, 2017. (p.447-451)

Definition at line 545 of file porousBGKdynamics.h.

Member Typedef Documentation

◆ EquilibriumF

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

using olb::ForcedPSMBGKdynamics< T, DESCRIPTOR, MOMENTA >::EquilibriumF = typename equilibria::SecondOrder::template type<DESCRIPTOR,MOMENTA>

Definition at line 551 of file porousBGKdynamics.h.

◆ MomentaF

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

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

Definition at line 550 of file porousBGKdynamics.h.

◆ parameters

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

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

Definition at line 553 of file porousBGKdynamics.h.

Member Function Documentation

◆ apply()

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

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

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

inline

Definition at line 599 of file porousBGKdynamics.h.

  {
    V omega = parameters.template get<descriptors::OMEGA>();
    V rho, u[DESCRIPTOR::d], uSqr;
    MomentaF().computeRhoU(cell, rho, u);
    auto force = cell.template getField<descriptors::FORCE>();
    for (int iVel=0; iVel < DESCRIPTOR::d; ++iVel) {
      u[iVel] += force[iVel] * V{0.5};
    }
    auto u_s = cell.template getField<descriptors::VELOCITY_SOLID>();
 
    V epsilon = V{1} - cell.template getField<descriptors::POROSITY>();
    if (epsilon < 1e-5) {
      uSqr = lbm<DESCRIPTOR>::bgkCollision(cell, rho, u, omega);
      lbm<DESCRIPTOR>::addExternalForce(cell, rho, u, omega, force);
    }
    else {
      V paramA = V{1} / omega - V{0.5};
      V paramB = (epsilon * paramA) / ((V{1} - epsilon) + paramA);
      V paramC = (V{1} - paramB);
 
      V omega_s[DESCRIPTOR::q];
      V cell_tmp[DESCRIPTOR::q];
 
      for (int iPop=0; iPop < DESCRIPTOR::q; ++iPop) {
        cell_tmp[iPop] = cell[iPop];
        omega_s[iPop] = (equilibrium<DESCRIPTOR>::secondOrder(iPop, rho, u_s) - cell[iPop])
                      + (V{1} - omega) * (cell[iPop] - equilibrium<DESCRIPTOR>::secondOrder(iPop, rho, u));
      }
 
      uSqr = lbm<DESCRIPTOR>::bgkCollision(cell, rho, u, omega);
      lbm<DESCRIPTOR>::addExternalForce(cell, rho, u, omega, force);
 
      for (int iPop=0; iPop < DESCRIPTOR::q; ++iPop) {
        cell[iPop] = cell_tmp[iPop] + paramC * (cell[iPop] - cell_tmp[iPop]);
        cell[iPop] += paramB * omega_s[iPop];
      }
      for (int iVel=0; iVel < DESCRIPTOR::d; ++iVel) {
        u[iVel] = paramC * u[iVel] + paramB * u_s[iVel];
      }
      uSqr = util::normSqr<V,DESCRIPTOR::d>(u);
    }
    return {rho, uSqr};
  }

References olb::lbm< DESCRIPTOR >::addExternalForce(), olb::lbm< DESCRIPTOR >::bgkCollision(), and olb::equilibrium< DESCRIPTOR >::secondOrder().

Here is the call graph for this function:

◆ computeEquilibrium()

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

T olb::ForcedPSMBGKdynamics< T, DESCRIPTOR, MOMENTA >::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 644 of file porousBGKdynamics.h.

                                                                               {
    return EquilibriumF().compute(iPop, rho, u);
  };

◆ computeRhoU()

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

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

inlineoverridevirtual

Compute fluid velocity and particle density.

Reimplemented from olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >.

Definition at line 584 of file porousBGKdynamics.h.

  {
    MomentaF().computeRhoU(cell, rho, u);
    T epsilon = 1. - cell.template getField<descriptors::POROSITY>();
    T omega = _parameters->template get<descriptors::OMEGA>();
    T paramA = 1 / omega - 0.5;
    T paramB = (epsilon * paramA) / ((1. - epsilon) + paramA);
    T paramC = (1. - paramB);
    for (int iVel=0; iVel < DESCRIPTOR::d; ++iVel) {
      u[iVel] = paramC * (u[iVel] + cell.template getFieldComponent<descriptors::FORCE>(iVel) * 0.5)
              + paramB * cell.template getFieldComponent<descriptors::VELOCITY_SOLID>(iVel);
    }
  }

◆ computeU()

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

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

inlineoverridevirtual

Compute fluid velocity.

Reimplemented from olb::dynamics::CustomCollision< T, DESCRIPTOR, MOMENTA >.

Definition at line 570 of file porousBGKdynamics.h.

  {
    MomentaF().computeU(cell, u);
    T epsilon = 1. - cell.template getField<descriptors::POROSITY>();
    T omega = _parameters->template get<descriptors::OMEGA>();
    T paramA = 1 / omega - 0.5;
    T paramB = (epsilon * paramA) / ((1. - epsilon) + paramA);
    T paramC = (1. - paramB);
    for (int iVel=0; iVel < DESCRIPTOR::d; ++iVel) {
      u[iVel] = paramC * (u[iVel] + cell.template getFieldComponent<descriptors::FORCE>(iVel) * 0.5)
              + paramB * cell.template getFieldComponent<descriptors::VELOCITY_SOLID>(iVel);
    }
  }

◆ getName()

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

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

inlineoverridevirtual

Return human-readable name.

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

Definition at line 648 of file porousBGKdynamics.h.

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

◆ getParameters()

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

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

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 566 of file porousBGKdynamics.h.

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

◆ id()

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

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

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 562 of file porousBGKdynamics.h.

                              {
    return typeid(ForcedPSMBGKdynamics);
  }

◆ setMomentaParameters()

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

void olb::ForcedPSMBGKdynamics< T, DESCRIPTOR, MOMENTA >::setMomentaParameters ( decltype(_parameters) parameters )

inline

Definition at line 558 of file porousBGKdynamics.h.

                                                              {
    _parameters = parameters;
  }

Member Data Documentation

◆ has_parametrized_momenta

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

constexpr bool olb::ForcedPSMBGKdynamics< T, DESCRIPTOR, MOMENTA >::has_parametrized_momenta = true

staticconstexpr

Definition at line 556 of file porousBGKdynamics.h.

◆ is_vectorizable

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

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

staticconstexpr

Definition at line 555 of file porousBGKdynamics.h.

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

src/dynamics/porousBGKdynamics.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ EquilibriumF

◆ MomentaF

◆ parameters

Member Function Documentation

◆ apply()

◆ computeEquilibrium()

◆ computeRhoU()

◆ computeU()

◆ getName()

◆ getParameters()

◆ id()

◆ setMomentaParameters()

Member Data Documentation

◆ has_parametrized_momenta

◆ is_vectorizable