OpenLB 1.7
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA > Class Template Referencefinal

Regularized BGK collision followed by any other Dynamics. More...

#include <dynamics.h>

+ Inheritance diagram for olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >:
+ Collaboration diagram for olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >:

Public Types

using MomentaF = typename MOMENTA::template type<DESCRIPTOR>
 
using parameters = typename CORRECTED_DYNAMICS::parameters
 
template<typename M >
using exchange_momenta = CombinedRLBdynamics<T,DESCRIPTOR,DYNAMICS,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<CONCEPT(MinimalCell) CELL, typename PARAMETERS , typename V = typename CELL::value_t>
CellStatistic< V > apply (CELL &cell, PARAMETERS &parameters) any_platform
 
computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) const override any_platform
 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.
 
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>
class olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >

Regularized BGK collision followed by any other Dynamics.

Commonly used to model boundaries consisting of a specific boundary momenta and standard dynamics::Tuple-declared dynamics.

Definition at line 193 of file dynamics.h.

Member Typedef Documentation

◆ exchange_momenta

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
template<typename M >
using olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::exchange_momenta = CombinedRLBdynamics<T,DESCRIPTOR,DYNAMICS,M>

Definition at line 204 of file dynamics.h.

◆ MomentaF

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

Definition at line 199 of file dynamics.h.

◆ parameters

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
using olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::parameters = typename CORRECTED_DYNAMICS::parameters

Definition at line 201 of file dynamics.h.

Member Function Documentation

◆ apply()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
template<CONCEPT(MinimalCell) CELL, typename PARAMETERS , typename V = typename CELL::value_t>
CellStatistic< V > olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::apply ( CELL & cell,
PARAMETERS & parameters )
inline

Definition at line 215 of file dynamics.h.

215 {
216 V rho, u[DESCRIPTOR::d], pi[util::TensorVal<DESCRIPTOR>::n];
217 MomentaF().computeAllMomenta(cell,rho,u,pi);
218
219 for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
220 cell[iPop] = typename CORRECTED_DYNAMICS::EquilibriumF().compute(iPop, rho, u)
221 + equilibrium<DESCRIPTOR>::template fromPiToFneq<V>(iPop, pi);
222 }
223
224 return typename CORRECTED_DYNAMICS::CollisionO().apply(cell, parameters);
225 };
typename MOMENTA::template type< DESCRIPTOR > MomentaF
Definition dynamics.h:199
typename CORRECTED_DYNAMICS::parameters parameters
Definition dynamics.h:201
static constexpr int n
result stored in n
Definition util.h:211

◆ computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
T olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, 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 227 of file dynamics.h.

227 {
228 return typename CORRECTED_DYNAMICS::EquilibriumF().compute(iPop, rho, u);
229 };

◆ getName()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
std::string olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::getName ( ) const
inlineoverridevirtual

Return human-readable name.

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

Definition at line 231 of file dynamics.h.

231 {
232 return "CombinedRLBdynamics<" + CORRECTED_DYNAMICS().getName() + ">";
233 };

◆ getParameters()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
AbstractParameters< T, DESCRIPTOR > & olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::getParameters ( BlockLattice< T, DESCRIPTOR > & block)
inlineoverridevirtual

Parameters access for legacy post processors.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 210 of file dynamics.h.

210 {
211 return block.template getData<OperatorParameters<CombinedRLBdynamics>>();
212 }

◆ id()

template<typename T , typename DESCRIPTOR , typename DYNAMICS , typename MOMENTA >
std::type_index olb::CombinedRLBdynamics< T, DESCRIPTOR, DYNAMICS, MOMENTA >::id ( )
inlineoverridevirtual

Expose unique type-identifier for RTTI.

Implements olb::Dynamics< T, DESCRIPTOR >.

Definition at line 206 of file dynamics.h.

206 {
207 return typeid(CombinedRLBdynamics);
208 }

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