dune-fem 2.8.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Dune::Fem::DataWriterParameters Struct Reference

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

Inheritance diagram for Dune::Fem::DataWriterParameters:
Inheritance graph

Public Member Functions

 DataWriterParameters (std::string keyPrefix, const ParameterReader &parameter=Parameter::container())
 
 DataWriterParameters (const ParameterReader &parameter=Parameter::container())
 
virtual std::string macroGridName (const int dim) const
 base of file name for data file (fem.io.macroGridFile)
 
virtual bool separateRankPath () const
 return true if all data should be written to a spearate path per rank
 
virtual std::string path () const
 path where the data is stored (always relative to fem.prefix)
 
virtual std::string absolutePath () const
 
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 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
 
virtual bool writeMode () const
 
const ParameterReaderparameter () const noexcept
 

Protected Attributes

const std::string keyPrefix_
 
ParameterReader parameter_
 

Constructor & Destructor Documentation

◆ DataWriterParameters() [1/2]

Dune::Fem::DataWriterParameters::DataWriterParameters ( std::string  keyPrefix,
const ParameterReader parameter = Parameter::container() 
)
inlineexplicit

◆ DataWriterParameters() [2/2]

Dune::Fem::DataWriterParameters::DataWriterParameters ( const ParameterReader parameter = Parameter::container())
inlineexplicit

Member Function Documentation

◆ absolutePath()

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

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

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

◆ outputformat()

virtual int Dune::Fem::DataOutputParameters::outputformat ( ) const
inlinevirtualinherited

format of output (fem.io.outputformat)

Reimplemented in Dune::Fem::CheckPointerParameters.

◆ 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::DataOutputParameters::prefix ( ) const
inlinevirtualinherited

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

Reimplemented in Dune::Fem::CheckPointerParameters.

◆ 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::DataWriterParameters::separateRankPath ( ) const
inlinevirtual

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

Reimplemented in Dune::Fem::CheckPointerParameters.

◆ 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::DataOutputParameters::writeMode ( ) const
inlinevirtualinherited

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

Reimplemented in Dune::Fem::CheckPointerParameters.

Member Data Documentation

◆ keyPrefix_

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

◆ parameter_

ParameterReader Dune::Fem::DataOutputParameters::parameter_
protectedinherited

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