walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType > Class Template Reference

#include <NonEquilibrium.h>

+ Inheritance diagram for walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >:

Public Types

using PdfField_T = PdfField< LatticeModel_T >
 
using Stencil = typename LatticeModel_T::Stencil
 
- Public Types inherited from walberla::vtk::BlockCellDataWriter< float, LatticeModel_T::Stencil::Size >
using value_type = float
 

Public Member Functions

 NonEqulibriumVTKWriter (const ConstBlockDataID &pdf, const std::string &id)
 
- Public Member Functions inherited from walberla::vtk::BlockCellDataWriter< float, LatticeModel_T::Stencil::Size >
 BlockCellDataWriter (const std::string &id)
 
 ~BlockCellDataWriter () override=default
 
void push (std::ostream &os, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t f) override
 For the documentation of this function, please refer to the documentation/general description of this class. More...
 
void push (vtk::Base64Writer &b64, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t f) override
 For the documentation of this function, please refer to the documentation/general description of this class. More...
 
void push (std::ostream &os, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t f, const real_t localXCell, const real_t localYCell, const real_t localZCell, const real_t globalX, const real_t globalY, const real_t globalZ, const real_t samplingDx, const real_t samplingDy, const real_t samplingDz) override
 For the documentation of this function, please refer to the documentation/general description of this class. More...
 
void push (Base64Writer &b64, const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t f, const real_t localXCell, const real_t localYCell, const real_t localZCell, const real_t globalX, const real_t globalY, const real_t globalZ, const real_t samplingDx, const real_t samplingDy, const real_t samplingDz) override
 For the documentation of this function, please refer to the documentation/general description of this class. More...
 
uint_t fSize () const override
 must return the size of the fourth dimension More...
 
std::string typeString () const override
 Every data type is assigned a specific string in VTK. More...
 
- Public Member Functions inherited from walberla::vtk::internal::BlockCellDataWriter
 BlockCellDataWriter (const std::string &id)
 
void configure (const IBlock &block, const StructuredBlockStorage &sbs)
 
uint_t xSize () const
 
uint_t ySize () const
 
uint_t zSize () const
 
virtual uint_t fSize () const =0
 must return the size of the fourth dimension More...
 
virtual std::string typeString () const =0
 Every data type is assigned a specific string in VTK. More...
 
const std::string & identifier () const
 

Protected Member Functions

void configure () override
 Every time "configure( const IBlock& block, const StructuredBlockStorage& sbs )" is called, the block and its corresponding structured block storage assigned to the BlockCellDataWriter may change. More...
 
OutputType evaluate (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t f) override
 
- Protected Member Functions inherited from walberla::vtk::BlockCellDataWriter< float, LatticeModel_T::Stencil::Size >
virtual float evaluate (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t f, const real_t localXCell, const real_t localYCell, const real_t localZCell, const real_t globalX, const real_t globalY, const real_t globalZ, const real_t samplingDx, const real_t samplingDy, const real_t samplingDz)
 
- Protected Member Functions inherited from walberla::vtk::internal::BlockCellDataWriter
void setIdentifier (const std::string &id)
 

Protected Attributes

const ConstBlockDataID bdid_
 
const PdfField_Tpdf_
 
- Protected Attributes inherited from walberla::vtk::internal::BlockCellDataWriter
const IBlockblock_
 
const StructuredBlockStorageblockStorage_
 
std::string identifier_
 

Additional Inherited Members

- Static Public Attributes inherited from walberla::vtk::BlockCellDataWriter< float, LatticeModel_T::Stencil::Size >
static const uint_t F_SIZE
 

Member Typedef Documentation

◆ PdfField_T

template<typename LatticeModel_T , typename OutputType = float>
using walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::PdfField_T = PdfField<LatticeModel_T>

◆ Stencil

template<typename LatticeModel_T , typename OutputType = float>
using walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::Stencil = typename LatticeModel_T::Stencil

Constructor & Destructor Documentation

◆ NonEqulibriumVTKWriter()

template<typename LatticeModel_T , typename OutputType = float>
walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::NonEqulibriumVTKWriter ( const ConstBlockDataID pdf,
const std::string &  id 
)
inline

Member Function Documentation

◆ configure()

template<typename LatticeModel_T , typename OutputType = float>
void walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::configure ( )
inlineoverrideprotectedvirtual

Every time "configure( const IBlock& block, const StructuredBlockStorage& sbs )" is called, the block and its corresponding structured block storage assigned to the BlockCellDataWriter may change.

This triggers the call of this function which must be implemented and is intended for reacting to these changes.

Implements walberla::vtk::internal::BlockCellDataWriter.

◆ evaluate()

template<typename LatticeModel_T , typename OutputType = float>
OutputType walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::evaluate ( const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z,
const cell_idx_t  f 
)
inlineoverrideprotectedvirtual

Member Data Documentation

◆ bdid_

template<typename LatticeModel_T , typename OutputType = float>
const ConstBlockDataID walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::bdid_
protected

◆ pdf_

template<typename LatticeModel_T , typename OutputType = float>
const PdfField_T* walberla::lbm::NonEqulibriumVTKWriter< LatticeModel_T, OutputType >::pdf_
protected

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