Simplifies writing multi-file VTK datasets. More...
#include <vtkmultiwriter.hh>
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 |
Public Member Functions | |
| VtkMultiWriter (const GridView &gridView, const std::string &simName="", std::string multiFileName="") | |
| ~VtkMultiWriter () | |
| int | curWriterNum () const |
| Returns the number of the current VTK file. More... | |
| void | gridChanged () |
| Updates the internal data structures after mesh refinement. More... | |
| void | beginWrite (double t) |
| Called whenever a new time step must be written. More... | |
| ScalarBuffer * | allocateManagedScalarBuffer (int numEntities) |
| Allocate a managed buffer for a scalar field. More... | |
| VectorBuffer * | allocateManagedVectorBuffer (int numOuter, int 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. More... | |
| 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. More... | |
| 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. More... | |
| template<class Restarter > | |
| void | deserialize (Restarter &res) |
| Read the multi-writer's state from a restart file. More... | |
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 Typedef Documentation
| typedef BaseOutputWriter::Scalar Ewoms::VtkMultiWriter< GridView, vtkFormat >::Scalar |
| typedef BaseOutputWriter::ScalarBuffer Ewoms::VtkMultiWriter< GridView, vtkFormat >::ScalarBuffer |
| typedef BaseOutputWriter::Tensor Ewoms::VtkMultiWriter< GridView, vtkFormat >::Tensor |
| typedef BaseOutputWriter::TensorBuffer Ewoms::VtkMultiWriter< GridView, vtkFormat >::TensorBuffer |
| typedef BaseOutputWriter::Vector Ewoms::VtkMultiWriter< GridView, vtkFormat >::Vector |
| typedef BaseOutputWriter::VectorBuffer Ewoms::VtkMultiWriter< GridView, vtkFormat >::VectorBuffer |
| typedef Dune::VTKWriter<GridView> Ewoms::VtkMultiWriter< GridView, vtkFormat >::VtkWriter |
Constructor & Destructor Documentation
|
inline |
|
inline |
Member Function Documentation
|
inline |
Allocate a managed buffer for a scalar field.
The buffer will be deleted automatically after the data has been written by to disk.
Referenced by Ewoms::FvBaseDiscretization< TypeTag >::addConvergenceVtkFields(), and Ewoms::StokesModel< TypeTag >::appendOutputFields().
|
inline |
Allocate a managed buffer for a vector field.
The buffer will be deleted automatically after the data has been written by to disk.
Referenced by Ewoms::StokesModel< TypeTag >::appendOutputFields().
|
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.
|
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.
Referenced by Ewoms::StokesModel< TypeTag >::appendOutputFields().
|
inlinevirtual |
Add a finished element-centered tensor field to the output.
Implements Ewoms::BaseOutputWriter.
|
inlinevirtual |
Add a finished vertex-centered tensor field to the output.
Implements Ewoms::BaseOutputWriter.
|
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.
|
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.
Referenced by Ewoms::StokesModel< TypeTag >::appendOutputFields().
|
inlinevirtual |
Called whenever a new time step must be written.
Implements Ewoms::BaseOutputWriter.
Referenced by Ewoms::FvBaseNewtonConvergenceWriter< TypeTag >::beginIteration(), and Ewoms::FvBaseProblem< TypeTag >::writeOutput().
|
inline |
Returns the number of the current VTK file.
|
inline |
Read the multi-writer's state from a restart file.
Referenced by Ewoms::FvBaseProblem< TypeTag >::deserialize().
|
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.
Referenced by Ewoms::FvBaseNewtonConvergenceWriter< TypeTag >::endIteration(), and Ewoms::FvBaseProblem< TypeTag >::writeOutput().
|
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()!
|
inline |
Write the multi-writer's state to a restart file.
Referenced by Ewoms::FvBaseProblem< TypeTag >::serialize().
The documentation for this class was generated from the following file: