dune-spgrid 2.7
Public Types | Static Public Member Functions | List of all members
Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > > Struct Template Reference

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

Public Types

typedef SPGrid< ct, dim, Ref, Comm > Grid
 
typedef Grid::CollectiveCommunication CollectiveCommunication
 

Static Public Member Functions

static void backup (const Grid &grid, const std::string &path, const std::string &fileprefix)
 write a hierarchic grid to disk More...
 
static void backup (const Grid &grid, const std::string &filename)
 write a hierarchic grid to disk More...
 
static void backup (const Grid &grid, std::ostream &stream)
 write a hierarchic grid into a stream More...
 
static Gridrestore (const std::string &path, const std::string &fileprefix, const CollectiveCommunication &comm=SPCommunicationTraits< Comm >::defaultComm())
 read a hierarchic grid from disk More...
 
static Gridrestore (const std::string &filename, const CollectiveCommunication &comm=SPCommunicationTraits< Comm >::defaultComm())
 read a hierarchic grid from disk More...
 
static Gridrestore (std::istream &stream, const CollectiveCommunication &comm=SPCommunicationTraits< Comm >::defaultComm())
 read a hierarchic grid from a stream More...
 

Member Typedef Documentation

◆ CollectiveCommunication

template<class ct , int dim, template< int > class Ref, class Comm >
typedef Grid::CollectiveCommunication Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::CollectiveCommunication

◆ Grid

template<class ct , int dim, template< int > class Ref, class Comm >
typedef SPGrid< ct, dim, Ref, Comm > Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::Grid

Member Function Documentation

◆ backup() [1/3]

template<class ct , int dim, template< int > class Ref, class Comm >
static void Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::backup ( const Grid grid,
const std::string &  filename 
)
inlinestatic

write a hierarchic grid to disk

Parameters
[in]gridgrid to write
[in]pathfilename of the file to create

◆ backup() [2/3]

template<class ct , int dim, template< int > class Ref, class Comm >
static void Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::backup ( const Grid grid,
const std::string &  path,
const std::string &  fileprefix 
)
inlinestatic

write a hierarchic grid to disk

Parameters
[in]gridgrid to write
[in]pathpath to write the file to
[in]fileprefixprefix of the file name

◆ backup() [3/3]

template<class ct , int dim, template< int > class Ref, class Comm >
static void Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::backup ( const Grid grid,
std::ostream &  stream 
)
inlinestatic

write a hierarchic grid into a stream

Parameters
[in]gridgrid to write
[in]streamstd::stream to write the grid to

◆ restore() [1/3]

template<class ct , int dim, template< int > class Ref, class Comm >
static Grid * Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::restore ( const std::string &  filename,
const CollectiveCommunication comm = SPCommunicationTraits< Comm >::defaultComm() 
)
inlinestatic

read a hierarchic grid from disk

Parameters
[in]filenamename of the file to read
[in]commcollective communication (optional)
Returns
a pointer to the grid (allocated by new)

◆ restore() [2/3]

template<class ct , int dim, template< int > class Ref, class Comm >
static Grid * Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::restore ( const std::string &  path,
const std::string &  fileprefix,
const CollectiveCommunication comm = SPCommunicationTraits< Comm >::defaultComm() 
)
inlinestatic

read a hierarchic grid from disk

Parameters
[in]pathpath to write the file to
[in]fileprefixprefix of the file name
[in]commcollective communication (optional)
Returns
a pointer to the grid (allocated by new)

◆ restore() [3/3]

template<class ct , int dim, template< int > class Ref, class Comm >
static Grid * Dune::BackupRestoreFacility< SPGrid< ct, dim, Ref, Comm > >::restore ( std::istream &  stream,
const CollectiveCommunication comm = SPCommunicationTraits< Comm >::defaultComm() 
)
inlinestatic

read a hierarchic grid from a stream

Parameters
[in]streamstd::stream to read the grid from
[in]commcollective communication (optional)

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