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

functor returns pointwise phys shear rate magnitude on local lattice More...

#include <latticePhysShearRateMag3D.h>

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

Public Member Functions

 BlockLatticePhysShearRateMag3D (BlockLattice< T, DESCRIPTOR > &blockLattice, const UnitConverter< T, DESCRIPTOR > &converter)
 
bool operator() (T output[], const int input[])
 has to be implemented for 'every' derived class
 
- Public Member Functions inherited from olb::BlockLatticeF3D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > & getBlock ()
 Copy Constructor.
 
- Public Member Functions inherited from olb::BlockF3D< T >
 ~BlockF3D () override
 virtual destructor for defined behaviour
 
virtual BlockStructureD< 3 > & getBlockStructure () const
 
BlockF3D< T > & operator- (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator+ (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator* (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator/ (BlockF3D< T > &rhs)
 
- Public Member Functions inherited from olb::GenericF< T, int >
virtual ~GenericF ()=default
 
int getSourceDim () const
 read only access to member variable _m
 
int getTargetDim () const
 read only access to member variable _n
 
std::string & getName ()
 read and write access to name
 
std::string const & getName () const
 read only access to name
 
bool operator() (T output[])
 wrapper that call the pure virtual operator() (T output[], const S input[]) from above
 
bool operator() (T output[], int input0)
 
bool operator() (T output[], int input0, int input1)
 
bool operator() (T output[], int input0, int input1, int input2)
 
bool operator() (T output[], int input0, int input1, int input2, int input3)
 

Additional Inherited Members

- Public Types inherited from olb::GenericF< T, int >
using targetType
 
using sourceType
 
- Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Protected Member Functions inherited from olb::BlockLatticePhysF3D< T, DESCRIPTOR >
 BlockLatticePhysF3D (BlockLattice< T, DESCRIPTOR > &blockLattice, const UnitConverter< T, DESCRIPTOR > &converter, int targetDim)
 
- Protected Member Functions inherited from olb::BlockLatticeF3D< T, DESCRIPTOR >
 BlockLatticeF3D (BlockLattice< T, DESCRIPTOR > &blockLattice, int targetDim)
 
- Protected Member Functions inherited from olb::BlockF3D< T >
 BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, int >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::BlockLatticePhysF3D< T, DESCRIPTOR >
const UnitConverter< T, DESCRIPTOR > & _converter
 
- Protected Attributes inherited from olb::BlockLatticeF3D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > & _blockLattice
 
- Protected Attributes inherited from olb::BlockF3D< T >
BlockStructureD< 3 > & _blockStructure
 

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::BlockLatticePhysShearRateMag3D< T, DESCRIPTOR >

functor returns pointwise phys shear rate magnitude on local lattice

Definition at line 59 of file latticePhysShearRateMag3D.h.

Constructor & Destructor Documentation

◆ BlockLatticePhysShearRateMag3D()

template<typename T , typename DESCRIPTOR >
olb::BlockLatticePhysShearRateMag3D< T, DESCRIPTOR >::BlockLatticePhysShearRateMag3D ( BlockLattice< T, DESCRIPTOR > & blockLattice,
const UnitConverter< T, DESCRIPTOR > & converter )

Definition at line 62 of file latticePhysShearRateMag3D.hh.

65 : BlockLatticePhysF3D<T, DESCRIPTOR>(blockLattice, converter, 9)
66{
67 this->getName() = "shearRateMag";
68}
std::string & getName()
read and write access to name
Definition genericF.hh:51

References olb::GenericF< T, int >::getName().

+ Here is the call graph for this function:

Member Function Documentation

◆ operator()()

template<typename T , typename DESCRIPTOR >
bool olb::BlockLatticePhysShearRateMag3D< T, DESCRIPTOR >::operator() ( T output[],
const int input[] )
virtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 71 of file latticePhysShearRateMag3D.hh.

72{
73 T rho, uTemp[DESCRIPTOR::d], pi[util::TensorVal<DESCRIPTOR >::n];
74 Cell<T,DESCRIPTOR> cell = this->_blockLattice.get(input);
75 cell.computeAllMomenta(rho, uTemp, pi);
76 T omega = DESCRIPTOR::template provides<descriptors::OMEGA>()
77 ? cell.template getField<descriptors::OMEGA>()
78 : 1. / this->_converter.getLatticeRelaxationTime();
79
80 T pre2 = util::pow(descriptors::invCs2<T,DESCRIPTOR>()/2.* omega/rho,2.); // strain rate tensor prefactor
81 T gamma{};
82 if constexpr (DESCRIPTOR::template provides<descriptors::FORCE>()) {
83 const auto force = cell.template getField<descriptors::FORCE>();
84 gamma = util::sqrt(2.*pre2*lbm<DESCRIPTOR>::computePiNeqNormSqr(cell, force)); // shear rate
85 } else {
86 gamma = util::sqrt(2.*pre2*lbm<DESCRIPTOR>::computePiNeqNormSqr(cell)); // shear rate
87 }
88
89 output[0] = gamma / this->_converter.getConversionFactorTime();
90
91 return true;
92}
BlockLattice< T, DESCRIPTOR > & _blockLattice
const UnitConverter< T, DESCRIPTOR > & _converter
cpu::simd::Pack< T > sqrt(cpu::simd::Pack< T > value)
Definition pack.h:100
cpu::simd::Pack< T > pow(cpu::simd::Pack< T > base, cpu::simd::Pack< T > exp)
Definition pack.h:112
static V computePiNeqNormSqr(CELL &cell, const FORCE &force) any_platform
Computes squared norm of non-equilibrium part of 2nd momentum for forced dynamics.
Definition lbm.h:424
static constexpr int n
result stored in n
Definition util.h:211

References olb::ConstCell< T, DESCRIPTOR >::computeAllMomenta(), olb::util::pow(), and olb::util::sqrt().

+ Here is the call graph for this function:

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