Dune Core Modules (unstable)

Dune::GridFactory< GridType > Class Template Reference

Provide a generic factory class for unstructured grids. More...

#include <dune/grid/common/gridfactory.hh>

Public Member Functions

 GridFactory ()
 Default constructor.
 
virtual void insertVertex (const FieldVector< ctype, dimworld > &pos)
 Insert a vertex into the coarse grid.
 
virtual void insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices)
 Insert an element into the coarse grid. More...
 
virtual void insertBoundarySegment (const std::vector< unsigned int > &vertices)
 insert a boundary segment More...
 
virtual ToUniquePtr< GridType > createGrid ()
 Finalize grid creation and hand over the grid. More...
 
virtual void insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices, const std::shared_ptr< VirtualFunction< FieldVector< ctype, dimension >, FieldVector< ctype, dimworld > > > &elementParametrization)
 Insert a parametrized element into the coarse grid. More...
 
virtual void insertBoundarySegment (const std::vector< unsigned int > &vertices, const std::shared_ptr< BoundarySegment< dimension, dimworld > > &boundarySegment)
 insert an arbitrarily shaped boundary segment More...
 
virtual unsigned int insertionIndex (const typename Codim< 0 >::Entity &entity) const
 obtain an element's insertion index More...
 
virtual unsigned int insertionIndex (const typename Codim< dimension >::Entity &entity) const
 obtain a vertex' insertion index More...
 
virtual unsigned int insertionIndex (const typename GridType::LeafIntersection &intersection) const
 obtain a boundary's insertion index More...
 
virtual bool wasInserted (const typename GridType::LeafIntersection &intersection) const
 determine whether an intersection was inserted More...
 
Communication comm () const
 Return the Communication used by the grid factory. More...
 

Protected Types

enum  
 The grid world dimension.
 

Static Protected Attributes

static const int dimension = GridType::dimension
 dimension of the grid
 

Detailed Description

template<class GridType>
class Dune::GridFactory< GridType >

Provide a generic factory class for unstructured grids.

This is the unspecialized class, which does nothing. All work is done in the specializations for the different grid types.

See GridFactoryInterface for an example how to use this class.

Member Function Documentation

◆ comm()

template<class GridType>
Communication Dune::GridFactoryInterface< GridType >::comm ( ) const
inlineinherited

Return the Communication used by the grid factory.

Defaults to the Communication induced by the process-local communicator.

Referenced by Dune::StructuredGridFactory< GridType >::createCubeGrid(), Dune::StructuredGridFactory< GridType >::createSimplexGrid(), and Dune::GmshReader< GridType >::read().

◆ createGrid()

template<class GridType>
virtual ToUniquePtr<GridType> Dune::GridFactory< GridType >::createGrid ( )
inlinevirtual

Finalize grid creation and hand over the grid.

The receiver takes responsibility of the memory allocated for the grid

Implements Dune::GridFactoryInterface< GridType >.

Referenced by Dune::StructuredGridFactory< GridType >::createCubeGrid(), Dune::StructuredGridFactory< GridType >::createSimplexGrid(), Dune::StarCDReader< GridType >::read(), and Dune::GmshReader< GridType >::read().

◆ insertBoundarySegment() [1/2]

template<class GridType>
virtual void Dune::GridFactoryInterface< GridType >::insertBoundarySegment ( const std::vector< unsigned int > &  vertices,
const std::shared_ptr< BoundarySegment< dimension, dimworld > > &  boundarySegment 
)
inlinevirtualinherited

insert an arbitrarily shaped boundary segment

This method inserts a boundary segment into the coarse grid.

Parameters
[in]verticesthe indices of the vertices of the segment
[in]boundarySegmentuser defined implementation of the boundary segment's geometry

◆ insertBoundarySegment() [2/2]

template<class GridType>
virtual void Dune::GridFactory< GridType >::insertBoundarySegment ( const std::vector< unsigned int > &  vertices)
inlinevirtual

insert a boundary segment

This method inserts a boundary segment into the coarse grid. Using this method has two advantages over not using it:

  • The boundary segment gets an insertion index.
  • The grid factory can verify that this is actually a boundary segment
