walberla::v8::memory::FieldVtkWriter< TField, TOutput > Class Template Reference

#include <FieldVtkExport.hpp>

Inheritance diagram for walberla::v8::memory::FieldVtkWriter< TField, TOutput >:

Public Types
using	Base = vtk::BlockCellDataWriter< TOutput, TField::F_SIZE >
using	FieldType = TField
using	ViewType = memory::ConstFieldViewType< FieldType >
using	OutputType = TOutput
Public Types inherited from walberla::vtk::BlockCellDataWriter< TOutput, TField::F_SIZE >
using	value_type

Public Member Functions
	FieldVtkWriter (const FieldType &field, const std::string &outputId)
Public Member Functions inherited from walberla::vtk::BlockCellDataWriter< TOutput, TField::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.
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.
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.
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.
uint_t	fSize () const override
	must return the size of the fourth dimension
std::string	typeString () const override
	Every data type is assigned a specific string in VTK.
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
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.
OutputType	evaluate (cell_idx_t x, cell_idx_t y, cell_idx_t z, cell_idx_t f) override
virtual TOutput	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
FieldType	field_
std::optional< ViewType >	view_

Additional Inherited Members
Static Public Attributes inherited from walberla::vtk::BlockCellDataWriter< TOutput, TField::F_SIZE >
static const uint_t	F_SIZE
Protected Attributes inherited from walberla::vtk::internal::BlockCellDataWriter
const IBlock *	block_
const StructuredBlockStorage *	blockStorage_
std::string	identifier_

Member Typedef Documentation

Base

template<IField TField, typename TOutput>

using walberla::v8::memory::FieldVtkWriter< TField, TOutput >::Base = vtk::BlockCellDataWriter< TOutput, TField::F_SIZE >

FieldType

template<IField TField, typename TOutput>

using walberla::v8::memory::FieldVtkWriter< TField, TOutput >::FieldType = TField

OutputType

template<IField TField, typename TOutput>

using walberla::v8::memory::FieldVtkWriter< TField, TOutput >::OutputType = TOutput

ViewType

template<IField TField, typename TOutput>

using walberla::v8::memory::FieldVtkWriter< TField, TOutput >::ViewType = memory::ConstFieldViewType< FieldType >

Constructor & Destructor Documentation

FieldVtkWriter()

template<IField TField, typename TOutput>

walberla::v8::memory::FieldVtkWriter< TField, TOutput >::FieldVtkWriter ( const FieldType & field, const std::string & outputId )

inline

Member Function Documentation

configure()

template<IField TField, typename TOutput>

void walberla::v8::memory::FieldVtkWriter< TField, TOutput >::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() [1/2]

template<IField TField, typename TOutput>

OutputType walberla::v8::memory::FieldVtkWriter< TField, TOutput >::evaluate ( cell_idx_t x, cell_idx_t y, cell_idx_t z, cell_idx_t f )

inlineoverrideprotectedvirtual

Implements walberla::vtk::BlockCellDataWriter< TOutput, TField::F_SIZE >.

evaluate() [2/2]

template<IField TField, typename TOutput>

virtual TOutput walberla::vtk::BlockCellDataWriter< TOutput, F_SIZE_ARG >::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 )

protectedvirtual

Reimplemented from walberla::vtk::BlockCellDataWriter< TOutput, TField::F_SIZE >.

Member Data Documentation

field_

template<IField TField, typename TOutput>

FieldType walberla::v8::memory::FieldVtkWriter< TField, TOutput >::field_

private

view_

template<IField TField, typename TOutput>

std::optional< ViewType > walberla::v8::memory::FieldVtkWriter< TField, TOutput >::view_

private

---

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

• /builds/administration/walberla-website/walberla/include/walberla/v8/memory/FieldVtkExport.hpp