Dune::Fem::DataOutputParameters Struct Reference

Parameter class for Dune::Fem::DataOutput. More...

#include <dune/fem/io/file/dataoutput.hh>

Public Member Functions
virtual std::string	path () const
	path where the data is stored (always relative to fem.prefix)
virtual std::string	prefix () const
	base of file name for data file (fem.io.datafileprefix)
virtual int	outputformat () const
	format of output (fem.io.outputformat)
virtual bool	grapedisplay () const
	use online grape display (fem.io.grapedisplay)
virtual double	savestep () const
	save data every savestep interval (fem.io.savestep)
virtual int	savecount () const
	save data every savecount calls to write method (fem.io.savecount)
virtual int	subsamplingLevel () const
	save data every subsamplingLevel (fem.io.subsamplinglevel)
virtual int	startcounter () const
	number for first data file (no parameter available)
virtual int	startcall () const
	number of first call (no parameter available)
virtual double	startsavetime () const
	value of first save time (no parameter available)
virtual bool	willWrite (bool write) const
virtual bool	writeMode () const

Detailed Description

Parameter class for Dune::Fem::DataOutput.

Structure providing the main parameters used to setup the Dune::DataOutput. By default these parameters are set through the Dune::Parameter class, i.e., can be set in a parameter file. To override this a user can derive from this structure and modify any subset of the parameters. An instance of this modified class can then be passed in the construction of the Dune::DataOutput.

Member Function Documentation

willWrite()

virtual bool Dune::Fem::DataOutputParameters::willWrite ( bool  write ) const

inlinevirtual

method used for conditional data output - default value passed as argument.

writeMode()

virtual bool Dune::Fem::DataOutputParameters::writeMode ( ) const

inlinevirtual

return true if DataOutput was created for writing (only not true for CheckPointer on restore)

Reimplemented in Dune::Fem::CheckPointerParameters.

---

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

• dune/fem/io/file/dataoutput.hh