#include <zouHeDynamics.h>

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

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

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

using	OriginalMomentaF = typename DYNAMICS::MomentaF

using	EquilibriumF = typename CORRECTED_DYNAMICS::EquilibriumF

using	parameters = typename CORRECTED_DYNAMICS::parameters

template<typename NEW_T >
using	exchange_value_type

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

template<typename CELL , typename PARAMETERS , typename V = typename CELL::value_t>
V	computeEquilibriumMP (int iPop, CELL &cell, PARAMETERS &parameters) any_platform

void	computeEquilibrium (ConstCell< T, DESCRIPTOR > &cell, T p, 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.

Static Public Attributes
static constexpr bool	is_vectorizable = false

Detailed Description

template<typename T, typename DESCRIPTOR, typename DYNAMICS, typename MOMENTA, int direction, int orientation>
class olb::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >

Definition at line 148 of file zouHeDynamics.h.

Member Typedef Documentation

◆ EquilibriumF

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

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

Definition at line 156 of file zouHeDynamics.h.

◆ exchange_momenta

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

template<typename M >

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

Definition at line 167 of file zouHeDynamics.h.

◆ exchange_value_type

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

template<typename NEW_T >

using olb::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::exchange_value_type

Initial value:

 IncZouHeDynamics<NEW_T,DESCRIPTOR,
    typename DYNAMICS::template exchange_value_type<NEW_T>,
    MOMENTA,direction,orientation
  >

Definition at line 161 of file zouHeDynamics.h.

◆ MomentaF

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

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

Definition at line 154 of file zouHeDynamics.h.

◆ OriginalMomentaF

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

using olb::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::OriginalMomentaF = typename DYNAMICS::MomentaF

Definition at line 155 of file zouHeDynamics.h.

◆ parameters

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

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

Definition at line 158 of file zouHeDynamics.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::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::collide	(	CELL &	cell,
		PARAMETERS &	parameters )

inline

Definition at line 180 of file zouHeDynamics.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 missingIndexesTmp = util::subIndexOutgoing<DESCRIPTOR,direction,orientation>();
    std::vector<int> missingIndexes(missingIndexesTmp.cbegin(), missingIndexesTmp.cend());
 
    // Will contain the missing poputations that are not normal to the wall.
    // (directions 3,5)
    std::vector<int> missingDiagonalIndexes = missingIndexes;
    for (unsigned iPop = 0; iPop < missingIndexes.size(); ++iPop) {
      int numOfNonNullComp = 0;
      for (int iDim = 0; iDim < DESCRIPTOR::d; ++iDim) {
        numOfNonNullComp += util::abs(descriptors::c<DESCRIPTOR>(missingIndexes[iPop],iDim));
      }
 
      if (numOfNonNullComp == 1) {
        missingDiagonalIndexes.erase(missingDiagonalIndexes.begin()+iPop);
        break;
      }
    }
 
    V u[DESCRIPTOR::d];
    V falseU[DESCRIPTOR::d];
    MomentaF().computeU(cell, u);
    auto rho = cell.template getField<descriptors::RHO>();
    V uSqr = util::normSqr<V,DESCRIPTOR::d>(u);
 
    // The unknown non equilibrium populations are bounced back
    // (f[3] = feq[3] + fneq[7], f[4] = feq[4] + fneq[8],
    //  f[5] = feq[5] + fneq[1])
    for (unsigned iPop = 0; iPop < missingIndexes.size(); ++iPop) {
      cell[missingIndexes[iPop]] = cell[descriptors::opposite<DESCRIPTOR>(missingIndexes[iPop])]
        - computeEquilibriumMP(descriptors::opposite<DESCRIPTOR>(missingIndexes[iPop]), cell, parameters)
        + computeEquilibriumMP(missingIndexes[iPop], cell, parameters);
    }
 
    // We recompute  u in order to have the new momentum. Since the momen-
    // tum is not conserved from this scheme, we will correct it. By adding
    // a contribution to the missingDiagonalVelocities.
    OriginalMomentaF().computeU(cell,falseU);
 
    V diff[DESCRIPTOR::d] {};
    for (int iDim = 0; iDim < DESCRIPTOR::d; ++iDim) {
      diff[iDim] = rho*(u[iDim] - falseU[iDim])/ V(missingDiagonalIndexes.size());
    }
 
    for (unsigned iPop = 0; iPop < missingDiagonalIndexes.size(); ++iPop) {
      for (int iDim = 1; iDim < DESCRIPTOR::d; ++iDim) {
        cell[missingDiagonalIndexes[iPop]] +=
          descriptors::c<DESCRIPTOR>(missingDiagonalIndexes[iPop],(direction+iDim)%DESCRIPTOR::d) * diff[(direction+iDim)%DESCRIPTOR::d];
      }
    }
 
    typename CORRECTED_DYNAMICS::CollisionO().apply(cell, parameters);
 
    return {rho, uSqr};
  }

References olb::util::abs(), olb::descriptors::c(), olb::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::computeEquilibriumMP(), olb::util::normSqr(), olb::descriptors::opposite(), and olb::util::subIndexOutgoing().

Here is the call graph for this function:

◆ computeEquilibrium()

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

void olb::IncZouHeDynamics< 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 250 of file zouHeDynamics.h.

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

◆ computeEquilibriumMP()

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

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

V olb::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::computeEquilibriumMP	(	int	iPop,
		CELL &	cell,
		PARAMETERS &	parameters )

inline

Definition at line 244 of file zouHeDynamics.h.

                                                                                    {
    V fEq[DESCRIPTOR::q];
    EquilibriumF().compute(cell, parameters, fEq);
    return fEq[iPop];
  };

Here is the caller graph for this function:

◆ getName()

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

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

inlineoverridevirtual

Return human-readable name.

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

Definition at line 254 of file zouHeDynamics.h.

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

◆ getParameters()

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

AbstractParameters< T, DESCRIPTOR > & olb::IncZouHeDynamics< 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 175 of file zouHeDynamics.h.

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

◆ id()

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

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

inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 171 of file zouHeDynamics.h.

                              {
    return typeid(IncZouHeDynamics);
  }

Member Data Documentation

◆ is_vectorizable

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

bool olb::IncZouHeDynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA, direction, orientation >::is_vectorizable = false

staticconstexpr

Definition at line 169 of file zouHeDynamics.h.

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

src/boundary/zouHeDynamics.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ EquilibriumF

◆ exchange_momenta

◆ exchange_value_type

◆ MomentaF

◆ OriginalMomentaF

◆ parameters

Member Function Documentation

◆ collide()

◆ computeEquilibrium()

◆ computeEquilibriumMP()

◆ getName()

◆ getParameters()

◆ id()

Member Data Documentation

◆ is_vectorizable