Dune Core Modules (unstable)

Dune::GridPtr< GridType > Struct Template Reference

Class for constructing grids from DGF files. More...

#include <dune/grid/io/file/dgfparser/gridptr.hh>

Public Member Functions

 GridPtr (const std::string &filename, MPICommunicatorType comm=MPIHelper::getCommunicator())
 constructor given the name of a DGF file
 
 GridPtr (std::istream &input, MPICommunicatorType comm=MPIHelper::getCommunicator())
 constructor given a std::istream
 
 GridPtr ()
 Default constructor, creating empty GridPtr.
 
 GridPtr (GridType *grd)
 Constructor storing given pointer to internal auto pointer.
 
 GridPtr (const GridPtr &org)=default
 Copy constructor, copies internal auto pointer.
 
GridPtroperator= (const GridPtr &org)
 assignment of grid pointer
 
GridPtroperator= (GridType *grd)
 assignment of pointer to internal auto pointer
 
GridType & operator* ()
 return reference to GridType instance
 
GridType * operator-> ()
 return pointer to GridType instance
 
const GridType & operator* () const
 return const reference to GridType instance
 
const GridType * operator-> () const
 return const pointer to GridType instance
 
GridType * release ()
 release pointer from internal ownership
 
int nofParameters (int cdim) const
 get number of parameters defined for a given codimension
 
template<class Entity >
int nofParameters (const Entity &) const
 get parameters defined for given entity
 
template<class GridImp , class IntersectionImp >
int nofParameters (const Intersection< GridImp, IntersectionImp > &intersection) const
 get number of parameters defined for a given intersection
 
template<class Entity >
const std::vector< double > & parameters (const Entity &entity) const
 get parameters defined for each codim 0 und dim entity on the grid through the grid file
 
template<class GridImp , class IntersectionImp >
const DGFBoundaryParameter::typeparameters (const Intersection< GridImp, IntersectionImp > &intersection) const
 get parameters for intersection
 

Detailed Description

template<class GridType>
struct Dune::GridPtr< GridType >

Class for constructing grids from DGF files.

The constructor of the class is given the filename of the DGF file. From that file a pointer to an instance of type GridType is created by reading the given file which is translated to the specific format of the given GridType. The GridPtr class behaves like an auto pointer of GridType. An auto pointer to a grid of type GridType is constructed as follows:

GridPtr<GridType> gridptr(filename, MPI_COMM_WORLD );
GridType & grid = *gridptr;

The documentation for this struct was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  generated with Hugo v0.69.0 (Mar 7, 23:27, 2021)