ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType > Class Template Reference

Base class for LB field VTK writers. More...

#include <LBVTK.impl.hpp>

+ Inheritance diagram for walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >:
+ Collaboration diagram for walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >:

Public Member Functions

 VTKWriter (ConstBlockDataID const &block_id, std::string const &id, FloatType unit_conversion)
 
void set_content (VecType content)
 
void set_dims (Vector3< uint_t > dims)
 

Protected Member Functions

void configure () override
 
std::size_t get_first_index (cell_idx_t const x, cell_idx_t const y, cell_idx_t const z)
 

Protected Attributes

FloatType m_conversion
 
VecType m_content
 
Vector3< uint_t > m_dims
 

Detailed Description

template<typename FloatType, typename VecType, uint_t F_SIZE_ARG, typename OutputType>
class walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >

Base class for LB field VTK writers.

Provides unit conversion and field access for cell-based VTK output. All field is copied to a Vector container before writing.

Template Parameters
FloatTypeInternal LB precision (float or double).
VecTypeVector type to copy the field data into.
F_SIZE_ARGNumber of components per cell (1, 3, or 9).
OutputTypeVTK output precision (default: float).

Definition at line 47 of file LBVTK.impl.hpp.

Constructor & Destructor Documentation

◆ VTKWriter()

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::VTKWriter ( ConstBlockDataID const &  block_id,
std::string const &  id,
FloatType  unit_conversion 
)
inline

Definition at line 49 of file LBVTK.impl.hpp.

Member Function Documentation

◆ configure()

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
void walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::configure ( )
inlineoverrideprotected

Definition at line 55 of file LBVTK.impl.hpp.

◆ get_first_index()

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
std::size_t walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::get_first_index ( cell_idx_t const  x,
cell_idx_t const  y,
cell_idx_t const  z 
)
inlineprotected

◆ set_content()

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
void walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::set_content ( VecType  content)
inline

◆ set_dims()

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
void walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::set_dims ( Vector3< uint_t >  dims)
inline

Member Data Documentation

◆ m_content

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
VecType walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::m_content
protected

◆ m_conversion

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
FloatType walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::m_conversion
protected

◆ m_dims

template<typename FloatType , typename VecType , uint_t F_SIZE_ARG, typename OutputType >
Vector3<uint_t> walberla::VTKWriter< FloatType, VecType, F_SIZE_ARG, OutputType >::m_dims
protected

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