walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType > Class Template Reference

Detailed Description

template<typename VelocityField_T, typename Filter_T, typename OutputType = float>
class walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >

lengthScaleWeight is only used to be able to derive quantities for the adaptive mesh refinement criterium of curl.

Template Parameters
VelocityField_T
Filter_T
OutputType

#include <CurlMagnitude.h>

+ Inheritance diagram for walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >:

Public Member Functions

 CurlMagnitudeVTKWriter (const shared_ptr< StructuredBlockStorage > blockStorage, Filter_T &filter, const ConstBlockDataID &velocityFieldId, const std::string &id, const real_t lengthScaleWeight=real_t(-1))
 
- Public Member Functions inherited from walberla::vtk::BlockCellDataWriter< float, 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...
 
OutputType 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< float, 1 >
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 shared_ptr< StructuredBlockStorageblockStorage_
 
Filter_T filter_
 
const ConstBlockDataID velocityFieldId_
 
const VelocityField_T * velocityField_
 
const real_t lengthScaleWeight_
 
- Protected Attributes inherited from walberla::vtk::internal::BlockCellDataWriter
const IBlockblock_
 
const StructuredBlockStorageblockStorage_
 
std::string identifier_
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ CurlMagnitudeVTKWriter()

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::CurlMagnitudeVTKWriter ( const shared_ptr< StructuredBlockStorage blockStorage,
Filter_T &  filter,
const ConstBlockDataID velocityFieldId,
const std::string &  id,
const real_t  lengthScaleWeight = real_t(-1) 
)
inline

Member Function Documentation

◆ configure()

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
void walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::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 VelocityField_T , typename Filter_T , typename OutputType = float>
OutputType walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::evaluate ( const cell_idx_t  x,
const cell_idx_t  y,
const cell_idx_t  z,
const  cell_idx_t 
)
inlineprotectedvirtual

Member Data Documentation

◆ blockStorage_

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
const shared_ptr<StructuredBlockStorage> walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::blockStorage_
protected

◆ filter_

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
Filter_T walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::filter_
protected

◆ lengthScaleWeight_

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
const real_t walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::lengthScaleWeight_
protected

◆ velocityField_

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
const VelocityField_T* walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::velocityField_
protected

◆ velocityFieldId_

template<typename VelocityField_T , typename Filter_T , typename OutputType = float>
const ConstBlockDataID walberla::lbm::CurlMagnitudeVTKWriter< VelocityField_T, Filter_T, OutputType >::velocityFieldId_
protected

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