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>
| GridVariables | The grid variables | 
| SolutionVector | The solution vector | 
| Public Types | |
| 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 | |
| Public Member Functions | |
| 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. | |
| Protected Types | |
| using | VelocityOutput = VelocityOutputType | 
| Protected Member Functions | |
| const auto & | problem () const | 
| const GridVariables & | gridVariables () const | 
| const GridGeometry & | gridGeometry () const | 
| const SolutionVector & | sol () const | 
| const std::vector< VolVarScalarDataInfo > & | volVarScalarDataInfo () const | 
| const std::vector< VolVarVectorDataInfo > & | volVarVectorDataInfo () const | 
| const VelocityOutput & | velocityOutput () const | 
| bool | verbose () const | 
| const std::string & | name () const | 
| Dune::VTK::DataMode | dataMode () const | 
| Dumux::Vtk::Precision | precision () const | 
| Dune::VTKWriter< GridView > & | writer () | 
| Dune::VTKSequenceWriter< GridView > & | sequenceWriter () | 
| const std::vector< Field > & | fields () const | 
| void | addCellData (const Field &field) | 
| void | addVertexData (const Field &field) | 
| Protected Attributes | |
| std::vector< std::string > | addedCellData_ | 
| std::vector< std::string > | addedVertexData_ | 
| 
 | inherited | 
| 
 | protectedinherited | 
| 
 | inherited | 
| 
 | inline | 
| 
 | inlineprotectedinherited | 
| 
 | inline | 
Add a vector valued field
| v | The field to be added | 
| name | The name of the vtk field | 
| 
 | inline | 
Methods to conveniently add face variables Do not call these methods after initialization Add a scalar valued field
| v | The field to be added | 
| name | The name of the vtk field | 
| 
 | inline | 
Add a vector-valued faceVarible
| f | A function taking a SubControlVolumeFace and FaceVariables object and returning the desired vector | 
| name | The name of the vtk field | 
| 
 | inline | 
Add a scalar-valued faceVarible
| f | A function taking a FaceVariables object and returning the desired scalar | 
| name | The name of the vtk field | 
| 
 | inlineinherited | 
| 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) | 
| 
 | inlineinherited | 
| 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. | 
| 
 | inlineinherited | 
| field | The parameters passed on to the field constructor | 
| 
 | inlineinherited | 
Methods to conveniently add primary and secondary variables upon initialization Do not call these methods after initialization i.e. not within the time loop
| velocityOutput | the output policy | 
| 
 | inlineprotectedinherited | 
| 
 | inlineinherited | 
Output a scalar volume variable
| name | The name of the vtk field | 
| f | A function taking a VolumeVariables object and returning the desired scalar | 
| 
 | inlineinherited | 
Add a vector-valued variable
| f | A function taking a VolumeVariables object and returning the desired vector | 
| name | The name of the vtk field | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inlineprotectedinherited | 
| 
 | inline | 
Write the values to vtp files
| time | The current time | 
| type | The output type | 
| 
 | inlineprotectedinherited | 
| 
 | protectedinherited | 
| 
 | protectedinherited |