walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter Class Reference

Detailed Description

template<typename Field_T, typename Filter_T = DefaultEvaluationFilter, typename CheckFunction_T = std::function<bool ( const typename Field_T::value_type & value )>>
class walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter

For each value of a cell, either '0' or '1' is stored in the VTK file.

If the value is non-finite (= infinite or NaN), '1' is written to file - otherwise '0'.

+ Inheritance diagram for walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter:

Public Member Functions

 FValueVTKWriter (BlockCellsMap &map, const std::string &id)
 
- Public Member Functions inherited from walberla::vtk::BlockCellDataWriter< uint8_t, Field_T::F_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...
 
uint8_t 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< uint8_t, Field_T::F_SIZE >
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)
 

Private Attributes

BlockCellsMapmap_
 

Additional Inherited Members

- Public Types inherited from walberla::vtk::BlockCellDataWriter< uint8_t, Field_T::F_SIZE >
using value_type = uint8_t
 
- Static Public Attributes inherited from walberla::vtk::BlockCellDataWriter< uint8_t, Field_T::F_SIZE >
static const uint_t F_SIZE
 
- Protected Attributes inherited from walberla::vtk::internal::BlockCellDataWriter
const IBlockblock_
 
const StructuredBlockStorageblockStorage_
 
std::string identifier_
 

Constructor & Destructor Documentation

◆ FValueVTKWriter()

template<typename Field_T , typename Filter_T = DefaultEvaluationFilter, typename CheckFunction_T = std::function<bool ( const typename Field_T::value_type & value )>>
walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter::FValueVTKWriter ( BlockCellsMap map,
const std::string &  id 
)
inline

Member Function Documentation

◆ configure()

template<typename Field_T , typename Filter_T = DefaultEvaluationFilter, typename CheckFunction_T = std::function<bool ( const typename Field_T::value_type & value )>>
void walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter::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 Field_T , typename Filter_T = DefaultEvaluationFilter, typename CheckFunction_T = std::function<bool ( const typename Field_T::value_type & value )>>
uint8_t walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter::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

◆ map_

template<typename Field_T , typename Filter_T = DefaultEvaluationFilter, typename CheckFunction_T = std::function<bool ( const typename Field_T::value_type & value )>>
BlockCellsMap& walberla::field::StabilityChecker< Field_T, Filter_T, CheckFunction_T >::FValueVTKWriter::map_
private

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