Specialization of GridFactoryBase for 2D-FoamGrid<2, dimworld> More...

#include <dune/foamgrid/foamgrid/foamgridfactory.hh>

Inheritance diagram for Dune::GridFactory< FoamGrid< 2, dimworld, ct > >:

Public Member Functions
	GridFactory ()

	GridFactory (FoamGrid< 2, dimworld, ctype > *grid)

void	insertBoundarySegment (const std::vector< unsigned int > &vertices) override
	Insert a boundary segment. This is only needed if you want to control the numbering of the boundary segments.

void	insertBoundarySegment (const std::vector< unsigned int > &vertices, const std::shared_ptr< BoundarySegment< dimgrid, dimworld > > &boundarySegment) override
	Insert a boundary segment (== a line) and the boundary segment geometry This influences the ordering of the boundary segments.

bool	wasInserted (const typename FoamGrid< dimgrid, dimworld, ctype >::LeafIntersection &intersection) const override
	Return true if leaf intersection was inserted as boundary segment.

void	insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices) override
	Insert an element into the coarse grid.

void	insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices, std::function< FieldVector< ctype, dimworld >(FieldVector< ctype, dimgrid >)> elementParametrization)
	Insert a parametrized element into the coarse grid.

GridPtrType	createGrid () override
	Finalize grid creation and hand over the grid The receiver takes responsibility of the memory allocated for the grid.

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

unsigned int	insertionIndex (const typename FoamGrid< dimgrid, dimworld, ctype >::Traits::template Codim< 0 >::Entity &entity) const override
	Obtain an element's insertion index.

unsigned int	insertionIndex (const typename FoamGrid< dimgrid, dimworld, ctype >::Traits::template Codim< dimgrid >::Entity &vertex) const override
	Obtain a vertex' insertion index.

unsigned int	insertionIndex (const typename FoamGrid< dimgrid, dimworld, ctype >::LeafIntersection &intersection) const override
	Obtain a boundary's insertion index.

Protected Attributes
FoamGrid< dimgrid, dimworld, ctype > *	grid_

bool	factoryOwnsGrid_

std::vector< FoamGridEntityImp< 0, dimgrid, dimworld, ctype > * >	vertexArray_
	Array containing all vertices.

unsigned int	boundarySegmentCounter_
	Counter that creates the boundary segment indices.

Detailed Description

template<int dimworld, class ct>
class Dune::GridFactory< FoamGrid< 2, dimworld, ct > >

Specialization of GridFactoryBase for 2D-FoamGrid<2, dimworld>

Constructor & Destructor Documentation

◆ GridFactory() [1/2]

template<int dimworld, class ct >

Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::GridFactory ( )

inline

◆ GridFactory() [2/2]

template<int dimworld, class ct >

Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::GridFactory ( FoamGrid< 2, dimworld, ctype > * grid )

inline

Member Function Documentation

◆ createGrid()

template<int dimworld, class ct >

GridPtrType Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::createGrid ( )

inlineoverride

Finalize grid creation and hand over the grid The receiver takes responsibility of the memory allocated for the grid.

◆ insertBoundarySegment() [1/2]

template<int dimworld, class ct >

void Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::insertBoundarySegment ( const std::vector< unsigned int > & vertices )

inlineoverride

Insert a boundary segment. This is only needed if you want to control the numbering of the boundary segments.

◆ insertBoundarySegment() [2/2]

template<int dimworld, class ct >

void Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::insertBoundarySegment	(	const std::vector< unsigned int > &	vertices,
		const std::shared_ptr< BoundarySegment< dimgrid, dimworld > > &	boundarySegment
	)

inlineoverride

Insert a boundary segment (== a line) and the boundary segment geometry This influences the ordering of the boundary segments.

◆ insertElement() [1/2]

template<int dimworld, class ct >

void Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::insertElement	(	const GeometryType &	type,
		const std::vector< unsigned int > &	vertices
	)

inlineoverride

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

◆ insertElement() [2/2]

template<int dimworld, class ct >

void Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::insertElement	(	const GeometryType &	type,
		const std::vector< unsigned int > &	vertices,
		std::function< FieldVector< ctype, dimworld >(FieldVector< ctype, dimgrid >)>	elementParametrization
	)

inline

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

◆ insertionIndex() [1/3]

unsigned int Dune::GridFactoryBase< dimgrid, dimworld, ct >::insertionIndex ( const typename FoamGrid< dimgrid, dimworld, ctype >::LeafIntersection & intersection ) const

inlineoverrideinherited

Obtain a boundary's insertion index.

◆ insertionIndex() [2/3]

unsigned int Dune::GridFactoryBase< dimgrid, dimworld, ct >::insertionIndex ( const typename FoamGrid< dimgrid, dimworld, ctype >::Traits::template Codim< 0 >::Entity & entity ) const

inlineoverrideinherited

Obtain an element's insertion index.

◆ insertionIndex() [3/3]

unsigned int Dune::GridFactoryBase< dimgrid, dimworld, ct >::insertionIndex ( const typename FoamGrid< dimgrid, dimworld, ctype >::Traits::template Codim< dimgrid >::Entity & vertex ) const

inlineoverrideinherited

Obtain a vertex' insertion index.

◆ insertVertex()

void Dune::GridFactoryBase< dimgrid, dimworld, ct >::insertVertex ( const FieldVector< ctype, dimworld > & pos )

inlineoverrideinherited

Insert a vertex into the coarse grid.

◆ wasInserted()

template<int dimworld, class ct >

bool Dune::GridFactory< FoamGrid< 2, dimworld, ct > >::wasInserted ( const typename FoamGrid< dimgrid, dimworld, ctype >::LeafIntersection & intersection ) const

inlineoverride

Return true if leaf intersection was inserted as boundary segment.

Member Data Documentation

◆ boundarySegmentCounter_

unsigned int Dune::GridFactoryBase< dimgrid, dimworld, ct >::boundarySegmentCounter_

protectedinherited

Counter that creates the boundary segment indices.

◆ factoryOwnsGrid_

bool Dune::GridFactoryBase< dimgrid, dimworld, ct >::factoryOwnsGrid_

protectedinherited

◆ grid_

FoamGrid<dimgrid, dimworld, ctype>* Dune::GridFactoryBase< dimgrid, dimworld, ct >::grid_

protectedinherited

◆ vertexArray_

std::vector<FoamGridEntityImp<0, dimgrid, dimworld, ctype>*> Dune::GridFactoryBase< dimgrid, dimworld, ct >::vertexArray_

protectedinherited

Array containing all vertices.

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

foamgridfactory.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GridFactory() [1/2]

◆ GridFactory() [2/2]

Member Function Documentation

◆ createGrid()

◆ insertBoundarySegment() [1/2]

◆ insertBoundarySegment() [2/2]

◆ insertElement() [1/2]

◆ insertElement() [2/2]

◆ insertionIndex() [1/3]

◆ insertionIndex() [2/3]

◆ insertionIndex() [3/3]

◆ insertVertex()

◆ wasInserted()

Member Data Documentation

◆ boundarySegmentCounter_

◆ factoryOwnsGrid_

◆ grid_

◆ vertexArray_