Note
You are not forced to insert all boundary segments. The grid factory will find the remaining boundary segments itself.
Parameters
[in]verticesthe indices of the vertices of the segment

Implements Dune::GridFactoryInterface< GridType >.

Referenced by Dune::GmshReaderParser< GridType >::pass1HandleElement(), and Dune::GmshReaderParser< GridType >::pass2HandleElement().

◆ insertElement() [1/2]

template<class GridType>
virtual void Dune::GridFactoryInterface< GridType >::insertElement ( const GeometryType type,
const std::vector< unsigned int > &  vertices,
const std::shared_ptr< VirtualFunction< FieldVector< ctype, dimension >, FieldVector< ctype, dimworld > > > &  elementParametrization 
)
inlinevirtualinherited

Insert a parametrized element into the coarse grid.

Parameters
typeThe GeometryType of the new element
verticesThe vertices of the new element, using the DUNE numbering
elementParametrizationA function prescribing the shape of this element

Make sure the inserted element is not inverted (this holds even for simplices). There are grids that can't handle inverted elements.

◆ insertElement() [2/2]

template<class GridType>
virtual void Dune::GridFactory< GridType >::insertElement ( const GeometryType type,
const std::vector< unsigned int > &  vertices 
)
inlinevirtual

Insert an element into the coarse grid.

Parameters
typeThe GeometryType of the new element
verticesThe vertices of the new element, using the DUNE numbering

Make sure the inserted element is not inverted (this holds even for simplices). There are grids that can't handle inverted tets.

Implements Dune::GridFactoryInterface< GridType >.

Referenced by Dune::StructuredGridFactory< GridType >::createCubeGrid(), Dune::StructuredGridFactory< GridType >::createSimplexGrid(), Dune::GmshReaderParser< GridType >::pass2HandleElement(), and Dune::StarCDReader< GridType >::read().

◆ insertionIndex() [1/3]

template<class GridType>
virtual unsigned int Dune::GridFactoryInterface< GridType >::insertionIndex ( const typename Codim< 0 >::Entity entity) const
inlinevirtualinherited

obtain an element's insertion index

Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.

Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.

Parameters
[in]entityentity whose insertion index is requested
Returns
insertion index of the entity

Reimplemented in Dune::GridFactory< AlbertaGrid< dim, dimworld > >, and Dune::GridFactory< UGGrid< dimworld > >.

Referenced by Dune::GridFactory< AlbertaGrid< dim, dimworld > >::insertionIndex(), and Dune::GridFactory< UGGrid< dimworld > >::wasInserted().

◆ insertionIndex() [2/3]

template<class GridType>
virtual unsigned int Dune::GridFactoryInterface< GridType >::insertionIndex ( const typename Codim< dimension >::Entity entity) const
inlinevirtualinherited

obtain a vertex' insertion index

Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.

Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.

Parameters
[in]entityentity whose insertion index is requested
Returns
insertion index of the entity

Reimplemented in Dune::GridFactory< AlbertaGrid< dim, dimworld > >, and Dune::GridFactory< UGGrid< dimworld > >.

◆ insertionIndex() [3/3]

template<class GridType>
virtual unsigned int Dune::GridFactoryInterface< GridType >::insertionIndex ( const typename GridType::LeafIntersection &  intersection) const
inlinevirtualinherited

obtain a boundary's insertion index

Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.

Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.

Parameters
[in]intersectionintersection whose insertion index is requested
Returns
insertion index of the intersection
Note
The insertion index can only be obtained for boundary intersections that were actually inserted (see also wasInserted).

◆ wasInserted()

template<class GridType>
virtual bool Dune::GridFactoryInterface< GridType >::wasInserted ( const typename GridType::LeafIntersection &  intersection) const
inlinevirtualinherited

determine whether an intersection was inserted

This method allows checking whether an intersection was actually inserted into the grid factory.

Note
Not all boundary segments need to be inserted into the grid factory.
This method returns false for all interior intersections
Parameters
[in]intersectionintersection in question
Returns
true, if the intersection was inserted

Referenced by Dune::GridFactory< AlbertaGrid< dim, dimworld > >::insertionIndex().


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  generated with Hugo v0.30.2 (Mar 22, 23:22, 2019)