dune-fem 2.12-git
Loading...
Searching...
No Matches
Dune::Fem::IOInterface Class Referenceabstract

IOInterface to write data to hard disk. More...

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

Inheritance diagram for Dune::Fem::IOInterface:
Inheritance graph

Public Member Functions

virtual ~IOInterface ()
 destructor
 
virtual void writeData (double sequenceStamp) const =0
 write data with a given sequence stamp
 
virtual void write (const TimeProviderBase &tp) const =0
 write given data to disc, evaluates parameter savecount and savestep
 
virtual void write () const =0
 write given data to disc, evaluates parameter savecount
 

Static Public Member Functions

static std::string defaultGridKey (int dimension, bool check=true)
 return FEM key for macro grid reading
 
static std::string defaultGridKey (int dimension, const ParameterReader &parameter, bool check=true)
 
static std::string defaultGridKey (std::string base, int dimension, bool check=true)
 
static std::string defaultGridKey (std::string base, int dimension, const ParameterReader &parameter, bool check=true)
 return FEM key for macro grid reading
 
static void createPath (const std::string &path)
 create given path in combination with rank
 
static std::string createPathName (const std::string &pathPref, int rank)
 create given path in combination with rank
 
static std::string readPath ()
 
template<class CommunicatorType >
static void createGlobalPath (const CommunicatorType &comm, const std::string &path)
 create global path for data output
 
static std::string copyPathToFilename (const std::string &path)
 
template<class CommunicatorType >
static std::string createPath (const CommunicatorType &comm, const std::string &pathPrefix, const std::string &dataPrefix, const int step, const bool alsoCreateRankPath=true)
 
static std::string createRecoverPath (const std::string &pathPrefix, const int rank, const std::string &dataPrefix, const int step, const bool alsoUseRankPath=true)
 

Protected Member Functions

 IOInterface ()
 default constructor
 

Detailed Description

IOInterface to write data to hard disk.

An interface class:

Constructor & Destructor Documentation

◆ IOInterface()

Dune::Fem::IOInterface::IOInterface ( )
inlineprotected

default constructor

◆ ~IOInterface()

virtual Dune::Fem::IOInterface::~IOInterface ( )
inlinevirtual

destructor

Member Function Documentation

◆ copyPathToFilename()

static std::string Dune::Fem::IOInterface::copyPathToFilename ( const std::string path)
inlinestatic

◆ createGlobalPath()

template<class CommunicatorType >
static void Dune::Fem::IOInterface::createGlobalPath ( const CommunicatorType &  comm,
const std::string path 
)
inlinestatic

create global path for data output

◆ createPath() [1/2]

template<class CommunicatorType >
static std::string Dune::Fem::IOInterface::createPath ( const CommunicatorType &  comm,
const std::string pathPrefix,
const std::string dataPrefix,
const int  step,
const bool  alsoCreateRankPath = true 
)
inlinestatic

◆ createPath() [2/2]

static void Dune::Fem::IOInterface::createPath ( const std::string path)
inlinestatic

create given path in combination with rank

◆ createPathName()

static std::string Dune::Fem::IOInterface::createPathName ( const std::string pathPref,
int  rank 
)
inlinestatic

create given path in combination with rank

◆ createRecoverPath()

static std::string Dune::Fem::IOInterface::createRecoverPath ( const std::string pathPrefix,
const int  rank,
const std::string dataPrefix,
const int  step,
const bool  alsoUseRankPath = true 
)
inlinestatic

◆ defaultGridKey() [1/4]

static std::string Dune::Fem::IOInterface::defaultGridKey ( int  dimension,
bool  check = true 
)
inlinestatic

return FEM key for macro grid reading

◆ defaultGridKey() [2/4]

static std::string Dune::Fem::IOInterface::defaultGridKey ( int  dimension,
const ParameterReader parameter,
bool  check = true 
)
inlinestatic

◆ defaultGridKey() [3/4]

static std::string Dune::Fem::IOInterface::defaultGridKey ( std::string  base,
int  dimension,
bool  check = true 
)
inlinestatic

◆ defaultGridKey() [4/4]

static std::string Dune::Fem::IOInterface::defaultGridKey ( std::string  base,
int  dimension,
const ParameterReader parameter,
bool  check = true 
)
inlinestatic

return FEM key for macro grid reading

◆ readPath()

static std::string Dune::Fem::IOInterface::readPath ( )
inlinestatic

standard path reading and creation method rank is added to output path

◆ write() [1/2]

virtual void Dune::Fem::IOInterface::write ( ) const
pure virtual

write given data to disc, evaluates parameter savecount

Implemented in Dune::Fem::DataOutput< GridImp, DataImp >, and Dune::Fem::DataOutput< GridImp, std::tuple<> >.

◆ write() [2/2]

virtual void Dune::Fem::IOInterface::write ( const TimeProviderBase tp) const
pure virtual

write given data to disc, evaluates parameter savecount and savestep

Parameters
tptime provider for time and step

Implemented in Dune::Fem::DataOutput< GridImp, DataImp >, and Dune::Fem::DataOutput< GridImp, std::tuple<> >.

◆ writeData()

virtual void Dune::Fem::IOInterface::writeData ( double  sequenceStamp) const
pure virtual

write data with a given sequence stamp

Parameters
sequenceStampstamp for the data set

Implemented in Dune::Fem::DataOutput< GridImp, DataImp >, and Dune::Fem::DataOutput< GridImp, std::tuple<> >.


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