#include <advectionDiffusionDynamics.h>

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

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

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

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

template<typename M >
using	exchange_momenta = PhaseFieldAdvectionDiffusionBGKdynamics<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
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)

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	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, typename MOMENTA = momenta::AdvectionDiffusionBulkTuple>
struct olb::PhaseFieldAdvectionDiffusionBGKdynamics< T, DESCRIPTOR, MOMENTA >

Definition at line 597 of file advectionDiffusionDynamics.h.

Member Typedef Documentation

◆ exchange_momenta

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

template<typename M >

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

Definition at line 603 of file advectionDiffusionDynamics.h.

◆ MomentaF

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

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

Definition at line 598 of file advectionDiffusionDynamics.h.

◆ parameters

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

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

Definition at line 600 of file advectionDiffusionDynamics.h.

Member Function Documentation

◆ apply()

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

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

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

inline

Definition at line 614 of file advectionDiffusionDynamics.h.

                                                             {
    const V omega = parameters.template get<descriptors::OMEGA>();
    const V interface_thickness = parameters.template get<descriptors::INTERFACE_THICKNESS>();
 
    const V phi = MomentaF().computeRho( cell );
    const auto u = cell.template getField<descriptors::VELOCITY>();
    const V uSqr = util::normSqr<V,DESCRIPTOR::d>(u);
    const auto mobility = (V{1} / omega - V{0.5}) / descriptors::invCs2<V,DESCRIPTOR>();
 
    const auto n = cell.template getFieldPointer<descriptors::INTERPHASE_NORMAL>();
    for (int iPop=0; iPop < DESCRIPTOR::q; ++iPop) {
      V c_u{};
      V c_n{};
      for (int iD=0; iD < DESCRIPTOR::d; ++iD) {
        c_u += descriptors::c<DESCRIPTOR>(iPop,iD)*u[iD];
        c_n += descriptors::c<DESCRIPTOR>(iPop,iD)*n[iD];
      }
      V f_eq = equilibrium<DESCRIPTOR>::firstOrder(iPop, phi, u);
      f_eq += descriptors::t<V,DESCRIPTOR>(iPop) * mobility * descriptors::invCs2<V,DESCRIPTOR>()
            * (V{4} * phi * (V{1} - phi) / interface_thickness) * c_n;
 
      cell[iPop] *= V{1} - omega;
      cell[iPop] += omega * f_eq;
    }
 
    return {phi, uSqr};
  };

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

Here is the call graph for this function:

◆ computeEquilibrium()

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

T olb::PhaseFieldAdvectionDiffusionBGKdynamics< 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 642 of file advectionDiffusionDynamics.h.

  {
    return equilibrium<DESCRIPTOR>::template firstOrder(iPop, rho, u);
  }

◆ getName()

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

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

inlineoverridevirtual

Return human-readable name.

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

Definition at line 647 of file advectionDiffusionDynamics.h.

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

◆ getParameters()

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

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

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 609 of file advectionDiffusionDynamics.h.

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

◆ id()

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

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

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 605 of file advectionDiffusionDynamics.h.

                              {
    return typeid(PhaseFieldAdvectionDiffusionBGKdynamics);
  };

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

src/dynamics/advectionDiffusionDynamics.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ exchange_momenta

◆ MomentaF

◆ parameters

Member Function Documentation

◆ apply()

◆ computeEquilibrium()

◆ getName()

◆ getParameters()

◆ id()