dune-fem 2.8.0
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
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

Classes

struct  SaveParallelCartesianGrid
 
struct  SaveParallelCartesianGrid< YaspGrid< dim, CoordCont > >
 

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)
 
template<class GridImp >
static void writeMacroGrid (const GridImp &grid, std::ostream &out, const std::string &macroname, const std::string &path, const std::string &prefix, const bool writeSubFiles=false)
 if grid is structured grid, write macro file
 
template<class GridImp >
static void copyMacroGrid (const GridImp &g, const std::string &macroGrid, const std::string &orgPath, const std::string &destPath, const std::string &prefix)
 if grid is structured grid, write macro file
 

Protected Member Functions

 IOInterface ()
 default constructor
 

Static Protected Member Functions

static std::string strRank (const int rank)
 create string containing rank
 
template<class GridImp >
static void saveCartesianGrid (const GridImp &grid, std::ostream &out, dgf::IntervalBlock &intervalBlock, std::string filename, const bool writeSubFiles)
 write my partition as macro grid
 
template<int dimension>
static void writeToStream (std::ostream &file, const FieldVector< double, dimension > &origin, const FieldVector< double, dimension > &lang, const FieldVector< int, dimension > &anz)
 
template<int dimension>
static void writeStructuredGrid (const std::string &filename, std::ostream &out, const FieldVector< double, dimension > &origin, const FieldVector< double, dimension > &lang, const FieldVector< int, dimension > &anz)
 write structured grid as DGF file
 

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

◆ copyMacroGrid()

template<class GridImp >
static void Dune::Fem::IOInterface::copyMacroGrid ( const GridImp &  g,
const std::string &  macroGrid,
const std::string &  orgPath,
const std::string &  destPath,
const std::string &  prefix 
)
inlinestatic

if grid is structured grid, write macro file

◆ 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

◆ saveCartesianGrid()

template<class GridImp >
static void Dune::Fem::IOInterface::saveCartesianGrid ( const GridImp &  grid,
std::ostream &  out,
dgf::IntervalBlock &  intervalBlock,
std::string  filename,
const bool  writeSubFiles 
)
inlinestaticprotected

write my partition as macro grid

◆ strRank()

static std::string Dune::Fem::IOInterface::strRank ( const int  rank)
inlinestaticprotected

create string containing rank

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

◆ writeMacroGrid()

template<class GridImp >
static void Dune::Fem::IOInterface::writeMacroGrid ( const GridImp &  grid,
std::ostream &  out,
const std::string &  macroname,
const std::string &  path,
const std::string &  prefix,
const bool  writeSubFiles = false 
)
inlinestatic

if grid is structured grid, write macro file

◆ writeStructuredGrid()

template<int dimension>
static void Dune::Fem::IOInterface::writeStructuredGrid ( const std::string &  filename,
std::ostream &  out,
const FieldVector< double, dimension > &  origin,
const FieldVector< double, dimension > &  lang,
const FieldVector< int, dimension > &  anz 
)
inlinestaticprotected

write structured grid as DGF file

◆ writeToStream()

template<int dimension>
static void Dune::Fem::IOInterface::writeToStream ( std::ostream &  file,
const FieldVector< double, dimension > &  origin,
const FieldVector< double, dimension > &  lang,
const FieldVector< int, dimension > &  anz 
)
inlinestaticprotected

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