Implementation of Dirichlet boundary condition for the order parameter. More...

#include <phaseFieldBoundaryDynamics.h>

Inheritance diagram for olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >:

Collaboration diagram for olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >:

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

using	EquilibriumF = typename CORRECTED_DYNAMICS::EquilibriumF

using	parameters = typename CORRECTED_DYNAMICS::parameters

template<typename M >
using	exchange_momenta = PhaseFieldInletDynamics<T,DESCRIPTOR,DYNAMICS,M,direction,orientation>

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 >	collide (CELL &cell, PARAMETERS &parameters) any_platform

void	computeEquilibrium (ConstCell< T, DESCRIPTOR > &cell, T rho, const T u[DESCRIPTOR::d], T fEq[DESCRIPTOR::q]) 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 DYNAMICS, typename MOMENTA, int direction, int orientation>
class olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >

Implementation of Dirichlet boundary condition for the order parameter.

Definition at line 35 of file phaseFieldBoundaryDynamics.h.

Member Typedef Documentation

◆ EquilibriumF

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

using olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::EquilibriumF = typename CORRECTED_DYNAMICS::EquilibriumF

Definition at line 42 of file phaseFieldBoundaryDynamics.h.

◆ exchange_momenta

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

template<typename M >

using olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::exchange_momenta = PhaseFieldInletDynamics<T,DESCRIPTOR,DYNAMICS,M,direction,orientation>

Definition at line 47 of file phaseFieldBoundaryDynamics.h.

◆ MomentaF

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

using olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::MomentaF = typename MOMENTA::template type<DESCRIPTOR>

Definition at line 41 of file phaseFieldBoundaryDynamics.h.

◆ parameters

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

using olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::parameters = typename CORRECTED_DYNAMICS::parameters

Definition at line 44 of file phaseFieldBoundaryDynamics.h.

Member Function Documentation

◆ collide()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

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

CellStatistic< V > olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::collide	(	CELL &	cell,
		PARAMETERS &	parameters )

inline

Definition at line 58 of file phaseFieldBoundaryDynamics.h.

                                                                            {
    // Along all the commented parts of this code there will be an example based
    // on the situation where the wall's normal vector if (0,1) and the
    // numerotation of the velocites are done according to the D2Q9
    // lattice of the OpenLB library.
 
    // Find all the missing populations
    // (directions 3,4,5)
    constexpr auto missingIndices = util::subIndexOutgoing<DESCRIPTOR,direction,orientation>();
 
    V phi = MomentaF().computeRho(cell);
    V missingPhi = phi - 1.;
    V missingWeightSum = 0;
    for (int iPop=0; iPop < DESCRIPTOR::q; ++iPop) {
 
      bool contains = false;
      for(unsigned i=0; i < missingIndices.size(); i++){
        if(missingIndices[i] == (unsigned)iPop){
          contains = true;
        }
      }
 
      if(contains){
        missingWeightSum += descriptors::t<V,DESCRIPTOR>(iPop);
      } else {
        missingPhi -= cell[iPop];
      }
    }
 
    for (unsigned iPop=0; iPop < missingIndices.size(); ++iPop) {
      cell[missingIndices[iPop]] = missingPhi * descriptors::t<V,DESCRIPTOR>(missingIndices[iPop]) / missingWeightSum;
    }
 
    return typename CORRECTED_DYNAMICS::CollisionO().apply(cell, parameters);
  }

References olb::util::subIndexOutgoing(), and olb::descriptors::t().

Here is the call graph for this function:

◆ computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

void olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::computeEquilibrium	(	ConstCell< T, DESCRIPTOR > &	cell,
		T	rho,
		const T	u[DESCRIPTOR::d],
		T	fEq[DESCRIPTOR::q] ) const

inlineoverridevirtual

Return iPop equilibrium for given first and second momenta.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 94 of file phaseFieldBoundaryDynamics.h.

                                                                                                                           {
    EquilibriumF().compute(cell, rho, u, fEq);
  };

◆ getName()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

std::string olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::getName ( ) const

inlineoverridevirtual

Return human-readable name.

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

Definition at line 98 of file phaseFieldBoundaryDynamics.h.

                                     {
    return "PhaseFieldInletDynamics<" + CORRECTED_DYNAMICS().getName() + ">";
  };

◆ getParameters()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

AbstractParameters< T, DESCRIPTOR > & olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::getParameters ( BlockLattice< T, DESCRIPTOR > & block )

inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 53 of file phaseFieldBoundaryDynamics.h.

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

◆ id()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA , int direction, int orientation>

std::type_index olb::PhaseFieldInletDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::id ( )

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 49 of file phaseFieldBoundaryDynamics.h.

                              {
    return typeid(PhaseFieldInletDynamics);
  }

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

src/boundary/phaseFieldBoundaryDynamics.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ EquilibriumF

◆ exchange_momenta

◆ MomentaF

◆ parameters

Member Function Documentation

◆ collide()

◆ computeEquilibrium()

◆ getName()

◆ getParameters()

◆ id()