Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Private Attributes | List of all members
walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator > Class Template Reference

#include <Outlet.h>

+ Inheritance diagram for walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >:

Public Member Functions

 Outlet (const BoundaryUID &boundaryUID, const FlagUID &uid, PDFField *const pdfField, const FlagField_T *const flagField, const flag_t domain)
 
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 &)
 
template<typename CellIterator >
void registerCells (const flag_t, const CellIterator &, const CellIterator &, const BoundaryConfiguration &)
 
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 BoundaryUID & getUID () const
 

Static Public Member Functions

static shared_ptr< BoundaryConfiguration > createConfiguration (const Config::BlockHandle &)
 

Static Public Attributes

static const bool threadsafe = true
 

Protected Types

using PDFField = PdfField< LatticeModel_T >
 
using Stencil = typename LatticeModel_T::Stencil
 
using flag_t = typename FlagField_T::flag_t
 

Private Attributes

const FlagUID uid_
 
flag_t domainMask_
 
PDFField *const pdfField_
 
const FlagField_T *const flagField_
 

Additional Inherited Members

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

Member Typedef Documentation

◆ flag_t

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
using walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::flag_t = typename FlagField_T::flag_t
protected

◆ PDFField

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
using walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::PDFField = PdfField<LatticeModel_T>
protected

◆ Stencil

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
using walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::Stencil = typename LatticeModel_T::Stencil
protected

Constructor & Destructor Documentation

◆ Outlet()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::Outlet ( const BoundaryUID &  boundaryUID,
const FlagUID &  uid,
PDFField *const  pdfField,
const FlagField_T *const  flagField,
const flag_t  domain 
)
inline

Member Function Documentation

◆ afterBoundaryTreatment()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::afterBoundaryTreatment ( ) const
inline

◆ beforeBoundaryTreatment()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::beforeBoundaryTreatment ( ) const
inline

◆ createConfiguration()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
static shared_ptr<BoundaryConfiguration> walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::createConfiguration ( const Config::BlockHandle &  )
inlinestatic

◆ packCell()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
template<typename Buffer_T >
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::packCell ( Buffer_T &  ,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t 
) const
inline

◆ pushFlags()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::pushFlags ( std::vector< FlagUID > &  uids) const
inline

◆ registerCell() [1/2]

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
template<typename Buffer_T >
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::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 FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::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 FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::registerCells ( const  flag_t,
const CellInterval &  ,
const BoundaryConfiguration &   
)
inline

◆ registerCells() [2/2]

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
template<typename CellIterator >
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::registerCells ( const  flag_t,
const CellIterator &  ,
const CellIterator &  ,
const BoundaryConfiguration &   
)
inline

◆ treatDirection()

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::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 FlagField_T , int Numerator = 2, int Denominator = 1>
void walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::unregisterCell ( const  flag_t,
const  cell_idx_t,
const  cell_idx_t,
const  cell_idx_t 
) const
inline

Member Data Documentation

◆ domainMask_

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
flag_t walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::domainMask_
private

◆ flagField_

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
const FlagField_T* const walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::flagField_
private

◆ pdfField_

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
PDFField* const walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::pdfField_
private

◆ threadsafe

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
const bool walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::threadsafe = true
static

◆ uid_

template<typename LatticeModel_T , typename FlagField_T , int Numerator = 2, int Denominator = 1>
const FlagUID walberla::lbm::Outlet< LatticeModel_T, FlagField_T, Numerator, Denominator >::uid_
private
The documentation for this class was generated from the following file: