A VTK output module to simplify writing dumux simulation data to VTK format.
More...
#include <dumux/io/vtkoutputmodule.hh>
template<class GridGeometry>
class Dumux::VtkOutputModuleBase< GridGeometry >
- Note
- This is a base class providing only rudimentary features
|
using | Field = Vtk::template Field<GridView> |
| the type of Field that can be added to this writer
|
|
|
| VtkOutputModuleBase (const GridGeometry &gridGeometry, const std::string &name, const std::string ¶mGroup="", Dune::VTK::DataMode dm=Dune::VTK::conforming, bool verbose=true) |
|
virtual | ~VtkOutputModuleBase ()=default |
|
const std::string & | paramGroup () const |
| the parameter group for getting parameter from the parameter tree
|
|
template<typename Vector > |
void | addField (const Vector &v, const std::string &name, Vtk::FieldType fieldType=Vtk::FieldType::automatic) |
| Add a scalar or vector valued vtk field.
|
|
template<typename Vector > |
void | addField (const Vector &v, const std::string &name, Dumux::Vtk::Precision precision, Vtk::FieldType fieldType=Vtk::FieldType::automatic) |
| Add a scalar or vector valued vtk field.
|
|
void | addField (Field &&field) |
| Add a scalar or vector valued vtk field.
|
|
void | write (double time, Dune::VTK::OutputType type=Dune::VTK::ascii) |
|
◆ Field
template<class GridGeometry >
◆ VtkOutputModuleBase()
template<class GridGeometry >
Dumux::VtkOutputModuleBase< GridGeometry >::VtkOutputModuleBase |
( |
const GridGeometry & | gridGeometry, |
|
|
const std::string & | name, |
|
|
const std::string & | paramGroup = "", |
|
|
Dune::VTK::DataMode | dm = Dune::VTK::conforming, |
|
|
bool | verbose = true ) |
|
inline |
◆ ~VtkOutputModuleBase()
template<class GridGeometry >
◆ addField() [1/3]
template<class GridGeometry >
template<typename Vector >
- Parameters
-
v | The field to be added. Can be any indexable container. Its value type can be a number or itself an indexable container. |
name | The name of the field |
fieldType | The type of the field. This determines whether the values are associated with vertices or elements. By default, the method automatically deduces the correct type for the given input. |
precision | The output precision of this field (see Dune::VTK::Precision) |
◆ addField() [2/3]
template<class GridGeometry >
template<typename Vector >
- Parameters
-
v | The field to be added. Can be any indexable container. Its value type can be a number or itself an indexable container. |
name | The name of the field |
fieldType | The type of the field. This determines whether the values are associated with vertices or elements. By default, the method automatically deduces the correct type for the given input. |
◆ addField() [3/3]
template<class GridGeometry >
- Parameters
-
field | The parameters passed on to the field constructor |
◆ dataMode()
template<class GridGeometry >
◆ fields()
template<class GridGeometry >
◆ gridGeometry()
template<class GridGeometry >
◆ name()
template<class GridGeometry >
◆ paramGroup()
template<class GridGeometry >
◆ precision()
template<class GridGeometry >
◆ sequenceWriter()
template<class GridGeometry >
◆ verbose()
template<class GridGeometry >
◆ write()
template<class GridGeometry >
Write the data for this timestep to file in four steps (1) We assemble all registered variable fields (2) We register them with the vtk writer (3) The writer writes the output for us (4) Clear the writer for the next time step
output
◆ writer()
template<class GridGeometry >
The documentation for this class was generated from the following file: