Dumux::VtkOutputModule< GridVariables, SolutionVector > Class Template Reference

A VTK output module to simplify writing dumux simulation data to VTK format. More...

#include <dumux/io/vtkoutputmodule.hh>

Inheritance diagram for Dumux::VtkOutputModule< GridVariables, SolutionVector >:

Description

template<class GridVariables, class SolutionVector>
class Dumux::VtkOutputModule< GridVariables, SolutionVector >

A VTK output module to simplify writing dumux simulation data to VTK format.

Template Parameters

GridVariables	The grid variables
SolutionVector	The solution vector

Handles the output of scalar and vector fields to VTK formatted file for multiple variables and timesteps. Certain predefined fields can be registered on initialization and/or be turned on/off using the designated properties. Additionally non-standardized scalar and vector fields can be added to the writer manually.

Public Types
using	VolumeVariables = VV
	export type of the volume variables for the outputfields
enum	FieldType
	export field type More...

Public Member Functions
	VtkOutputModule (const GridVariables &gridVariables, const SolutionVector &sol, const std::string &name, const std::string &paramGroup="", Dune::VTK::DataMode dm=Dune::VTK::conforming, bool verbose=true)
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, FieldType fieldType=FieldType::automatic)
	Add a scalar or vector valued vtk field.
void	write (double time, Dune::VTK::OutputType type=Dune::VTK::ascii)

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

Member Typedef Documentation

VelocityOutput

template<class GridVariables, class SolutionVector>

using Dumux::VtkOutputModule< GridVariables, SolutionVector >::VelocityOutput = VelocityOutputType

protected

VolumeVariables

template<class GridVariables, class SolutionVector>

using Dumux::VtkOutputModule< GridVariables, SolutionVector >::VolumeVariables = VV

export type of the volume variables for the outputfields

Member Enumeration Documentation

FieldType

enum Dumux::VtkOutputModuleBase::FieldType : unsigned int

stronginherited

export field type

Constructor & Destructor Documentation

VtkOutputModule()

template<class GridVariables, class SolutionVector>

Dumux::VtkOutputModule< GridVariables, SolutionVector >::VtkOutputModule ( const GridVariables & gridVariables, const SolutionVector & sol, const std::string & name, const std::string & paramGroup = "", Dune::VTK::DataMode dm = Dune::VTK::conforming, bool verbose = true )

inline

Member Function Documentation

addField()

void Dumux::VtkOutputModuleBase< GridGeometry >::addField ( const Vector & v, const std::string & name, FieldType fieldType = FieldType::automatic )

inlineinherited

Add a scalar or vector valued vtk field.

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.

addVelocityOutput()

template<class GridVariables, class SolutionVector>

void Dumux::VtkOutputModule< GridVariables, SolutionVector >::addVelocityOutput ( std::shared_ptr< VelocityOutputType > velocityOutput )

inline

Add a velocity output policy.

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>

void Dumux::VtkOutputModule< GridVariables, SolutionVector >::addVolumeVariable ( std::function< Scalar(const VolumeVariables &)> && f, const std::string & name )

inline

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>

void Dumux::VtkOutputModule< GridVariables, SolutionVector >::addVolumeVariable ( std::function< VolVarsVector(const VolumeVariables &)> && f, const std::string & name )

inline

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()

Dune::VTK::DataMode Dumux::VtkOutputModuleBase< GridGeometry >::dataMode ( ) const

inlineprotectedinherited

fields()

const std::vector< Field > & Dumux::VtkOutputModuleBase< GridGeometry >::fields ( ) const

inlineprotectedinherited

gridGeometry()

template<class GridVariables, class SolutionVector>

const GridGeometry & Dumux::VtkOutputModule< GridVariables, SolutionVector >::gridGeometry ( ) const

inlineprotected

gridVariables()

template<class GridVariables, class SolutionVector>

const GridVariables & Dumux::VtkOutputModule< GridVariables, SolutionVector >::gridVariables ( ) const

inlineprotected

name()

const std::string & Dumux::VtkOutputModuleBase< GridGeometry >::name ( ) const

inlineprotectedinherited

paramGroup()

const std::string & Dumux::VtkOutputModuleBase< GridGeometry >::paramGroup ( ) const

inlineinherited

the parameter group for getting parameter from the parameter tree

precision()

Dumux::Vtk::Precision Dumux::VtkOutputModuleBase< GridGeometry >::precision ( ) const

inlineprotectedinherited

problem()

template<class GridVariables, class SolutionVector>

const auto & Dumux::VtkOutputModule< GridVariables, SolutionVector >::problem ( ) const

inlineprotected

sequenceWriter()

Dune::VTKSequenceWriter< GridView > & Dumux::VtkOutputModuleBase< GridGeometry >::sequenceWriter ( )

inlineprotectedinherited

sol()

template<class GridVariables, class SolutionVector>

const SolutionVector & Dumux::VtkOutputModule< GridVariables, SolutionVector >::sol ( ) const

inlineprotected

velocityOutput()

template<class GridVariables, class SolutionVector>

const VelocityOutput & Dumux::VtkOutputModule< GridVariables, SolutionVector >::velocityOutput ( ) const

inlineprotected

verbose()

bool Dumux::VtkOutputModuleBase< GridGeometry >::verbose ( ) const

inlineprotectedinherited

volVarScalarDataInfo()

template<class GridVariables, class SolutionVector>

const std::vector< VolVarScalarDataInfo > & Dumux::VtkOutputModule< GridVariables, SolutionVector >::volVarScalarDataInfo ( ) const

inlineprotected

volVarVectorDataInfo()

template<class GridVariables, class SolutionVector>

const std::vector< VolVarVectorDataInfo > & Dumux::VtkOutputModule< GridVariables, SolutionVector >::volVarVectorDataInfo ( ) const

inlineprotected

write()

void Dumux::VtkOutputModuleBase< GridGeometry >::write ( double time, Dune::VTK::OutputType type = Dune::VTK::ascii )

inlineinherited

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()

Dune::VTKWriter< GridView > & Dumux::VtkOutputModuleBase< GridGeometry >::writer ( )

inlineprotectedinherited

---

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

• io/vtkoutputmodule.hh