Ewoms::VtkMultiWriter< GridView, vtkFormat > Class Template Reference

Simplifies writing multi-file VTK datasets. More...

#include <vtkmultiwriter.hh>

Inheritance diagram for Ewoms::VtkMultiWriter< GridView, vtkFormat >:
Ewoms::BaseOutputWriter

Public Types

typedef BaseOutputWriter::Scalar Scalar
 
typedef BaseOutputWriter::Vector Vector
 
typedef BaseOutputWriter::Tensor Tensor
 
typedef BaseOutputWriter::ScalarBuffer ScalarBuffer
 
typedef BaseOutputWriter::VectorBuffer VectorBuffer
 
typedef BaseOutputWriter::TensorBuffer TensorBuffer
 
typedef Dune::VTKWriter< GridView > VtkWriter
 
typedef VtkWriter::VTKFunctionPtr FunctionPtr
 
- Public Types inherited from Ewoms::BaseOutputWriter
typedef double Scalar
 
typedef Dune::DynamicVector< double > Vector
 
typedef Dune::DynamicMatrix< double > Tensor
 
typedef std::vector< Scalar > ScalarBuffer
 
typedef std::vector< Vector > VectorBuffer
 
typedef std::vector< Tensor > TensorBuffer
 

Public Member Functions

 VtkMultiWriter (const GridView &gridView, const std::string &simName="", std::string multiFileName="")
 
int curWriterNum () const
 Returns the number of the current VTK file.
 
void gridChanged ()
 Updates the internal data structures after mesh refinement. More...
 
void beginWrite (double t)
 Called whenever a new time step must be written.
 
ScalarBuffer * allocateManagedScalarBuffer (size_t numEntities)
 Allocate a managed buffer for a scalar field. More...
 
VectorBuffer * allocateManagedVectorBuffer (size_t numOuter, size_t numInner)
 Allocate a managed buffer for a vector field. More...
 
void attachScalarVertexData (ScalarBuffer &buf, std::string name)
 Add a finished vertex centered vector field to the output. More...
 
void attachScalarElementData (ScalarBuffer &buf, std::string name)
 Add a element centered quantity to the output. More...
 
void attachVectorVertexData (VectorBuffer &buf, std::string name)
 Add a finished vertex centered vector field to the output. More...
 
void attachTensorVertexData (TensorBuffer &buf, std::string name)
 Add a finished vertex-centered tensor field to the output.
 
void attachVectorElementData (VectorBuffer &buf, std::string name)
 Add a element centered quantity to the output. More...
 
void attachTensorElementData (TensorBuffer &buf, std::string name)
 Add a finished element-centered tensor field to the output.
 
void endWrite (bool onlyDiscard=false)
 Finalizes the current writer. More...
 
template<class Restarter >
void serialize (Restarter &res)
 Write the multi-writer's state to a restart file.
 
template<class Restarter >
void deserialize (Restarter &res)
 Read the multi-writer's state from a restart file.
 

Detailed Description

template<class GridView, int vtkFormat>
class Ewoms::VtkMultiWriter< GridView, vtkFormat >

Simplifies writing multi-file VTK datasets.

This class automatically keeps the meta file up to date and simplifies writing datasets consisting of multiple files. (i.e. multiple time steps or grid refinements within a time step.)

Member Function Documentation

◆ allocateManagedScalarBuffer()

template<class GridView , int vtkFormat>
ScalarBuffer* Ewoms::VtkMultiWriter< GridView, vtkFormat >::allocateManagedScalarBuffer ( size_t  numEntities)
inline

Allocate a managed buffer for a scalar field.

The buffer will be deleted automatically after the data has been written by to disk.

◆ allocateManagedVectorBuffer()

template<class GridView , int vtkFormat>
VectorBuffer* Ewoms::VtkMultiWriter< GridView, vtkFormat >::allocateManagedVectorBuffer ( size_t  numOuter,
size_t  numInner 
)
inline

Allocate a managed buffer for a vector field.

The buffer will be deleted automatically after the data has been written by to disk.

◆ attachScalarElementData()

template<class GridView , int vtkFormat>
void Ewoms::VtkMultiWriter< GridView, vtkFormat >::attachScalarElementData ( ScalarBuffer &  buf,
std::string  name 
)
inlinevirtual

Add a element centered quantity to the output.

If the buffer is managed by the VtkMultiWriter, it must have been created using createField() and may not be used by anywhere after calling this method. After the data is written to disk, it will be deleted automatically.

If the buffer is not managed by the MultiWriter, the buffer must exist at least until the call to endWrite() finishes.

In both cases, modifying the buffer between the call to this method and endWrite() results in undefined behaviour.

Implements Ewoms::BaseOutputWriter.

◆ attachScalarVertexData()

template<class GridView , int vtkFormat>
void Ewoms::VtkMultiWriter< GridView, vtkFormat >::attachScalarVertexData ( ScalarBuffer &  buf,
std::string  name 
)
inlinevirtual

Add a finished vertex centered vector field to the output.

If the buffer is managed by the VtkMultiWriter, it must have been created using allocateManagedBuffer() and may not be used anywhere after calling this method. After the data is written to disk, it will be deleted automatically.

If the buffer is not managed by the MultiWriter, the buffer must exist at least until the call to endWrite() finishes.

In both cases, modifying the buffer between the call to this method and endWrite() results in undefined behavior.

Implements Ewoms::BaseOutputWriter.

◆ attachVectorElementData()

template<class GridView , int vtkFormat>
void Ewoms::VtkMultiWriter< GridView, vtkFormat >::attachVectorElementData ( VectorBuffer &  buf,
std::string  name 
)
inlinevirtual

Add a element centered quantity to the output.

If the buffer is managed by the VtkMultiWriter, it must have been created using createField() and may not be used by anywhere after calling this method. After the data is written to disk, it will be deleted automatically.

If the buffer is not managed by the MultiWriter, the buffer must exist at least until the call to endWrite() finishes.

In both cases, modifying the buffer between the call to this method and endWrite() results in undefined behaviour.

Implements Ewoms::BaseOutputWriter.

◆ attachVectorVertexData()

template<class GridView , int vtkFormat>
void Ewoms::VtkMultiWriter< GridView, vtkFormat >::attachVectorVertexData ( VectorBuffer &  buf,
std::string  name 
)
inlinevirtual

Add a finished vertex centered vector field to the output.

If the buffer is managed by the VtkMultiWriter, it must have been created using allocateManagedBuffer() and may not be used anywhere after calling this method. After the data is written to disk, it will be deleted automatically.

If the buffer is not managed by the MultiWriter, the buffer must exist at least until the call to endWrite() finishes.

In both cases, modifying the buffer between the call to this method and endWrite() results in undefined behavior.

Implements Ewoms::BaseOutputWriter.

◆ endWrite()

template<class GridView , int vtkFormat>
void Ewoms::VtkMultiWriter< GridView, vtkFormat >::endWrite ( bool  onlyDiscard = false)
inlinevirtual

Finalizes the current writer.

This means that everything will be written to disk, except if the onlyDiscard argument is true. In this case only all managed buffers are deleted, but no output is written.

Implements Ewoms::BaseOutputWriter.

◆ gridChanged()

template<class GridView , int vtkFormat>
void Ewoms::VtkMultiWriter< GridView, vtkFormat >::gridChanged ( )
inline

Updates the internal data structures after mesh refinement.

If the grid changes between two calls of beginWrite(), this method must be called before the second beginWrite()!


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