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

#include <rtlbmDynamics.h>

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

Public Types

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

 RTLBMdynamicsMcHardyRK (T latticeAbsorption, T latticeScattering, std::array< std::array< T, DESCRIPTOR::q >, DESCRIPTOR::q > &anisoMatrix)
 Constructor.
 
computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d], T uSqr) const override
 Compute equilibrium distribution function.
 
CellStatistic< T > collide (Cell< T, DESCRIPTOR > &cell, LatticeStatistics< T > &statistics) override
 Collision step.
 
getOmega () const
 Get local relaxation parameter of the dynamics.
 
void setOmega (T omega)
 Set local relaxation parameter of the dynamics.
 
- Public Member Functions inherited from olb::legacy::BasicDynamics< T, DESCRIPTOR, MOMENTA >
computeEquilibrium (int iPop, T rho, const T u[DESCRIPTOR::d]) const override
 Return iPop equilibrium for given first and second momenta.
 
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.
 
- 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 std::string getName () const
 Return human-readable name.
 
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::BulkTuple>
class olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >

Definition at line 71 of file rtlbmDynamics.h.

Member Typedef Documentation

◆ exchange_momenta

template<typename T , typename DESCRIPTOR , typename MOMENTA = momenta::BulkTuple>
template<typename M >
using olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >::exchange_momenta = RTLBMdynamicsMcHardyRK<T,DESCRIPTOR,M>

Definition at line 76 of file rtlbmDynamics.h.

Constructor & Destructor Documentation

◆ RTLBMdynamicsMcHardyRK()

template<typename T , typename DESCRIPTOR , typename MOMENTA >
olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >::RTLBMdynamicsMcHardyRK ( T latticeAbsorption,
T latticeScattering,
std::array< std::array< T, DESCRIPTOR::q >, DESCRIPTOR::q > & anisoMatrix )

Constructor.

Definition at line 92 of file rtlbmDynamics.hh.

94 : legacy::BasicDynamics<T, DESCRIPTOR, MOMENTA>(), _absorption(latticeAbsorption), _scattering(latticeScattering), _anisoMatrix(anisoMatrix)
95{
96 this->getName() = "RTLBMdynamicsMcHardyRK";
97}
virtual std::string getName() const
Return human-readable name.
Definition interface.h:63

References olb::Dynamics< T, DESCRIPTOR >::getName().

+ Here is the call graph for this function:

Member Function Documentation

◆ collide()

template<typename T , typename DESCRIPTOR , typename MOMENTA >
CellStatistic< T > olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >::collide ( Cell< T, DESCRIPTOR > & cell,
LatticeStatistics< T > & statistics )
override

Collision step.

Definition at line 129 of file rtlbmDynamics.hh.

130{
131 std::array<T,DESCRIPTOR::q> feq;
132 std::array<T,DESCRIPTOR::q> f_pre_collision;
133 // separate cell and precollision f_i
134 for ( int iPop = 0; iPop < DESCRIPTOR::q; ++iPop ) {
135 f_pre_collision[iPop] = cell[iPop] + descriptors::t<T,DESCRIPTOR>(iPop);
136 }
137
138 // shift only first collision und equilibrium and then at the very end
139 for ( int iPop = 0; iPop < DESCRIPTOR::q; ++iPop ) {
140 cell[iPop] += descriptors::t<T,DESCRIPTOR>(iPop);
141 }
142 computeEquilibriumAniso(cell,feq);
143 std::array<T,DESCRIPTOR::q> k1 = doCollision(cell,feq);
144 // update cell
145 for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
146 cell[iPop] = f_pre_collision[iPop] + 0.5*k1[iPop];
147 }
148
149 computeEquilibriumAniso(cell,feq);
150 std::array<T,DESCRIPTOR::q> k2 = doCollision(cell,feq);
151 // update cell
152 for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
153 cell[iPop] = f_pre_collision[iPop] + 0.5*k2[iPop];
154 }
155
156 computeEquilibriumAniso(cell,feq);
157 std::array<T,DESCRIPTOR::q> k3 = doCollision(cell,feq);
158 // update cell
159 for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
160 cell[iPop] = f_pre_collision[iPop] + k3[iPop];
161 }
162
163 computeEquilibriumAniso(cell,feq);
164 std::array<T,DESCRIPTOR::q> k4 = doCollision(cell,feq);
165 // update cell
166 for (int iPop = 0; iPop < DESCRIPTOR::q; ++iPop) {
167 cell[iPop] = f_pre_collision[iPop] + 1/6.*(k1[iPop] + 2*k2[iPop] + 2*k3[iPop] + k4[iPop])
168 - descriptors::t<T,DESCRIPTOR>(iPop); // back shift for OpenLB
169 }
170 T temperature = lbm<DESCRIPTOR>::computeRho(cell);
171 statistics.incrementStats( temperature, T() );
172}
static V computeRho(CELL &cell) any_platform
Computation of density.
Definition lbm.h:185

References olb::lbm< DESCRIPTOR >::computeRho(), and olb::LatticeStatistics< T >::incrementStats().

+ Here is the call graph for this function:

◆ computeEquilibrium()

template<typename T , typename DESCRIPTOR , typename MOMENTA >
T olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >::computeEquilibrium ( int iPop,
T rho,
const T u[DESCRIPTOR::d],
T uSqr ) const
override

Compute equilibrium distribution function.

Definition at line 100 of file rtlbmDynamics.hh.

101{
102 return rho*descriptors::t<T,DESCRIPTOR>(iPop) - descriptors::t<T,DESCRIPTOR>(iPop);
103}

◆ getOmega()

template<typename T , typename DESCRIPTOR , typename MOMENTA >
T olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >::getOmega ( ) const

Get local relaxation parameter of the dynamics.

Definition at line 175 of file rtlbmDynamics.hh.

176{
177 return -1;
178}

◆ setOmega()

template<typename T , typename DESCRIPTOR , typename MOMENTA >
void olb::RTLBMdynamicsMcHardyRK< T, DESCRIPTOR, MOMENTA >::setOmega ( T omega)

Set local relaxation parameter of the dynamics.

Definition at line 181 of file rtlbmDynamics.hh.

182{
183}

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