walberla::field::BinarizationFieldWriter< FieldType, TargetType > Class Template Reference

#include <FlagFieldMapping.h>

+ Inheritance diagram for walberla::field::BinarizationFieldWriter< FieldType, TargetType >:

Public Member Functions

 BinarizationFieldWriter (const ConstBlockDataID fieldID, const std::string &id, SrcType mask)
 
- Public Member Functions inherited from walberla::vtk::BlockCellDataWriter< uint8_t, 1 >
 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 ()
 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...
 
TargetType evaluate (const cell_idx_t x, const cell_idx_t y, const cell_idx_t z, const cell_idx_t)
 
- Protected Member Functions inherited from walberla::vtk::BlockCellDataWriter< uint8_t, 1 >
virtual uint8_t 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 fieldID_
 
const FieldType * field_
 
SrcType mask_
 
- Protected Attributes inherited from walberla::vtk::internal::BlockCellDataWriter
const IBlockblock_
 
const StructuredBlockStorageblockStorage_
 
std::string identifier_
 

Private Types

using SrcType = typename FieldType::value_type
 

Additional Inherited Members

- Public Types inherited from walberla::vtk::BlockCellDataWriter< uint8_t, 1 >
using value_type = uint8_t
 
- Static Public Attributes inherited from walberla::vtk::BlockCellDataWriter< uint8_t, 1 >
static const uint_t F_SIZE
 

Member Typedef Documentation

◆ SrcType

template<typename FieldType , typename TargetType = uint8_t>
using walberla::field::BinarizationFieldWriter< FieldType, TargetType >::SrcType = typename FieldType::value_type
private

Constructor & Destructor Documentation

◆ BinarizationFieldWriter()

template<typename FieldType , typename TargetType = uint8_t>
walberla::field::BinarizationFieldWriter< FieldType, TargetType >::BinarizationFieldWriter ( const ConstBlockDataID  fieldID,
const std::string &  id,
SrcType  mask 
)
inline

Member Function Documentation

◆ configure()

template<typename FieldType , typename TargetType = uint8_t>
void walberla::field::BinarizationFieldWriter< FieldType, TargetType >::configure ( )
inlineprotectedvirtual

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 FieldType , typename TargetType = uint8_t>
TargetType walberla::field::BinarizationFieldWriter< FieldType, TargetType >::evaluate ( const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z,
const  cell_idx_t 
)
inlineprotectedvirtual

Member Data Documentation

◆ field_

template<typename FieldType , typename TargetType = uint8_t>
const FieldType* walberla::field::BinarizationFieldWriter< FieldType, TargetType >::field_
protected

◆ fieldID_

template<typename FieldType , typename TargetType = uint8_t>
const ConstBlockDataID walberla::field::BinarizationFieldWriter< FieldType, TargetType >::fieldID_
protected

◆ mask_

template<typename FieldType , typename TargetType = uint8_t>
SrcType walberla::field::BinarizationFieldWriter< FieldType, TargetType >::mask_
protected

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