walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce > Class Template Reference

#include <UBB.h>

+ Inheritance diagram for walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >:

Classes

class  Velocity
 

Public Member Functions

 UBB (const BoundaryUID &boundaryUID, const FlagUID &uid, PDFField *const pdfField, FlagField< flag_t > *const flagField=nullptr)
 
void pushFlags (std::vector< FlagUID > &uids) const
 
void beforeBoundaryTreatment () const
 
void afterBoundaryTreatment () const
 
template<typename Buffer_T >
void packCell (Buffer_T &buffer, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z) const
 
template<typename Buffer_T >
void registerCell (Buffer_T &buffer, const flag_t, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z)
 
void registerCell (const flag_t, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const BoundaryConfiguration &velocity)
 
void registerCells (const flag_t, const CellInterval &cells, const BoundaryConfiguration &velocity)
 
template<typename CellIterator >
void registerCells (const flag_t, const CellIterator &begin, const CellIterator &end, const BoundaryConfiguration &velocity)
 
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)
 
const Vector3< real_t > & getValue (const cell_idx_t x, cell_idx_t y, cell_idx_t z) const
 
const ForceField::value_typegetForce (const cell_idx_t x, cell_idx_t y, cell_idx_t z) const
 
- 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< VelocitycreateConfiguration (const Config::BlockHandle &config)
 

Static Public Attributes

static const bool threadsafe = true
 

Private Types

using PDFField = PdfField< LatticeModel_T >
 
using Stencil = typename LatticeModel_T::Stencil
 
using VelField = GhostLayerField< Vector3< real_t >, 1 >
 
using ForceField = GhostLayerField< Vector3< real_t >, 1 >
 

Private Attributes

const FlagUID uid_
 
PDFField *const pdfField_
 
shared_ptr< VelFieldvel_
 
shared_ptr< ForceFieldforce_
 

Additional Inherited Members

- Protected Attributes inherited from walberla::boundary::Boundary< flag_t >
const BoundaryUID boundaryUID_
 
flag_t mask_
 
bool maskSet_
 

Member Typedef Documentation

◆ ForceField

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
using walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::ForceField = GhostLayerField<Vector3<real_t>, 1>
private

◆ PDFField

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
using walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::PDFField = PdfField<LatticeModel_T>
private

◆ Stencil

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
using walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::Stencil = typename LatticeModel_T::Stencil
private

◆ VelField

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
using walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::VelField = GhostLayerField<Vector3<real_t>, 1>
private

Constructor & Destructor Documentation

◆ UBB()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::UBB ( const BoundaryUID &  boundaryUID,
const FlagUID &  uid,
PDFField *const  pdfField,
FlagField< flag_t > *const  flagField = nullptr 
)
inline

Member Function Documentation

◆ afterBoundaryTreatment()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::afterBoundaryTreatment ( ) const
inline

◆ beforeBoundaryTreatment()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::beforeBoundaryTreatment
inline

◆ createConfiguration()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
static shared_ptr<Velocity> walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::createConfiguration ( const Config::BlockHandle config)
inlinestatic

◆ getForce()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
const ForceField::value_type& walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::getForce ( const cell_idx_t  x,
cell_idx_t  y,
cell_idx_t  z 
) const
inline

◆ getValue()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
const Vector3<real_t>& walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::getValue ( const cell_idx_t  x,
cell_idx_t  y,
cell_idx_t  z 
) const
inline

◆ packCell()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
template<typename Buffer_T >
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::packCell ( Buffer_T &  buffer,
const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z 
) const
inline

◆ pushFlags()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::pushFlags ( std::vector< FlagUID > &  uids) const
inline

◆ registerCell() [1/2]

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
template<typename Buffer_T >
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::registerCell ( Buffer_T &  buffer,
const  flag_t,
const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z 
)
inline

◆ registerCell() [2/2]

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::registerCell ( const  flag_t,
const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z,
const BoundaryConfiguration velocity 
)
inline

◆ registerCells() [1/2]

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::registerCells ( const  flag_t,
const CellInterval cells,
const BoundaryConfiguration velocity 
)
inline

◆ registerCells() [2/2]

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
template<typename CellIterator >
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::registerCells ( const  flag_t,
const CellIterator &  begin,
const CellIterator &  end,
const BoundaryConfiguration velocity 
)
inline

◆ treatDirection()

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce, bool StoreForce>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::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 flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
void walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::unregisterCell ( const  flag_t,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t 
) const
inline

Member Data Documentation

◆ force_

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
shared_ptr<ForceField> walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::force_
private

◆ pdfField_

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
PDFField* const walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::pdfField_
private

◆ threadsafe

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
const bool walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::threadsafe = true
static

◆ uid_

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
const FlagUID walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::uid_
private

◆ vel_

template<typename LatticeModel_T , typename flag_t , bool AdaptVelocityToExternalForce = false, bool StoreForce = false>
shared_ptr<VelField> walberla::lbm::UBB< LatticeModel_T, flag_t, AdaptVelocityToExternalForce, StoreForce >::vel_
private

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