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>

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

Description

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

A VTK output module to simplify writing dumux simulation data to VTK format Specialization for staggered grids with dofs on faces.

Template Parameters

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 More...

using	VolumeVariables = VV
	export type of the volume variables for the outputfields More...

Public Member Functions
template<class Sol >
	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)

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. More...

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 More...

void	addField (const Vector &v, const std::string &name, Vtk::FieldType fieldType=Vtk::FieldType::automatic)
	Add a scalar or vector valued vtk field. More...

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. More...

void	addField (Field &&field)
	Add a scalar or vector valued vtk field. More...

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

◆ Field

template<class GridVariables , class SolutionVector >

using Dumux::VtkOutputModule< GridVariables, SolutionVector >::Field = Vtk::template Field<GridView>

inherited

the type of Field that can be added to this writer

◆ VelocityOutput

template<class GridVariables , class SolutionVector >

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

protectedinherited

◆ VolumeVariables

template<class GridVariables , class SolutionVector >

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

inherited

export type of the volume variables for the outputfields

Constructor & Destructor Documentation

◆ 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

Member Function Documentation

◆ addFaceField() [1/2]

template<class GridVariables , class SolutionVector >

void Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >::addFaceField	(	const std::vector< GlobalPosition > &	v,
		const std::string &	name
	)

inline

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 >

void Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >::addFaceField	(	const std::vector< Scalar > &	v,
		const std::string &	name
	)

inline

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

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.
precision	The output precision of this field (see Dune::VTK::Precision)

◆ addField() [2/3]

void Dumux::VtkOutputModuleBase< GridVariables::GridGeometry >::addField	(	const Vector &	v,
		const std::string &	name,
		Vtk::FieldType	fieldType = `Vtk::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.

◆ addField() [3/3]

void Dumux::VtkOutputModuleBase< GridVariables::GridGeometry >::addField ( Field && field )

inlineinherited

Add a scalar or vector valued vtk field.

Parameters

field The parameters passed on to the field constructor

◆ addVelocityOutput()

template<class GridVariables , class SolutionVector >

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

inlineinherited

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
	)

inlineinherited

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
	)

inlineinherited

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< GridVariables::GridGeometry >::dataMode ( ) const

inlineprotectedinherited

◆ fields()

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

inlineprotectedinherited

◆ gridGeometry()

template<class GridVariables , class SolutionVector >

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

inlineprotectedinherited

◆ gridVariables()

template<class GridVariables , class SolutionVector >

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

inlineprotectedinherited

◆ name()

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

inlineprotectedinherited

◆ paramGroup()

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

inlineinherited

the parameter group for getting parameter from the parameter tree

◆ precision()

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

inlineprotectedinherited

◆ problem()

template<class GridVariables , class SolutionVector >

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

inlineprotectedinherited

◆ sequenceWriter()

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

inlineprotectedinherited

◆ sol()

template<class GridVariables , class SolutionVector >

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

inlineprotectedinherited

◆ velocityOutput()

template<class GridVariables , class SolutionVector >

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

inlineprotectedinherited

◆ verbose()

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

inlineprotectedinherited

◆ 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 >

void Dumux::StaggeredVtkOutputModule< GridVariables, SolutionVector >::write	(	double	time,
		Dune::VTK::OutputType	type = `Dune::VTK::ascii`
	)

inline

Write the values to vtp files

Parameters

time	The current time
type	The output type

◆ writer()

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

inlineprotectedinherited

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

Description

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Member Typedef Documentation

◆ Field

◆ VelocityOutput

◆ VolumeVariables

Constructor & Destructor Documentation

◆ StaggeredVtkOutputModule()

Member Function Documentation

◆ addFaceField() [1/2]

◆ addFaceField() [2/2]

◆ addFaceVariable() [1/2]

◆ addFaceVariable() [2/2]

◆ addField() [1/3]

◆ addField() [2/3]

◆ addField() [3/3]

◆ addVelocityOutput()

◆ addVolumeVariable() [1/2]

◆ addVolumeVariable() [2/2]

◆ dataMode()

◆ fields()

◆ gridGeometry()

◆ gridVariables()

◆ name()

◆ paramGroup()

◆ precision()

◆ problem()

◆ sequenceWriter()

◆ sol()

◆ velocityOutput()

◆ verbose()

◆ volVarScalarDataInfo()

◆ volVarVectorDataInfo()

◆ write()

◆ writer()