Dune Core Modules (unstable)

Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > > Struct Template Reference

facility for writing and reading grids More...

#include <dune/grid/yaspgrid/backuprestore.hh>

Static Public Member Functions

static void backup (const Grid &grid, const std::string &filename)
 
More...
 
static void backup (const Grid &grid, std::ostream &stream)
 
More...
 
static Gridrestore (const std::string &filename, Comm comm=Comm())
 
static Gridrestore (std::istream &stream, Comm comm=Comm())
 

Detailed Description

template<int dim, class Coordinates>
struct Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > >

facility for writing and reading grids

The BackupRestoreFacility allows writing hierarchic grids to disk and reading them back into another program.

It is guaranteed that all index sets and id sets are preserved by the backup / restore process. The result of restore is undefined, if the number of processes in a parallel program differs from the number of processes used on backup.

There are two pairs of backup / restore methods:

  • methods writing into one or more dedicated files,
  • methods operating on a std::stream.

These techniques may not be mixed, i.e., you cannot write the grid into files and read it back from a stream or vice versa. While operating on a std::stream might be convenient, a grid written in another language than C++ might need to emulate this method by writing through a temporary file.

Note
The backup and restore methods might not be implemented for each grid. In this case one can catch the Dune::NotImplemented exception and do something else.
Template Parameters
Gridtype of grid

Member Function Documentation

◆ backup() [1/2]

template<int dim, class Coordinates >
static void Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > >::backup ( const Grid grid,
const std::string &  filename 
)
inlinestatic

◆ backup() [2/2]

◆ restore() [1/2]

template<int dim, class Coordinates >
static Grid* Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > >::restore ( const std::string &  filename,
Comm  comm = Comm() 
)
inlinestatic

◆ restore() [2/2]

template<int dim, class Coordinates >
static Grid* Dune::BackupRestoreFacility< Dune::YaspGrid< dim, Coordinates > >::restore ( std::istream &  stream,
Comm  comm = Comm() 
)
inlinestatic

The documentation for this struct was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 27, 23:31, 2024)