dune-fem
2.4.1-rc
|
Parameter class for Dune::Fem::DataOutput. More...
#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/io/file/dataoutput.hh>
Public Member Functions | |
DataOutputParameters (std::string keyPrefix, const ParameterReader ¶meter=Parameter::container()) | |
DataOutputParameters (const ParameterReader ¶meter=Parameter::container()) | |
virtual std::string | path () const |
path where the data is stored (always relative to fem.prefix) More... | |
virtual std::string | absolutePath () const |
virtual std::string | prefix () const |
base of file name for data file (fem.io.datafileprefix) More... | |
virtual int | outputformat () const |
format of output (fem.io.outputformat) More... | |
virtual bool | conformingoutput () const |
virtual bool | grapedisplay () const |
use online grape display (fem.io.grapedisplay) More... | |
virtual double | savestep () const |
save data every savestep interval (fem.io.savestep) More... | |
virtual int | savecount () const |
save data every savecount calls to write method (fem.io.savecount) More... | |
virtual int | subsamplingLevel () const |
save data every subsamplingLevel (fem.io.subsamplinglevel) More... | |
virtual int | startcounter () const |
number for first data file (no parameter available) More... | |
virtual int | startcall () const |
number of first call (no parameter available) More... | |
virtual double | startsavetime () const |
value of first save time (no parameter available) More... | |
virtual bool | willWrite (bool write) const |
virtual bool | writeMode () const |
const ParameterReader & | parameter () const noexcept |
Protected Attributes | |
const std::string | keyPrefix_ |
ParameterReader | parameter_ |
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.
|
inlineexplicit |
|
inlineexplicit |
|
inlinevirtual |
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), parameter(), and path().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), and parameter().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
use online grape display (fem.io.grapedisplay)
References parameter().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
format of output (fem.io.outputformat)
Reimplemented in Dune::Fem::CheckPointerParameters.
References Dune::Fem::BasicParameterReader< Parameter >::getEnum(), and parameter().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinenoexcept |
References parameter_.
Referenced by absolutePath(), Dune::Fem::CheckPointer< GridImp, DataImp >::CheckPointer(), Dune::Fem::CheckPointerParameters::checkPointPrefix(), Dune::Fem::CheckPointerParameters::checkPointStep(), conformingoutput(), Dune::Fem::DataOutput< GridImp, DataImp >::DataOutput(), grapedisplay(), Dune::Fem::DataWriterParameters::macroGridName(), Dune::Fem::CheckPointerParameters::maxNumberOfCheckPoints(), outputformat(), path(), prefix(), Dune::Fem::CheckPointer< GridImp, DataImp >::restoreGrid(), savecount(), savestep(), and subsamplingLevel().
|
inlinevirtual |
path where the data is stored (always relative to fem.prefix)
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), and parameter().
Referenced by absolutePath(), Dune::Fem::CheckPointer< GridImp, DataImp >::restoreGrid(), Dune::Fem::CheckPointer< GridImp, DataImp >::restorePersistentData(), Dune::Fem::CheckPointer< GridImp, DataImp >::restoreUserData(), and Dune::Fem::CheckPointer< GridImp, DataImp >::writeBinaryData().
|
inlinevirtual |
base of file name for data file (fem.io.datafileprefix)
Reimplemented in Dune::Fem::CheckPointerParameters.
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), and parameter().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
save data every savecount calls to write method (fem.io.savecount)
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), and parameter().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
save data every savestep interval (fem.io.savestep)
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), and parameter().
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
number of first call (no parameter available)
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
number for first data file (no parameter available)
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
value of first save time (no parameter available)
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
inlinevirtual |
save data every subsamplingLevel (fem.io.subsamplinglevel)
References Dune::Fem::BasicParameterReader< Parameter >::getValue(), and parameter().
|
inlinevirtual |
method used for conditional data output - default value passed as argument.
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::write().
|
inlinevirtual |
return true if DataOutput was created for writing (only not true for CheckPointer on restore)
Reimplemented in Dune::Fem::CheckPointerParameters.
Referenced by Dune::Fem::DataOutput< GridImp, DataImp >::init().
|
protected |
|
protected |
Referenced by parameter().