A VTK output module to simplify writing dumux simulation data to VTK format Specialization for staggered grids with dofs on faces.
More...
#include <dumux/io/staggeredvtkoutputmodule.hh>
template<class GridVariables, class SolutionVector>
class Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >
- Template Parameters
-
GridVariables | The grid variables |
SolutionVector | The solution vector |
|
using | Field = Vtk::template Field< GridView > |
| the type of Field that can be added to this writer
|
|
using | VolumeVariables = VV |
| export type of the volume variables for the outputfields
|
|
|
template<class Sol > |
| StaggeredVtkOutputModule (const GridVariables &gridVariables, const Sol &sol, const std::string &name, const std::string ¶mGroup="", Dune::VTK::DataMode dm=Dune::VTK::conforming, bool verbose=true) |
|
void | addFaceField (const std::vector< Scalar > &v, const std::string &name) |
|
void | addFaceField (const std::vector< GlobalPosition > &v, const std::string &name) |
|
void | addFaceVariable (std::function< Scalar(const FaceVariables &)> &&f, const std::string &name) |
|
void | addFaceVariable (std::function< GlobalPosition(const SubControlVolumeFace &scvf, const FaceVariables &)> &&f, const std::string &name) |
|
void | write (double time, Dune::VTK::OutputType type=Dune::VTK::ascii) |
|
void | addVelocityOutput (std::shared_ptr< VelocityOutputType > velocityOutput) |
| Add a velocity output policy.
|
|
void | addVolumeVariable (std::function< Scalar(const VolumeVariables &)> &&f, const std::string &name) |
|
template<class VVV = VolVarsVector, typename std::enable_if_t<(VVV::dimension > 1), int > = 0> |
void | addVolumeVariable (std::function< VolVarsVector(const VolumeVariables &)> &&f, const std::string &name) |
|
const std::string & | paramGroup () const |
| the parameter group for getting parameter from the parameter tree
|
|
void | addField (const Vector &v, const std::string &name, Vtk::FieldType fieldType=Vtk::FieldType::automatic) |
| Add a scalar or vector valued vtk field.
|
|
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.
|
|
◆ Field
template<class GridVariables , class SolutionVector >
◆ VelocityOutput
template<class GridVariables , class SolutionVector >
◆ VolumeVariables
template<class GridVariables , class SolutionVector >
◆ StaggeredVtkOutputModule()
template<class GridVariables , class SolutionVector >
template<class Sol >
Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >::StaggeredVtkOutputModule |
( |
const GridVariables & |
gridVariables, |
|
|
const Sol & |
sol, |
|
|
const std::string & |
name, |
|
|
const std::string & |
paramGroup = "" , |
|
|
Dune::VTK::DataMode |
dm = Dune::VTK::conforming , |
|
|
bool |
verbose = true |
|
) |
| |
|
inline |
◆ addFaceField() [1/2]
template<class GridVariables , class SolutionVector >
Add a vector valued field
- Parameters
-
v | The field to be added |
name | The name of the vtk field |
◆ addFaceField() [2/2]
template<class GridVariables , class SolutionVector >
Methods to conveniently add face variables Do not call these methods after initialization Add a scalar valued field
- Parameters
-
v | The field to be added |
name | The name of the vtk field |
◆ addFaceVariable() [1/2]
template<class GridVariables , class SolutionVector >
void Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >::addFaceVariable |
( |
std::function< GlobalPosition(const SubControlVolumeFace &scvf, const FaceVariables &)> && |
f, |
|
|
const std::string & |
name |
|
) |
| |
|
inline |
Add a vector-valued faceVarible
- Parameters
-
f | A function taking a SubControlVolumeFace and FaceVariables object and returning the desired vector |
name | The name of the vtk field |
◆ addFaceVariable() [2/2]
template<class GridVariables , class SolutionVector >
void Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >::addFaceVariable |
( |
std::function< Scalar(const FaceVariables &)> && |
f, |
|
|
const std::string & |
name |
|
) |
| |
|
inline |
Add a scalar-valued faceVarible
- Parameters
-
f | A function taking a FaceVariables object and returning the desired scalar |
name | The name of the vtk field |
◆ addField() [1/3]
void Dumux::VtkOutputModuleBase< GridVariables::GridGeometry >::addField |
( |
const Vector & |
v, |
|
|
const std::string & |
name, |
|
|
Dumux::Vtk::Precision |
precision, |
|
|
Vtk::FieldType |
fieldType = Vtk::FieldType::automatic |
|
) |
| |
|
inlineinherited |
- 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]
- 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]
- Parameters
-
field | The parameters passed on to the field constructor |
◆ addVelocityOutput()
template<class GridVariables , class SolutionVector >
Methods to conveniently add primary and secondary variables upon initialization Do not call these methods after initialization i.e. not within the time loop
- Parameters
-
velocityOutput | the output policy |
- Note
- the default policy does not add any velocity output
◆ addVolumeVariable() [1/2]
template<class GridVariables , class SolutionVector >
Output a scalar volume variable
- Parameters
-
name | The name of the vtk field |
f | A function taking a VolumeVariables object and returning the desired scalar |
◆ addVolumeVariable() [2/2]
template<class GridVariables , class SolutionVector >
template<class VVV = VolVarsVector, typename std::enable_if_t<(VVV::dimension > 1), int > = 0>
Add a vector-valued variable
- Parameters
-
f | A function taking a VolumeVariables object and returning the desired vector |
name | The name of the vtk field |
- Note
- This method is only available for dimWorld > 1. For 1-D problems, the overload for volVar methods returning a Scalar will be used.
◆ dataMode()
◆ fields()
◆ gridGeometry()
template<class GridVariables , class SolutionVector >
◆ gridVariables()
template<class GridVariables , class SolutionVector >
◆ name()
◆ paramGroup()
◆ precision()
◆ problem()
template<class GridVariables , class SolutionVector >
◆ sequenceWriter()
◆ sol()
template<class GridVariables , class SolutionVector >
◆ velocityOutput()
template<class GridVariables , class SolutionVector >
◆ verbose()
◆ volVarScalarDataInfo()
template<class GridVariables , class SolutionVector >
const std::vector< VolVarScalarDataInfo > & Dumux::VtkOutputModule< GridVariables, SolutionVector >::volVarScalarDataInfo |
( |
| ) |
const |
|
inlineprotectedinherited |
◆ volVarVectorDataInfo()
template<class GridVariables , class SolutionVector >
const std::vector< VolVarVectorDataInfo > & Dumux::VtkOutputModule< GridVariables, SolutionVector >::volVarVectorDataInfo |
( |
| ) |
const |
|
inlineprotectedinherited |
◆ write()
template<class GridVariables , class SolutionVector >
Write the values to vtp files
- Parameters
-
time | The current time |
type | The output type |
◆ writer()
The documentation for this class was generated from the following files: