Dune::MMesh< HostGrid, dim > Class Template Reference

The MMesh class templatized by the CGAL host grid type and the dimension. More...

#include <dune/mmesh/grid/mmesh.hh>

Public Types
using	HostGridType = HostGrid
	The hostgrid type.
using	GridFamily = MMeshFamily< dim, HostGrid >
	The grid family type.
using	Point = typename HostGrid::Point
	The point type.
using	FieldType = typename Point::R::RT
	The field type.
using	IdType = MMeshImpl::MultiId
	The type of an id.
using	BoundarySegments = std::unordered_map< IdType, std::size_t >
	The boundary segment map.
using	BoundaryIds = std::unordered_map< std::size_t, std::size_t >
	The boundary id map.
using	InterfaceSegments = std::unordered_map< IdType, std::size_t >
	The interface segment set.
using	Traits = typename GridFamily::Traits
	The Traits.
using	GridImp = typename GridFamily::Traits::Grid
	The grid implementation.
using	GridPtrType = std::unique_ptr< GridImp >
	The unique pointer to the grid.
using	LeafIterator = typename Traits::template Codim< 0 >::LeafIterator
	The leaf iterator.
using	GlobalCoordinate = Dune::FieldVector< FieldType, dimension >
	The type used for coordinates.
template<int cd>
using	HostGridEntity = typename HostGridEntityChooser_< HostGridType, dimension, cd >::type
	The type of the underlying entities.
using	ElementHandle = HostGridEntity< 0 >
	The type of the underlying element handle.
using	FacetHandle = HostGridEntity< 1 >
	The type of the underlying edge handle.
using	EdgeHandle = HostGridEntity< dimension-1 >
	The type of the underlying edge handle.
using	VertexHandle = HostGridEntity< dimension >
	The type of the underlying vertex handle.
using	ElementOutput = std::list< HostGridEntity< 0 > >
	The type of the element output.
using	BoundaryEdgesOutput = std::list< FacetHandle >
	The type of the boundary edges output.
using	Entity = typename Traits::template Codim< 0 >::Entity
	The type of a codim 0 entity.
using	Facet = typename Traits::template Codim< 1 >::Entity
	The type of a codim 1 entity ('facet')
using	Edge = typename Traits::template Codim< dimension-1 >::Entity
	The type of a codim dim-1 entity ('edge')
using	Vertex = typename Traits::template Codim< dimension >::Entity
	The type of a codim dim entity ('vertex')
using	CachingEntity = MMeshCachingEntity< 0, dimension, const GridImp >
	The type of a caching entity.
using	ConnectedComponent = MMeshConnectedComponent< const GridImp >
	The type used to store connected components of entities.
using	InterfaceElement = typename Traits::template Codim< 1 >::Entity
	The type of an interface element.
using	Intersection = typename Traits::LeafIntersection
	The type of an intersection.
using	InterfaceGrid = MMeshInterfaceGrid< GridImp >
	The type of the interface grid.
using	InterfaceEntity = typename InterfaceGrid::Traits::template Codim< 0 >::Entity
	The type of an interface grid entity.
using	InterfaceGridConnectedComponent = MMeshInterfaceConnectedComponent< const InterfaceGrid >
	The type of a connected component of interface grid entities.
using	RefinementInsertionPoint = RefinementInsertionPointStruct< Point, Edge, IdType, VertexHandle, InterfaceGridConnectedComponent >
	The type of a refinement insertion point.
using	RemeshingIndicator = RatioIndicator< GridImp >
	The type of the employed remeshing indicator.
using	RefinementStrategy = LongestEdgeRefinement< GridImp >
	The type of the employed refinement strategy.
using	InterfaceRefinementStrategy = LongestEdgeRefinement< InterfaceGrid >
	The type of the employed refinement strategy for the interface grid.

Public Member Functions
	MMesh (HostGrid hostgrid)
	Constructor that takes a CGAL triangulation.
	MMesh (HostGrid hostgrid, BoundarySegments boundarySegments, BoundarySegments interfaceBoundarySegments, BoundaryIds boundaryIds, InterfaceSegments interfaceSegments)
	Constructor that takes additional about interface and boundary.
const GridImp *	This () const
	This pointer to derived class.
void	update ()
	update the grid indices and ids
int	maxLevel () const
	Return maximum level defined in this grid. More...
int	size (int level, int codim) const
	Number of grid entities per level and codim.
size_t	numBoundarySegments () const
	returns the number of boundary segments within the macro grid
const BoundarySegments &	boundarySegments () const
	returns the boundary segment to index map
const BoundaryIds &	boundaryIds () const
	returns the boundary segment index to boundary id map
