walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT > Class Template Reference

#include <SimplePAB.h>

+ Inheritance diagram for walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >:

Public Member Functions

 SimplePAB (const BoundaryUID &boundaryUID, const FlagUID &uid, PDFField *const pdfField, FlagFieldT *const flagField, const real_t latticeDensity, const real_t omega, FlagUID domain, FlagUID noSlip)
 
void pushFlags (std::vector< FlagUID > &uids) const
 
void beforeBoundaryTreatment () const
 
void afterBoundaryTreatment () const
 
template<typename Buffer_T >
void packCell (Buffer_T &, const cell_idx_t, const cell_idx_t, const cell_idx_t) const
 
template<typename Buffer_T >
void registerCell (Buffer_T &, const flag_t, const cell_idx_t, const cell_idx_t, const cell_idx_t)
 
void registerCell (const flag_t, const cell_idx_t, const cell_idx_t, const cell_idx_t, const BoundaryConfiguration &)
 
void registerCells (const flag_t, const CellInterval &, const BoundaryConfiguration &) const
 
template<typename CellIterator >
void registerCells (const flag_t, const CellIterator &, const CellIterator &, const BoundaryConfiguration &) const
 
void unregisterCell (const flag_t, const cell_idx_t, const cell_idx_t, const cell_idx_t) const
 
void treatDirection (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const stencil::Direction dir, const cell_idx_t nx, const cell_idx_t ny, const cell_idx_t nz, const flag_t mask)
 
- Public Member Functions inherited from walberla::boundary::Boundary< flag_t >
 Boundary (const BoundaryUID &boundaryUID)
 
void setMask (const flag_t mask)
 
flag_t getMask () const
 
const BoundaryUIDgetUID () const
 

Static Public Member Functions

static shared_ptr< BoundaryConfigurationcreateConfiguration (const Config::BlockHandle &)
 

Static Public Attributes

static const bool threadsafe = true
 

Protected Attributes

FlagUID uid_
 
PDFFieldpdfs_
 
FlagFieldT * flags_
 
flag_t noSlipFlag_
 
flag_t domainFlag_
 
real_t latticeDensity_
 
real_t omega_
 
real_t tau_
 
- Protected Attributes inherited from walberla::boundary::Boundary< flag_t >
const BoundaryUID boundaryUID_
 
flag_t mask_
 
bool maskSet_
 

Private Types

using PDFField = PdfField< LatticeModel_T >
 
using Stencil = typename LatticeModel_T::Stencil
 
using flag_t = typename FlagFieldT::flag_t
 
using Vec3Real = Vector3< real_t >
 

Member Typedef Documentation

◆ flag_t

template<typename LatticeModel_T , typename FlagFieldT >
using walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::flag_t = typename FlagFieldT::flag_t
private

◆ PDFField

template<typename LatticeModel_T , typename FlagFieldT >
using walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::PDFField = PdfField<LatticeModel_T>
private

◆ Stencil

template<typename LatticeModel_T , typename FlagFieldT >
using walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::Stencil = typename LatticeModel_T::Stencil
private

◆ Vec3Real

template<typename LatticeModel_T , typename FlagFieldT >
using walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::Vec3Real = Vector3<real_t>
private

Constructor & Destructor Documentation

◆ SimplePAB()

template<typename LatticeModel_T , typename FlagFieldT >
walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::SimplePAB ( const BoundaryUID &  boundaryUID,
const FlagUID &  uid,
PDFField *const  pdfField,
FlagFieldT *const  flagField,
const real_t  latticeDensity,
const real_t  omega,
FlagUID  domain,
FlagUID  noSlip 
)
inline

Member Function Documentation

◆ afterBoundaryTreatment()

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::afterBoundaryTreatment ( ) const
inline

◆ beforeBoundaryTreatment()

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::beforeBoundaryTreatment ( ) const
inline

◆ createConfiguration()

template<typename LatticeModel_T , typename FlagFieldT >
static shared_ptr<BoundaryConfiguration> walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::createConfiguration ( const Config::BlockHandle )
inlinestatic

◆ packCell()

template<typename LatticeModel_T , typename FlagFieldT >
template<typename Buffer_T >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::packCell ( Buffer_T &  ,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t 
) const
inline

◆ pushFlags()

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::pushFlags ( std::vector< FlagUID > &  uids) const
inline

◆ registerCell() [1/2]

template<typename LatticeModel_T , typename FlagFieldT >
template<typename Buffer_T >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::registerCell ( Buffer_T &  ,
const  flag_t,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t 
)
inline

◆ registerCell() [2/2]

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::registerCell ( const  flag_t,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t,
const BoundaryConfiguration  
)
inline

◆ registerCells() [1/2]

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::registerCells ( const  flag_t,
const CellInterval ,
const BoundaryConfiguration  
) const
inline

◆ registerCells() [2/2]

template<typename LatticeModel_T , typename FlagFieldT >
template<typename CellIterator >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::registerCells ( const  flag_t,
const CellIterator &  ,
const CellIterator &  ,
const BoundaryConfiguration  
) const
inline

◆ treatDirection()

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::treatDirection ( const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z,
const stencil::Direction  dir,
const cell_idx_t  nx,
const cell_idx_t  ny,
const cell_idx_t  nz,
const flag_t  mask 
)
inline

◆ unregisterCell()

template<typename LatticeModel_T , typename FlagFieldT >
void walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::unregisterCell ( const  flag_t,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t 
) const
inline

Member Data Documentation

◆ domainFlag_

template<typename LatticeModel_T , typename FlagFieldT >
flag_t walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::domainFlag_
protected

◆ flags_

template<typename LatticeModel_T , typename FlagFieldT >
FlagFieldT* walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::flags_
protected

◆ latticeDensity_

template<typename LatticeModel_T , typename FlagFieldT >
real_t walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::latticeDensity_
protected

◆ noSlipFlag_

template<typename LatticeModel_T , typename FlagFieldT >
flag_t walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::noSlipFlag_
protected

◆ omega_

template<typename LatticeModel_T , typename FlagFieldT >
real_t walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::omega_
protected

◆ pdfs_

template<typename LatticeModel_T , typename FlagFieldT >
PDFField* walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::pdfs_
protected

◆ tau_

template<typename LatticeModel_T , typename FlagFieldT >
real_t walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::tau_
protected

◆ threadsafe

template<typename LatticeModel_T , typename FlagFieldT >
const bool walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::threadsafe = true
static

◆ uid_

template<typename LatticeModel_T , typename FlagFieldT >
FlagUID walberla::lbm::SimplePAB< LatticeModel_T, FlagFieldT >::uid_
protected

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