Dune::Fem::CheckPointerParameters Class Reference

local parameter collection for CheckPointer More...

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

Inheritance diagram for Dune::Fem::CheckPointerParameters:

Public Member Functions
	CheckPointerParameters (const bool writeMode, const std::string keyPrefix="fem.io.")
	CheckPointerParameters (const std::string keyPrefix="fem.io.")
virtual std::string	prefix () const
	base of file name for data file (fem.io.datafileprefix)
virtual int	checkPointStep () const
	return number of timestep to be passed until next checkpoint in written
virtual int	maxNumberOfCheckPoints () const
	maximal number of checkpoint stages written (default = 2)
virtual std::string	checkPointPrefix () const
	return default value for check point prefix
virtual bool	writeMode () const
	writeMode, true when checkpointer is in backup mode
virtual bool	separateRankPath () const
	return true if all data should be written to a spearate path per rank
virtual int	outputformat () const
	format of output (fem.io.outputformat)
virtual std::string	macroGridName (const int dim) const
	base of file name for data file (fem.io.macroGridFile)
virtual std::string	path () const
	path where the data is stored (always relative to fem.prefix)
virtual std::string	absolutePath () const
virtual bool	conformingoutput () const
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
const ParameterReader &	parameter () const noexcept

Protected Attributes
bool	writeMode_
const std::string	keyPrefix_
ParameterReader	parameter_

Detailed Description

local parameter collection for CheckPointer

Note

For now, the CheckPointer only works with the singleton parameter class.

Constructor & Destructor Documentation

CheckPointerParameters() [1/2]

Dune::Fem::CheckPointerParameters::CheckPointerParameters ( const bool  writeMode, const std::string  keyPrefix = "fem.io."  )

inline

CheckPointerParameters() [2/2]

Dune::Fem::CheckPointerParameters::CheckPointerParameters ( const std::string  keyPrefix = "fem.io." )

inlineexplicit

Member Function Documentation

absolutePath()

virtual std::string Dune::Fem::DataOutputParameters::absolutePath ( ) const

inlinevirtualinherited

checkPointPrefix()

virtual std::string Dune::Fem::CheckPointerParameters::checkPointPrefix ( ) const

inlinevirtual

return default value for check point prefix

checkPointStep()

virtual int Dune::Fem::CheckPointerParameters::checkPointStep ( ) const

inlinevirtual

return number of timestep to be passed until next checkpoint in written

conformingoutput()

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

inlinevirtualinherited

grapedisplay()

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

inlinevirtualinherited

use online grape display (fem.io.grapedisplay)

macroGridName()

virtual std::string Dune::Fem::DataWriterParameters::macroGridName ( const int  dim ) const

inlinevirtualinherited

base of file name for data file (fem.io.macroGridFile)

maxNumberOfCheckPoints()

virtual int Dune::Fem::CheckPointerParameters::maxNumberOfCheckPoints ( ) const

inlinevirtual

maximal number of checkpoint stages written (default = 2)

outputformat()

virtual int Dune::Fem::CheckPointerParameters::outputformat ( ) const

inlinevirtual

format of output (fem.io.outputformat)

Reimplemented from Dune::Fem::DataOutputParameters.

parameter()

const ParameterReader & Dune::Fem::DataOutputParameters::parameter ( ) const

inlinenoexceptinherited

path()

virtual std::string Dune::Fem::DataOutputParameters::path ( ) const

inlinevirtualinherited

path where the data is stored (always relative to fem.prefix)

prefix()

virtual std::string Dune::Fem::CheckPointerParameters::prefix ( ) const

inlinevirtual

base of file name for data file (fem.io.datafileprefix)

Reimplemented from Dune::Fem::DataOutputParameters.

savecount()

virtual int Dune::Fem::DataOutputParameters::savecount ( ) const

inlinevirtualinherited

save data every savecount calls to write method (fem.io.savecount)

savestep()

virtual double Dune::Fem::DataOutputParameters::savestep ( ) const

inlinevirtualinherited

save data every savestep interval (fem.io.savestep)

separateRankPath()

virtual bool Dune::Fem::CheckPointerParameters::separateRankPath ( ) const

inlinevirtual

return true if all data should be written to a spearate path per rank

Reimplemented from Dune::Fem::DataWriterParameters.

startcall()

virtual int Dune::Fem::DataOutputParameters::startcall ( ) const

inlinevirtualinherited

number of first call (no parameter available)

startcounter()

virtual int Dune::Fem::DataOutputParameters::startcounter ( ) const

inlinevirtualinherited

number for first data file (no parameter available)

startsavetime()

virtual double Dune::Fem::DataOutputParameters::startsavetime ( ) const

inlinevirtualinherited

value of first save time (no parameter available)

subsamplingLevel()

virtual int Dune::Fem::DataOutputParameters::subsamplingLevel ( ) const

inlinevirtualinherited

save data every subsamplingLevel (fem.io.subsamplinglevel)

willWrite()

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

inlinevirtualinherited

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

writeMode()

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

inlinevirtual

writeMode, true when checkpointer is in backup mode

Reimplemented from Dune::Fem::DataOutputParameters.

Member Data Documentation

keyPrefix_

const std::string Dune::Fem::DataOutputParameters::keyPrefix_

protectedinherited

parameter_

ParameterReader Dune::Fem::DataOutputParameters::parameter_

protectedinherited

writeMode_

bool Dune::Fem::CheckPointerParameters::writeMode_

protected

---

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

• datawriter.hh