const InterfaceSegments &	interfaceSegments () const
	returns the interface segment set
InterfaceSegments &	interfaceSegments ()
	returns the interface segment set
void	addInterface (const Intersection &intersection, const std::size_t marker=1)
	Add an intersection to the interface.
template<class I >
void	addInterface (const I &intersection, const std::size_t marker=1)
	Add wrapped intersection to the interface.
int	size (int codim) const
	number of leaf entities per codim in this process
int	size (int level, GeometryType type) const
	number of entities per level, codim and geometry type in this process
int	size (GeometryType type) const
	number of leaf entities per codim and geometry type in this process
const Traits::GlobalIdSet &	globalIdSet () const
	Access to the GlobalIdSet.
const Traits::LocalIdSet &	localIdSet () const
	Access to the LocalIdSet.
const MMeshLeafIndexSet< const GridImp > &	levelIndexSet (int level) const
	Access to the LevelIndexSets.
const MMeshLeafIndexSet< const GridImp > &	leafIndexSet () const
	Access to the LeafIndexSet.
template<class EntitySeed >
Traits::template Codim< EntitySeed::codimension >::Entity	entity (const EntitySeed &seed) const
	Create Entity from EntitySeed.
Vertex	entity (const HostGridEntity< dimension > &vertexHandle) const
	Return the entity corresponding to a vertex handle.
Entity	entity (const HostGridEntity< 0 > &elementHandle) const
	Return the entity corresponding to a element handle.
template<int codim>
Traits::template Codim< codim >::LevelIterator	lbegin (int level) const
	Iterator to first entity of given codim on level.
template<int codim>
Traits::template Codim< codim >::LevelIterator	lend (int level) const
	one past the end on this level
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >::template Partition< PiType >::LevelIterator	lbegin (int level) const
	Iterator to first entity of given codim on level.
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >::template Partition< PiType >::LevelIterator	lend (int level) const
	one past the end on this level
template<int codim>
Traits::template Codim< codim >::LeafIterator	leafbegin () const
	Iterator to first leaf entity of given codim.
template<int codim>
Traits::template Codim< codim >::LeafIterator	leafend () const
	one past the end of the sequence of leaf entities
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >::template Partition< PiType >::LeafIterator	leafbegin () const
	Iterator to first leaf entity of given codim.
template<int codim, PartitionIteratorType PiType>
Traits::template Codim< codim >::template Partition< PiType >::LeafIterator	leafend () const
	one past the end of the sequence of leaf entities
template<int codim>
MMeshInterfaceIterator< codim, const GridImp >	interfaceBegin (bool includeBoundary=false) const
	iterator to first interface entity
template<int codim>
MMeshInterfaceIterator< codim, const GridImp >	interfaceEnd (bool includeBoundary=false) const
	one past the end of the sequence of interface entities
MMeshInterfaceVertexIterator< const GridImp >	interfaceVerticesBegin (bool includeBoundary=false) const
	iterator to first interface entity
MMeshInterfaceVertexIterator< const GridImp >	interfaceVerticesEnd (bool includeBoundary=false) const
	one past the end of the sequence of interface entities
bool	isInterface (const Vertex &vertex) const
	Return if vertex is part of the interface.
bool	isInterface (const Intersection &intersection) const
	Return if intersection is part of the interface.
template<class OtherIntersection >
bool	isInterface (const OtherIntersection &intersection) const
	Return if intersection is part of the interface.
bool	isInterface (const InterfaceElement &segment) const
	Return if element is part of the interface.
template<int d = dim>
std::enable_if_t< d==3, bool >	isInterface (const Edge &edge) const
	Return if edge in 3d is part of an interface segment.
bool	isOnInterface (const Entity &entity) const
	Return if entity shares a facet with the interface.
InterfaceEntity	asInterfaceEntity (const InterfaceElement &segment) const
	Return a codim 1 entity as a interface grid codim 0 entity.
InterfaceEntity	asInterfaceEntity (const Intersection &intersection) const
	Return an intersection as a interface grid codim 0 entity.
template<class OtherIntersection >
InterfaceEntity	asInterfaceEntity (const OtherIntersection &intersection) const
	Return an intersection as a interface grid codim 0 entity.
Intersection	asIntersection (const InterfaceEntity &interfaceEntity) const
	Return an interface entity as intersection of a MMesh entity.
Intersection	asIntersection (const Facet &facet) const
	Return a facet as intersection.
Intersection	asIntersection (const FacetHandle &host) const
	Return a host facet as intersection.
const Entity	locate (const GlobalCoordinate &p, const Entity &element={}) const
	Locate an entity by coordinate using CGAL's locate.
void	globalRefine (int steps=1)
	Global refine. More...
bool	mark (int refCount, const typename Traits::template Codim< 0 >::Entity &e) const
	Mark entity for refinement. More...
bool	markElements ()
	Mark elements for adaption using the default remeshing indicator. More...
int	getMark (const typename Traits::template Codim< 0 >::Entity &e) const
	Return refinement mark for entity. More...
bool	preAdapt ()
	returns false, if at least one entity is marked for adaption
void	refineEdge (const Entity &entity, const std::size_t edgeIndex, const double where=0.5)
	Refine edge manually.
void	insertVertexInCell (const GlobalCoordinate &position)
	Insert vertex in cell manually.
void	removeVertex (const typename InterfaceGrid::Traits::template Codim< dim-1 >::Entity &interfaceVertex)
	Remove interface vertex manually.
void	removeVertex (const Vertex &vertex)
	Remove vertex manually.
bool	adapt ()
	Triggers the grid adaptation process. More...
bool	ensureInterfaceMovement (std::vector< GlobalCoordinate > shifts)
	Mark elements such that after movement of interface vertices no cell degenerates. More...
bool	ensureVertexMovement (std::vector< GlobalCoordinate > shifts)
	Mark elements such that after movement of vertices no cell degenerates. More...
template<class GridImp , class DataHandle >
bool	adapt (AdaptDataHandleInterface< GridImp, DataHandle > &handle)
	Callback for the grid adaptation process with restrict/prolong.
void	moveInterface (const std::vector< GlobalCoordinate > &shifts)
	Move interface vertices. More...
void	moveVertices (const std::vector< GlobalCoordinate > &shifts)
	Move vertices. More...
template<typename Vertex >
void	addToInterface (const Vertex &vertex, const GlobalCoordinate &p)
	Insert p into the triangulation and add a new interface segment between p and vertex.
void	postAdapt ()
	Clean up refinement markers.
unsigned int	overlapSize (int codim) const
	Size of the overlap on the leaf level.
unsigned int	ghostSize (int codim) const
	Size of the ghost cell layer on the leaf level.
unsigned int	overlapSize (int level, int codim) const
	Size of the overlap on a given level.
unsigned int	ghostSize (int level, int codim) const
	Size of the ghost cell layer on a given level.
void	loadBalance ()
	Distributes this grid over the available nodes in a distributed machine.
template<class T >
bool	loadBalance (const T &t)
	Distributes this grid over the available nodes in a distributed machine. More...
const Communication< Comm > &	comm () const
	Communication.
const HostGrid &	getHostGrid () const
	Get reference to the underlying CGAL triangulation.
HostGrid &	getHostGrid ()
	Get non-const reference to the underlying CGAL triangulation.
const InterfaceGrid &	interfaceGrid () const
	Get reference to the interface grid.
InterfaceGrid &	interfaceGrid ()
	Get a non-const reference to the interface grid.
const auto &	interfaceGridPtr ()
	Get a pointer to the interface grid.

Static Public Attributes
static constexpr int	dimension = dim
	The world dimension.

Detailed Description

template<class HostGrid, int dim>
class Dune::MMesh< HostGrid, dim >

The MMesh class templatized by the CGAL host grid type and the dimension.

Member Function Documentation

adapt()

template<class HostGrid , int dim>

bool Dune::MMesh< HostGrid, dim >::adapt ( )

inline

Triggers the grid adaptation process.

Returns

if triangulation has changed

References Dune::LongestEdgeRefinement< Grid >::coarsening(), Dune::MMesh< HostGrid, dim >::entity(), Dune::MMeshInterfaceGrid< MMesh >::getMark(), Dune::MMesh< HostGrid, dim >::globalIdSet(), Dune::MMesh< HostGrid, dim >::interfaceGrid(), Dune::MMesh< HostGrid, dim >::isInterface(), Dune::MMesh< HostGrid, dim >::mark(), and Dune::LongestEdgeRefinement< Grid >::refinement().

Referenced by Dune::MMeshInterfaceGrid< MMesh >::adapt(), Dune::MMesh< HostGrid, dim >::adapt(), and Dune::MMesh< HostGrid, dim >::globalRefine().

ensureInterfaceMovement()

template<class HostGrid , int dim>

bool Dune::MMesh< HostGrid, dim >::ensureInterfaceMovement ( std::vector< GlobalCoordinate >  shifts )

inline

Mark elements such that after movement of interface vertices no cell degenerates.

Parameters

shifts

Vector that maps interface vertex index to global coordinate

Returns

If elements have been marked.

References Dune::LongestEdgeRefinement< Grid >::boundaryFlag(), Dune::MMesh< HostGrid, dim >::dimension, Dune::MMesh< HostGrid, dim >::entity(), Dune::MMeshInterfaceGrid< MMesh >::entity(), Dune::MMesh< HostGrid, dim >::globalIdSet(), Dune::MMesh< HostGrid, dim >::interfaceGrid(), Dune::MMesh< HostGrid, dim >::isInterface(), Dune::LongestEdgeRefinement< Grid >::isRemoveable(), Dune::MMeshInterfaceGrid< MMesh >::leafIndexSet(), and Dune::MMesh< HostGrid, dim >::moveInterface().

ensureVertexMovement()

template<class HostGrid , int dim>

bool Dune::MMesh< HostGrid, dim >::ensureVertexMovement ( std::vector< GlobalCoordinate >  shifts )

inline

Mark elements such that after movement of vertices no cell degenerates.

Parameters

shifts

Vector that maps vertex index to GlobalCoordinate

Returns

If elements have been marked.

References Dune::LongestEdgeRefinement< Grid >::boundaryFlag(), Dune::MMesh< HostGrid, dim >::dimension, Dune::MMesh< HostGrid, dim >::globalIdSet(), and Dune::MMesh< HostGrid, dim >::moveVertices().

getMark()

template<class HostGrid , int dim>

int Dune::MMesh< HostGrid, dim >::getMark ( const typename Traits::template Codim< 0 >::Entity &  e ) const

inline

Return refinement mark for entity.

Returns

refinement mark

globalRefine()

template<class HostGrid , int dim>

void Dune::MMesh< HostGrid, dim >::globalRefine ( int  steps = 1 )

inline

Global refine.

Marks all elements for refinement and adapts the grid

References Dune::MMesh< HostGrid, dim >::adapt(), Dune::MMesh< HostGrid, dim >::mark(), Dune::MMesh< HostGrid, dim >::postAdapt(), and Dune::MMesh< HostGrid, dim >::preAdapt().

loadBalance()

template<class HostGrid , int dim>

template<class T >

bool Dune::MMesh< HostGrid, dim >::loadBalance ( const T &  t )

inline

Distributes this grid over the available nodes in a distributed machine.

Parameters

minlevel	The coarsest grid level that gets distributed
maxlevel	does currently get ignored

mark()

template<class HostGrid , int dim>

bool Dune::MMesh< HostGrid, dim >::mark ( int  refCount, const typename Traits::template Codim< 0 >::Entity &  e  ) const

inline

Mark entity for refinement.

This only works for entities of codim 0.

Referenced by Dune::MMesh< HostGrid, dim >::adapt(), Dune::MMesh< HostGrid, dim >::globalRefine(), Dune::MMesh< HostGrid, dim >::markElements(), and Dune::MMesh< HostGrid, dim >::postAdapt().

markElements()

template<class HostGrid , int dim>

bool Dune::MMesh< HostGrid, dim >::markElements ( )

inline

Mark elements for adaption using the default remeshing indicator.

Returns

if elements have been marked.

References Dune::MMesh< HostGrid, dim >::mark(), and Dune::RatioIndicator< Grid >::update().

maxLevel()

template<class HostGrid , int dim>

int Dune::MMesh< HostGrid, dim >::maxLevel ( ) const

inline

Return maximum level defined in this grid.

Levels are numbered 0 ... maxlevel with 0 the coarsest level.

moveInterface()

template<class HostGrid , int dim>

void Dune::MMesh< HostGrid, dim >::moveInterface ( const std::vector< GlobalCoordinate > &  shifts )

inline

Move interface vertices.

Parameters

shifts

Vector that maps interface vertex indices to GlobalCoordinate

References Dune::MMesh< HostGrid, dim >::dimension, Dune::MMesh< HostGrid, dim >::interfaceGrid(), and Dune::MMeshInterfaceGrid< MMesh >::leafIndexSet().

Referenced by Dune::MMesh< HostGrid, dim >::ensureInterfaceMovement().

moveVertices()

template<class HostGrid , int dim>

void Dune::MMesh< HostGrid, dim >::moveVertices ( const std::vector< GlobalCoordinate > &  shifts )

inline

Move vertices.

Parameters

shifts

Vector that maps interface vertex indices to GlobalCoordinate

References Dune::MMesh< HostGrid, dim >::dimension, and Dune::MMesh< HostGrid, dim >::leafIndexSet().

Referenced by Dune::MMesh< HostGrid, dim >::ensureVertexMovement().

---

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

• dune/mmesh/grid/declaration.hh
• dune/mmesh/grid/mmesh.hh