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

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

Inheritance diagram for Dune::GridFactoryInterface< GridType >:

Classes
struct	Codim

Public Types
using	Communication = Dune::Communication< typename MPIHelper::MPICommunicator >

Public Member Functions
	GridFactoryInterface ()
	Default constructor. More...

virtual	~GridFactoryInterface ()
	virtual destructor More...

virtual void	insertVertex (const FieldVector< ctype, dimworld > &pos)=0
	Insert a vertex into the coarse grid. More...

virtual void	insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices)=0
	Insert an element 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)=0
	insert a boundary segment 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 std::unique_ptr< GridType >	createGrid ()=0
	Finalize grid creation and hand over the grid. 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
typedef GridType::ctype	ctype
	Type used by the grid for coordinates. More...

Static Protected Attributes
static const int	dimension = GridType::dimension
	dimension of the grid More...

static constexpr int	dimworld = GridType::dimensionworld
	The grid world dimension. More...

Detailed Description

template<class GridType>
class Dune::GridFactoryInterface< GridType >

Provide a generic factory class for unstructured grids.

This base class declares the interface.

Example use: create a grid consisting of a cube triangulated into 6 tetrahedra:

Left: cube with vertex numbers. Middle: cube triangulated into six tetrahedra. Right: exploded version of the middle figure, with number for the tetrahedra.

Dune::GridFactory<Grid> factory;
 
factory.insertVertex({0, 0, 0});
factory.insertVertex({1, 0, 0});
factory.insertVertex({0, 1, 0});
factory.insertVertex({1, 1, 0});
factory.insertVertex({0, 0, 1});
factory.insertVertex({1, 0, 1});
factory.insertVertex({0, 1, 1});
factory.insertVertex({1, 1, 1});
 
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 1, 3, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 5, 1, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 4, 5, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 6, 4, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 2, 6, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 3, 2, 7});
 
std::shared_ptr<Grid> gridp(factory.createGrid());

Make sure that the inserted elements are not inverted, since not all grids support that. For instance, in the following code snippet the elements 1, 3 and 5 are inverted while elements 0, 2 and 4 are not.

factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 1, 3, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 1, 5, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 4, 5, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 4, 6, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 2, 6, 7});
factory.insertElement(Dune::GeometryTypes::tetrahedron, {0, 2, 3, 7});

Member Typedef Documentation

◆ Communication

template<class GridType >

using Dune::GridFactoryInterface< GridType >::Communication = Dune::Communication<typename MPIHelper::MPICommunicator>

◆ ctype

template<class GridType >

typedef GridType::ctype Dune::GridFactoryInterface< GridType >::ctype

protected

Type used by the grid for coordinates.

Constructor & Destructor Documentation

◆ GridFactoryInterface()

template<class GridType >

Dune::GridFactoryInterface< GridType >::GridFactoryInterface ( )

inline

Default constructor.

◆ ~GridFactoryInterface()

template<class GridType >

virtual Dune::GridFactoryInterface< GridType >::~GridFactoryInterface ( )

inlinevirtual

virtual destructor

Member Function Documentation

◆ comm()

template<class GridType >

Communication Dune::GridFactoryInterface< GridType >::comm ( ) const

inline

Return the Communication used by the grid factory.

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

◆ createGrid()

template<class GridType >

virtual std::unique_ptr< GridType > Dune::GridFactoryInterface< GridType >::createGrid ( )

pure virtual

Finalize grid creation and hand over the grid.

The receiver takes responsibility of the memory allocated for the grid

Implemented in Dune::GridFactory< AlbertaGrid< dim, dimworld > >, Dune::GridFactory< GridType >, Dune::GridFactory< Grid >, Dune::GridFactory< Dune::UGGrid< dim > >, and Dune::GridFactory< UGGrid< dimworld > >.

◆ insertBoundarySegment() [1/2]

template<class GridType >

virtual void Dune::GridFactoryInterface< GridType >::insertBoundarySegment ( const std::vector< unsigned int > & vertices )

pure virtual

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] vertices the indices of the vertices of the segment

Implemented in Dune::GridFactory< AlbertaGrid< dim, dimworld > >, Dune::GridFactory< GridType >, Dune::GridFactory< Grid >, Dune::GridFactory< Dune::UGGrid< dim > >, Dune::GridFactory< UGGrid< dimworld > >, Dune::GridFactory< GridType >, Dune::GridFactory< Grid >, and Dune::GridFactory< Dune::UGGrid< dim > >.

◆ insertBoundarySegment() [2/2]

template<class GridType >

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

inlinevirtual

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

Reimplemented in Dune::GridFactory< GridType >, Dune::GridFactory< Grid >, and Dune::GridFactory< Dune::UGGrid< dim > >.

◆ insertElement() [1/3]

template<class GridType >

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

pure virtual

Insert an element into the coarse grid.

Parameters

type	The GeometryType of the new element
vertices	The 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 elements.

Implemented in Dune::GridFactory< AlbertaGrid< dim, dimworld > >, Dune::GridFactory< GridType >, Dune::GridFactory< Grid >, Dune::GridFactory< Dune::UGGrid< dim > >, and Dune::GridFactory< UGGrid< dimworld > >.

◆ insertElement() [2/3]

template<class GridType >

virtual DUNE_NO_DEPRECATED_BEGIN 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
	)

inlinevirtual

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]

template<class GridType >

virtual DUNE_NO_DEPRECATED_END void Dune::GridFactoryInterface< GridType >::insertElement	(	const GeometryType &	type,
		const std::vector< unsigned int > &	vertices,
		std::function< FieldVector< ctype, dimworld >(FieldVector< ctype, dimension >)>	elementParametrization
	)

inlinevirtual

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.

◆ insertionIndex() [1/3]

template<class GridType >

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

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 in Dune::GridFactory< AlbertaGrid< dim, dimworld > >, and Dune::GridFactory< UGGrid< dimworld > >.

◆ insertionIndex() [2/3]

template<class GridType >

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

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 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

inlinevirtual

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()

template<class GridType >

virtual void Dune::GridFactoryInterface< GridType >::insertVertex ( const FieldVector< ctype, dimworld > & pos )

pure virtual

Insert a vertex into the coarse grid.

Implemented in Dune::GridFactory< GridType >, Dune::GridFactory< Grid >, and Dune::GridFactory< Dune::UGGrid< dim > >.

◆ wasInserted()

template<class GridType >

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

inlinevirtual

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

Member Data Documentation

◆ dimension

template<class GridType >

const int Dune::GridFactoryInterface< GridType >::dimension = GridType::dimension

staticprotected

dimension of the grid

◆ dimworld

template<class GridType >

constexpr int Dune::GridFactoryInterface< GridType >::dimworld = GridType::dimensionworld

staticconstexprprotected

The grid world dimension.

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

common/gridfactory.hh

Classes

Public Types

Public Member Functions

Protected Types

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Communication

◆ ctype

Constructor & Destructor Documentation

◆ GridFactoryInterface()

◆ ~GridFactoryInterface()

Member Function Documentation

◆ comm()

◆ createGrid()

◆ insertBoundarySegment() [1/2]

◆ insertBoundarySegment() [2/2]

◆ insertElement() [1/3]

◆ insertElement() [2/3]

◆ insertElement() [3/3]

◆ insertionIndex() [1/3]

◆ insertionIndex() [2/3]

◆ insertionIndex() [3/3]

◆ insertVertex()

◆ wasInserted()

Member Data Documentation

◆ dimension

◆ dimworld