ViennaLS
Loading...
Searching...
No Matches
viennals::VTKWriter< T > Class Template Reference

Class handling the output of an Mesh<> to VTK file types. More...

#include <lsVTKWriter.hpp>

Public Member Functions

 VTKWriter ()=default
 VTKWriter (SmartPointer< Mesh< T > > passedMesh)
 VTKWriter (SmartPointer< Mesh< T > > passedMesh, std::string passedFileName)
 VTKWriter (SmartPointer< Mesh< T > > passedMesh, FileFormatEnum passedFormat, std::string passedFileName)
void setMesh (SmartPointer< Mesh< T > > passedMesh)
void setFileFormat (FileFormatEnum passedFormat)
 set file format for file to write. Defaults to VTK_LEGACY.
void setFileName (std::string passedFileName)
 set file name for file to write
void setMetaData (const std::unordered_map< std::string, std::vector< T > > &passedMetaData)
void addMetaData (const std::string &key, T value)
void addMetaData (const std::string &key, const std::vector< T > &values)
void addMetaData (const std::unordered_map< std::string, std::vector< T > > &newMetaData)
void apply ()

Detailed Description

template<class T>
class viennals::VTKWriter< T >

Class handling the output of an Mesh<> to VTK file types.

Constructor & Destructor Documentation

◆ VTKWriter() [1/4]

template<class T>
viennals::VTKWriter< T >::VTKWriter ( )
default

◆ VTKWriter() [2/4]

template<class T>
viennals::VTKWriter< T >::VTKWriter ( SmartPointer< Mesh< T > > passedMesh)
inline

◆ VTKWriter() [3/4]

template<class T>
viennals::VTKWriter< T >::VTKWriter ( SmartPointer< Mesh< T > > passedMesh,
std::string passedFileName )
inline

◆ VTKWriter() [4/4]

template<class T>
viennals::VTKWriter< T >::VTKWriter ( SmartPointer< Mesh< T > > passedMesh,
FileFormatEnum passedFormat,
std::string passedFileName )
inline

Member Function Documentation

◆ addMetaData() [1/3]

template<class T>
void viennals::VTKWriter< T >::addMetaData ( const std::string & key,
const std::vector< T > & values )
inline

◆ addMetaData() [2/3]

template<class T>
void viennals::VTKWriter< T >::addMetaData ( const std::string & key,
T value )
inline

◆ addMetaData() [3/3]

template<class T>
void viennals::VTKWriter< T >::addMetaData ( const std::unordered_map< std::string, std::vector< T > > & newMetaData)
inline

◆ apply()

template<class T>
void viennals::VTKWriter< T >::apply ( )
inline

◆ setFileFormat()

template<class T>
void viennals::VTKWriter< T >::setFileFormat ( FileFormatEnum passedFormat)
inline

set file format for file to write. Defaults to VTK_LEGACY.

◆ setFileName()

template<class T>
void viennals::VTKWriter< T >::setFileName ( std::string passedFileName)
inline

set file name for file to write

◆ setMesh()

template<class T>
void viennals::VTKWriter< T >::setMesh ( SmartPointer< Mesh< T > > passedMesh)
inline

◆ setMetaData()

template<class T>
void viennals::VTKWriter< T >::setMetaData ( const std::unordered_map< std::string, std::vector< T > > & passedMetaData)
inline
The documentation for this class was generated from the following file: