dune-vtk 2.8
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dune::VtkUnstructuredGridWriter< GridView, DataCollector > Class Template Reference

File-Writer for VTK .vtu files. More...

#include <dune/vtk/writers/vtkunstructuredgridwriter.hh>

Inheritance diagram for Dune::VtkUnstructuredGridWriter< GridView, DataCollector >:
Inheritance graph

Public Types

using GridView = GV
 
using DataCollector = DC
 

Public Member Functions

virtual std::string write (std::string const &fn, std::optional< std::string > dir={}) const override
 Write the attached data to the file. More...
 
template<class Function , class... Args>
VtkWriterInterfaceaddPointData (Function &&fct, Args &&... args)
 Attach point data to the writer. More...
 
template<class Function , class... Args>
VtkWriterInterfaceaddCellData (Function &&fct, Args &&... args)
 Attach cell data to the writer. More...
 
void setFormat (Vtk::FormatTypes format)
 
void setDatatype (Vtk::DataTypes datatype)
 Sets the global datatype used for coordinates and other global float values. More...
 
void setHeadertype (Vtk::DataTypes datatype)
 Sets the integer type used in binary data headers. More...
 
void setCompressor (Vtk::CompressorTypes compressor, int level=-1)
 

Protected Types

enum  PositionTypes { POINT_DATA , CELL_DATA }
 
using VtkFunction = Dune::Vtk::Function< GridView >
 

Protected Member Functions

void writeData (std::ofstream &out, std::vector< pos_type > &offsets, VtkFunction const &fct, PositionTypes type, std::optional< std::size_t > timestep={}) const
 
void writeDataAppended (std::ofstream &out, std::vector< std::uint64_t > &blocks) const
 
void writePoints (std::ofstream &out, std::vector< pos_type > &offsets, std::optional< std::size_t > timestep={}) const
 
void writeAppended (std::ofstream &out, std::vector< pos_type > const &offsets) const
 
template<class HeaderType , class FloatType >
std::uint64_t writeValuesAppended (std::ofstream &out, std::vector< FloatType > const &values) const
 
template<class T >
void writeValuesAscii (std::ofstream &out, std::vector< T > const &values) const
 
void writeHeader (std::ofstream &out, std::string const &type) const
 
std::string getNames (std::vector< VtkFunction > const &data) const
 Return PointData/CellData attributes for the name of the first scalar/vector/tensor DataArray. More...
 
std::string getEndian () const
 
std::string getFileExtension () const
 
Vtk::FormatTypes getFormat () const
 
Vtk::DataTypes getDatatype () const
 
auto comm () const
 

Protected Attributes

Vtk::CompressorTypes compressor_ = Vtk::CompressorTypes::NONE
 
std::size_t const block_size = 1024*32
 
int compression_level = -1
 

Detailed Description

template<class GridView, class DataCollector = Vtk::ContinuousDataCollector<GridView>>
class Dune::VtkUnstructuredGridWriter< GridView, DataCollector >

File-Writer for VTK .vtu files.

Requirement:

Member Typedef Documentation

◆ DataCollector

template<class GV , class DC >
using Dune::VtkWriterInterface< GV, DC >::DataCollector = DC
inherited

◆ GridView

template<class GV , class DC >
using Dune::VtkWriterInterface< GV, DC >::GridView = GV
inherited

◆ VtkFunction

template<class GV , class DC >
using Dune::VtkWriterInterface< GV, DC >::VtkFunction = Dune::Vtk::Function<GridView>
protectedinherited

Member Enumeration Documentation

◆ PositionTypes

template<class GV , class DC >
enum Dune::VtkWriterInterface::PositionTypes
protectedinherited
Enumerator
POINT_DATA 
CELL_DATA 

Member Function Documentation

◆ addCellData()

template<class GV , class DC >
template<class Function , class... Args>
VtkWriterInterface & Dune::VtkWriterInterface< GV, DC >::addCellData ( Function &&  fct,
Args &&...  args 
)
inlineinherited

Attach cell data to the writer.

Attach a global function to the writer that will be evaluated at cell centers. The global function must be assignable to the function wrapper Vtk::Function. Additional argument for output datatype and number of components can be passed. See Vtk::Function Constructor for possible arguments.

Parameters
fctA GridFunction, LocalFunction, or Dune::VTKFunction
args...Additional arguments, like name, numComponents, dataType or Vtk::FieldInfo

◆ addPointData()

template<class GV , class DC >
template<class Function , class... Args>
VtkWriterInterface & Dune::VtkWriterInterface< GV, DC >::addPointData ( Function &&  fct,
Args &&...  args 
)
inlineinherited

Attach point data to the writer.

Attach a global function to the writer that will be evaluated at grid points (vertices and higher order points). The global function must be assignable to the function wrapper Vtk::Function. Additional argument for output datatype and number of components can be passed. See Vtk::Function Constructor for possible arguments.

Parameters
fctA GridFunction, LocalFunction, or Dune::VTKFunction
args...Additional arguments, like name, numComponents, dataType or Vtk::FieldInfo

◆ comm()

template<class GV , class DC >
auto Dune::VtkWriterInterface< GV, DC >::comm ( ) const
inlineprotectedinherited

◆ getDatatype()

template<class GV , class DC >
Vtk::DataTypes Dune::VtkWriterInterface< GV, DC >::getDatatype ( ) const
inlineprotectedinherited

◆ getEndian()

template<class GV , class DC >
std::string Dune::VtkWriterInterface< GV, DC >::getEndian ( ) const
inlineprotectedinherited

◆ getFileExtension()

template<class GV , class DC >
std::string Dune::VtkWriterInterface< GV, DC >::getFileExtension ( ) const
inlineprotectedinherited

◆ getFormat()

template<class GV , class DC >
Vtk::FormatTypes Dune::VtkWriterInterface< GV, DC >::getFormat ( ) const
inlineprotectedinherited

◆ getNames()

template<class GV , class DC >
std::string Dune::VtkWriterInterface< GV, DC >::getNames ( std::vector< VtkFunction > const &  data) const
protectedinherited

Return PointData/CellData attributes for the name of the first scalar/vector/tensor DataArray.

◆ setCompressor()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::setCompressor ( Vtk::CompressorTypes  compressor,
int  level = -1 
)
inlineinherited

Sets the compressor type used in binary data headers, Additionally a compression level can be passed with level = -1 means: default compression level. Level must be in [0-9]

◆ setDatatype()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::setDatatype ( Vtk::DataTypes  datatype)
inlineinherited

Sets the global datatype used for coordinates and other global float values.

◆ setFormat()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::setFormat ( Vtk::FormatTypes  format)
inlineinherited

◆ setHeadertype()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::setHeadertype ( Vtk::DataTypes  datatype)
inlineinherited

Sets the integer type used in binary data headers.

◆ write()

template<class GV , class DC >
std::string Dune::VtkWriterInterface< GV, DC >::write ( std::string const &  fn,
std::optional< std::string >  dir = {} 
) const
overridevirtualinherited

Write the attached data to the file.

Parameters
fnFilename of the VTK file. May contain a directory and any file extension.
dirThe optional parameter specifies the directory of the partition files for parallel writes.
Returns
File name that is actually written.

Implements Dune::Vtk::FileWriter.

◆ writeAppended()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::writeAppended ( std::ofstream &  out,
std::vector< pos_type > const &  offsets 
) const
protectedinherited

◆ writeData()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::writeData ( std::ofstream &  out,
std::vector< pos_type > &  offsets,
VtkFunction const &  fct,
PositionTypes  type,
std::optional< std::size_t >  timestep = {} 
) const
protectedinherited

◆ writeDataAppended()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::writeDataAppended ( std::ofstream &  out,
std::vector< std::uint64_t > &  blocks 
) const
protectedinherited

◆ writeHeader()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::writeHeader ( std::ofstream &  out,
std::string const &  type 
) const
protectedinherited

◆ writePoints()

template<class GV , class DC >
void Dune::VtkWriterInterface< GV, DC >::writePoints ( std::ofstream &  out,
std::vector< pos_type > &  offsets,
std::optional< std::size_t >  timestep = {} 
) const
protectedinherited

◆ writeValuesAppended()

template<class GV , class DC >
template<class HeaderType , class FloatType >
std::uint64_t Dune::VtkWriterInterface< GV, DC >::writeValuesAppended ( std::ofstream &  out,
std::vector< FloatType > const &  values 
) const
protectedinherited

◆ writeValuesAscii()

template<class GV , class DC >
template<class T >
void Dune::VtkWriterInterface< GV, DC >::writeValuesAscii ( std::ofstream &  out,
std::vector< T > const &  values 
) const
protectedinherited

Member Data Documentation

◆ block_size

template<class GV , class DC >
std::size_t const Dune::VtkWriterInterface< GV, DC >::block_size = 1024*32
protectedinherited

◆ compression_level

template<class GV , class DC >
int Dune::VtkWriterInterface< GV, DC >::compression_level = -1
protectedinherited

◆ compressor_

template<class GV , class DC >
Vtk::CompressorTypes Dune::VtkWriterInterface< GV, DC >::compressor_ = Vtk::CompressorTypes::NONE
protectedinherited

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