Dumux::MultiDomainVtkOutputModule< MDTraits, Module > Class Template Reference

A multidomain wrapper for multiple vtk output modules. More...

#include <dumux/multidomain/io/vtkoutputmodule.hh>

Description

template<class MDTraits, template< class GV, class S > class Module = Dumux::VtkOutputModule>
class Dumux::MultiDomainVtkOutputModule< MDTraits, Module >

A multidomain wrapper for multiple vtk output modules.

Template Parameters

MDTraits	The multidomain traits
Module	An output module class template that takes GridVariables and SolutionVector as arguments

Public Types
template<std::size_t i>
using	Type = VtkOutputModule< i >
	export base types of the stored type More...
template<std::size_t i>
using	PtrType = std::shared_ptr< Type< i > >
	export pointer types the stored type More...

Public Member Functions
	MultiDomainVtkOutputModule ()=default
	The default constructor. More...
	MultiDomainVtkOutputModule (MDGridVars &&gridVars, const MDSolutionVector &sol, const std::array< std::string, numSubDomains > &name)
	Construct the vtk output modules. More...
void	initDefaultOutputFields ()
	initialized all vtkoutput modules with the models default output fields More...
void	write (double t, Dune::VTK::OutputType type=Dune::VTK::ascii)
	Write the data for this timestep to file for all output modules. More...
template<std::size_t i>
const Type< i > &	operator[] (Dune::index_constant< i > id) const
	return the output module for domain with index i More...
template<std::size_t i>
Type< i > &	operator[] (Dune::index_constant< i > id)
	return the output module for domain with index i More...
template<std::size_t i>
PtrType< i >	get (Dune::index_constant< i > id=Dune::index_constant< i >{})
	return the vtkoutput module for domain with index i More...
template<std::size_t i>
void	set (PtrType< i > p, Dune::index_constant< i > id=Dune::index_constant< i >{})
	set the pointer for sub domain i More...

Member Typedef Documentation

PtrType

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

template<std::size_t i>

using Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::PtrType = std::shared_ptr<Type<i> >

export pointer types the stored type

Type

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

template<std::size_t i>

using Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::Type = VtkOutputModule<i>

export base types of the stored type

Constructor & Destructor Documentation

MultiDomainVtkOutputModule() [1/2]

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::MultiDomainVtkOutputModule ( )

default

The default constructor.

MultiDomainVtkOutputModule() [2/2]

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::MultiDomainVtkOutputModule ( MDGridVars &&  gridVars, const MDSolutionVector &  sol, const std::array< std::string, numSubDomains > &  name  )

inline

Construct the vtk output modules.

Parameters

gridVars	a tuple of grid variables
sol	the multidomain solution vector
name	the base name for the vtk output

Member Function Documentation

get()

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

template<std::size_t i>

PtrType< i > Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::get ( Dune::index_constant< i >  id = Dune::index_constant<i>{} )

inline

return the vtkoutput module for domain with index i

initDefaultOutputFields()

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

void Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::initDefaultOutputFields ( )

inline

initialized all vtkoutput modules with the models default output fields

operator[]() [1/2]

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

template<std::size_t i>

Type< i > & Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::operator[] ( Dune::index_constant< i >  id )

inline

return the output module for domain with index i

operator[]() [2/2]

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

template<std::size_t i>

const Type< i > & Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::operator[] ( Dune::index_constant< i >  id ) const

inline

return the output module for domain with index i

set()

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

template<std::size_t i>

void Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::set ( PtrType< i >  p, Dune::index_constant< i >  id = Dune::index_constant<i>{}  )

inline

set the pointer for sub domain i

write()

template<class MDTraits , template< class GV, class S > class Module = Dumux::VtkOutputModule>

void Dumux::MultiDomainVtkOutputModule< MDTraits, Module >::write ( double  t, Dune::VTK::OutputType  type = Dune::VTK::ascii  )

inline

Write the data for this timestep to file for all output modules.

---

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

• multidomain/io/vtkoutputmodule.hh