specialization of the generic GridFactory for AlbertaGrid More...
#include <dune/grid/albertagrid/gridfactory.hh>
Classes | |
| struct | Codim |
| class | ProjectionFactory |
Public Types | |
| typedef AlbertaGrid< dim, dimworld > | Grid |
| type of grid this factory is for More... | |
| typedef Grid::ctype | ctype |
| type of (scalar) coordinates More... | |
| typedef FieldVector< ctype, dimensionworld > | WorldVector |
| type of vector for world coordinates More... | |
| typedef FieldMatrix< ctype, dimensionworld, dimensionworld > | WorldMatrix |
| type of matrix from world coordinates to world coordinates More... | |
| typedef DuneBoundaryProjection< dimensionworld > | DuneProjection |
| typedef std::shared_ptr< const DuneProjection > | DuneProjectionPtr |
| typedef Dune::BoundarySegment< dimension, dimensionworld > | BoundarySegment |
| using | Communication = Dune::Communication< typename MPIHelper::MPICommunicator > |
Public Member Functions | |
| GridFactory () | |
| virtual | ~GridFactory () |
| virtual void | insertVertex (const WorldVector &pos) |
| insert a vertex into the macro grid More... | |
| virtual void | insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices) |
| insert an element into the macro grid More... | |
| virtual void | insertBoundary (int element, int face, int id) |
| mark a face as boundary (and assign a boundary id) More... | |
| virtual void | insertBoundaryProjection (const GeometryType &type, const std::vector< unsigned int > &vertices, const DuneProjection *projection) |
| insert a boundary projection into the macro grid More... | |
| virtual void | insertBoundaryProjection (const DuneProjection *projection) |
| insert a global (boundary) projection into the macro grid More... | |
| virtual void | insertBoundarySegment (const std::vector< unsigned int > &vertices) |
| insert a boundary segment into the macro grid More... | |
| virtual void | insertBoundarySegment (const std::vector< unsigned int > &vertices, const std::shared_ptr< BoundarySegment > &boundarySegment) |
| insert a shaped boundary segment into the macro grid More... | |
| void | insertFaceTransformation (const WorldMatrix &matrix, const WorldVector &shift) |
| add a face transformation (for periodic identification) More... | |
| void | markLongestEdge () |
| mark the longest edge as refinemet edge More... | |
| std::unique_ptr< Grid > | createGrid () |
| finalize grid creation and hand over the grid More... | |
| bool | write (const std::string &filename) |
| write out the macro triangulation in native grid file format 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 Grid::LeafIntersection &intersection) const |
| virtual bool | wasInserted (const typename Grid::LeafIntersection &intersection) const |
| virtual void | insertVertex (const FieldVector< ctype, dimworld > &pos)=0 |
| Insert a vertex into the coarse grid. More... | |
| virtual DUNE_NO_DEPRECATED_BEGIN 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 DUNE_NO_DEPRECATED_END void | insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices, std::function< FieldVector< ctype, dimworld >(FieldVector< ctype, dimension >)> 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 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... | |
Static Public Member Functions | |
| static void | destroyGrid (Grid *grid) |
| destroy a grid previously obtain from this factory More... | |
Static Public Attributes | |
| static const int | dimension = Grid::dimension |
| dimension of the grid More... | |
| static const int | dimensionworld = Grid::dimensionworld |
| dimension of the world More... | |
| static const bool | supportsBoundaryIds = true |
| are boundary ids supported by this factory? More... | |
| static const bool | supportPeriodicity = MacroData::supportPeriodicity |
| is the factory able to create periodic meshes? More... | |
Static Protected Attributes | |
| static constexpr int | dimworld |
| The grid world dimension. More... | |
Detailed Description
class Dune::GridFactory< AlbertaGrid< dim, dimworld > >
specialization of the generic GridFactory for AlbertaGrid
The GridFactory for AlbertaGrid adds some extensions to the standard GridFactoryInterface. It provides the following additional features:
- It allows to set boundary ids via insertBoundary. For ALBERTA 1.2, these boundary ids are ignored, though.
- For ALBERTA 3.0 and above, you can add face transformation to identify faces. This allows the construction of periodic grids.
- The grid can be written in ALBERTA's native format for macro triangulations via write (both ASCII and XDR format are supported).
- On grid creation, a name can be assigned to the grid.
- On grid creation, the grid can be reordered such that ALBERTA uses the longest edge as refinement edge during recursive bisection.
Member Typedef Documentation
◆ BoundarySegment
| typedef Dune::BoundarySegment< dimension, dimensionworld > Dune::GridFactory< AlbertaGrid< dim, dimworld > >::BoundarySegment |
◆ Communication
|
inherited |
◆ ctype
| typedef Grid::ctype Dune::GridFactory< AlbertaGrid< dim, dimworld > >::ctype |
type of (scalar) coordinates
◆ DuneProjection
| typedef DuneBoundaryProjection< dimensionworld > Dune::GridFactory< AlbertaGrid< dim, dimworld > >::DuneProjection |
◆ DuneProjectionPtr
| typedef std::shared_ptr< const DuneProjection > Dune::GridFactory< AlbertaGrid< dim, dimworld > >::DuneProjectionPtr |
◆ Grid
| typedef AlbertaGrid< dim, dimworld > Dune::GridFactory< AlbertaGrid< dim, dimworld > >::Grid |
type of grid this factory is for
◆ WorldMatrix
| typedef FieldMatrix< ctype, dimensionworld, dimensionworld > Dune::GridFactory< AlbertaGrid< dim, dimworld > >::WorldMatrix |
type of matrix from world coordinates to world coordinates
◆ WorldVector
| typedef FieldVector< ctype, dimensionworld > Dune::GridFactory< AlbertaGrid< dim, dimworld > >::WorldVector |
type of vector for world coordinates
Constructor & Destructor Documentation
◆ GridFactory()
|
inline |
default constructor
◆ ~GridFactory()
|
virtual |
Member Function Documentation
◆ comm()
|
inlineinherited |
Return the Communication used by the grid factory.
Defaults to the Communication induced by the process-local communicator.
◆ createGrid()
|
inlinevirtual |
finalize grid creation and hand over the grid
This version of createGrid is original to the AlbertaGrid grid factroy, allowing to specity a grid name.
- Returns
- a pointer to the newly created grid
- Note
- The caller takes responsibility of freeing the memory allocated for the grid.
- ALBERTA's grid factory provides a static method for freeing the grid (destroyGrid).
Implements Dune::GridFactoryInterface< AlbertaGrid< dim, dimworld > >.
◆ destroyGrid()
|
inlinestatic |
destroy a grid previously obtain from this factory
- Parameters
-
[in] grid pointer to the grid to destroy
◆ insertBoundary()
|
inlinevirtual |
mark a face as boundary (and assign a boundary id)
◆ insertBoundaryProjection() [1/2]
|
inlinevirtual |
insert a global (boundary) projection into the macro grid
◆ insertBoundaryProjection() [2/2]
|
inlinevirtual |
insert a boundary projection into the macro grid
◆ insertBoundarySegment() [1/3]
|
inlinevirtual |
insert a boundary segment into the macro grid
Only influences the ordering of the boundary segments
- Parameters
-
[in] vertices vertex indices of boundary face
Implements Dune::GridFactoryInterface< AlbertaGrid< dim, dimworld > >.
◆ insertBoundarySegment() [2/3]
|
inlinevirtual |
insert a shaped boundary segment into the macro grid
- Parameters
-
[in] vertices vertex indices of boundary face [in] boundarySegment geometric realization of shaped boundary
◆ insertBoundarySegment() [3/3]
|
inlinevirtualinherited |
insert an arbitrarily shaped boundary segment
This method inserts a boundary segment into the coarse grid.
- Parameters
-
[in] vertices the indices of the vertices of the segment [in] boundarySegment user defined implementation of the boundary segment's geometry
◆ insertElement() [1/3]
|
inlinevirtual |
insert an element into the macro grid
- Parameters
-
[in] type GeometryType of the new element [in] vertices indices of the element vertices (in DUNE numbering)
Implements Dune::GridFactoryInterface< AlbertaGrid< dim, dimworld > >.
◆ insertElement() [2/3]
|
inlinevirtualinherited |
Insert a parametrized element into the coarse grid.
- Parameters
-
type The GeometryType of the new element vertices The vertices of the new element, using the DUNE numbering elementParametrization A 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.
- Deprecated:
- [After Dune 2.7] VirtualFunction is deprecated, use the overload taking a std::function instead
◆ insertElement() [3/3]
|
inlinevirtualinherited |
Insert a parametrized element into the coarse grid.
- Parameters
-
type The GeometryType of the new element vertices The vertices of the new element, using the DUNE numbering elementParametrization A 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.
◆ insertFaceTransformation()
|
inline |
add a face transformation (for periodic identification)
A face transformation is an affine mapping T from world coordinates to world coordinates. ALBERTA periodically identifies two faces f and g if T( f ) = g or T( g ) = f.
- Parameters
-
[in] matrix matrix describing the linear part of T [in] shift vector describing T( 0 )
- Note
- ALBERTA requires the matrix to be orthogonal.
- ALBERTA automatically adds the inverse transformation.
◆ insertionIndex() [1/4]
|
inlinevirtual |
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] entity entity whose insertion index is requested
- Returns
- insertion index of the entity
Reimplemented from Dune::GridFactoryInterface< AlbertaGrid< dim, dimworld > >.
◆ insertionIndex() [2/4]
|
inlinevirtual |
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] entity entity whose insertion index is requested
- Returns
- insertion index of the entity
Reimplemented from Dune::GridFactoryInterface< AlbertaGrid< dim, dimworld > >.
◆ insertionIndex() [3/4]
|
inlinevirtual |
◆ insertionIndex() [4/4]
|
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] intersection intersection 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).
◆ insertVertex() [1/2]
|
pure virtualinherited |
Insert a vertex into the coarse grid.
◆ insertVertex() [2/2]
|
inlinevirtual |
insert a vertex into the macro grid
- Parameters
-
[in] pos position of the vertex (in world coordinates)
◆ markLongestEdge()
|
inline |
mark the longest edge as refinemet edge
Marking the longest edge avoids cycles in the recursive bisection algorithm, if the longest edge of each element is unique. It also makes sure the angles degenerate least. It can, hoowever, produce more nonlocal refinements than necessary. Therefore this feature is disabled by default.
◆ wasInserted() [1/2]
|
inlinevirtual |
◆ wasInserted() [2/2]
|
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] intersection intersection in question
- Returns
- true, if the intersection was inserted
◆ write()
|
inline |
write out the macro triangulation in native grid file format
- Parameters
-
[in] filename name of the file to write to
- Returns
trueon success
Member Data Documentation
◆ dimension
|
static |
dimension of the grid
◆ dimensionworld
|
static |
dimension of the world
◆ dimworld
|
staticconstexprprotectedinherited |
The grid world dimension.
◆ supportPeriodicity
|
static |
is the factory able to create periodic meshes?
◆ supportsBoundaryIds
|
static |
are boundary ids supported by this factory?
The documentation for this class was generated from the following file:
