Grid abstract base class. More...

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

Inheritance diagram for Dune::Grid< dim, dimworld, ct, GridFamily >:

Classes
struct	Codim
	A Traits struct that collects all associated types of one implementation. More...

Exported types
typedef GridFamily::Traits::LeafGridView	LeafGridView
	type of view for leaf grid More...

typedef GridFamily::Traits::LevelGridView	LevelGridView
	type of view for level grid More...

typedef GridFamily::Traits::LeafIntersection	LeafIntersection
	A type that is a model of Dune::Intersection, an intersections of two codimension 1 of two codimension 0 entities in the leaf view. More...

typedef GridFamily::Traits::LevelIntersection	LevelIntersection
	A type that is a model of Dune::Intersection, an intersections of two codimension 1 of two codimension 0 entities in a level view. More...

typedef GridFamily::Traits::LeafIntersectionIterator	LeafIntersectionIterator
	A type that is a model of Dune::IntersectionIterator which is an iterator that allows to examine, but not to modify, the intersections of codimension 1 of an leaf element (entity of codimension 0) with other leaf elements. More...

typedef GridFamily::Traits::LevelIntersectionIterator	LevelIntersectionIterator
	A type that is a model of Dune::IntersectionIterator which is an iterator that allows to examine, but not to modify, the intersections of codimension 1 of an element (entity of codimension 0) with other elements on the same level. More...

typedef GridFamily::Traits::HierarchicIterator	HierarchicIterator
	A type that is a model of Dune::HierarchicIterator A type of iterator that allows to examine, but not to modify, entities of codimension 0 that result from refinement of an entity of codimension 0. More...

typedef GridFamily::Traits::LevelIndexSet	LevelIndexSet
	A type that is a model of Dune::IndexSet which provides a consecutive, but non persistent, numbering for entities on a grid level. More...

typedef GridFamily::Traits::LeafIndexSet	LeafIndexSet
	A type that is a model of Dune::IndexSet which provides a consecutive, but non persistent, numbering for entities in the leaf grid. More...

typedef GridFamily::Traits::GlobalIdSet	GlobalIdSet
	A type that is a model of Dune::IdSet which provides a unique and persistent numbering for all entities in the grid. The numbering is unique over all processes over which the grid is partitioned. The numbering is not necessarily consecutive. More...

typedef GridFamily::Traits::LocalIdSet	LocalIdSet
	A type that is a model of Dune::IdSet which provides a unique and persistent numbering for all entities in the grid. The numbering is only unique in a single process and it is not necessarily consecutive. More...

using	Communication = detected_or_fallback_t< DeprecatedCollectiveCommunication_t, Communication_t, typename GridFamily::Traits >
	A type that is a model of Dune::Communication. It provides a portable way for communication on the set of processes used by the grid. More...

using	CollectiveCommunication = Communication

typedef ct	ctype
	Define type used for coordinates in grid module. More...

template<class T >
using	Communication_t = typename T::Communication

template<class T >
using	DeprecatedCollectiveCommunication_t = typename T::CollectiveCommunication

Exported constants
static constexpr int	dimension = dim
	The dimension of the grid. More...

static constexpr int	dimensionworld = dimworld
	The dimension of the world the grid lives in. More...

Size methods
int	maxLevel () const
	Return maximum level defined in this grid. Levels are numbered 0 ... maxLevel with 0 the coarsest level. More...

int	size (int level, int codim) const
	Return number of grid entities of a given codim on a given level in this process. More...

int	size (int codim) const
	Return number of leaf entities of a given codim in this process. More...

int	size (int level, GeometryType type) const
	Return number of entities per level and geometry type in this process. More...

int	size (GeometryType type) const
	Return number of leaf entities per geometry type in this process. More...

size_t	numBoundarySegments () const
	returns the number of boundary segments within the macro grid More...

Views
LevelGridView	levelGridView (int level) const
	View for a grid level for All_Partition. More...

LeafGridView	leafGridView () const
	View for the leaf grid for All_Partition. More...

Access to index and id sets
const GlobalIdSet &	globalIdSet () const
	return const reference to the grids global id set More...

const LocalIdSet &	localIdSet () const
	return const reference to the grids local id set More...

const LevelIndexSet &	levelIndexSet (int level) const
	return const reference to the grids level index set for level level More...

const LeafIndexSet &	leafIndexSet () const
	return const reference to the grids leaf index set More...

Adaptivity and grid refinement
void	globalRefine (int refCount)
	Refine the grid refCount times using the default refinement rule. More...

bool	mark (int refCount, const typename Codim< 0 >::Entity &e)
	Marks an entity to be refined/coarsened in a subsequent adapt. More...

int	getMark (const typename Codim< 0 >::Entity &e) const
	returns adaptation mark for given entity More...

bool	preAdapt ()
	To be called after entities have been marked and before adapt() is called. More...

bool	adapt ()
	Refine all positive marked leaf entities, coarsen all negative marked entities if possible. More...

void	postAdapt ()
	To be called after grid has been adapted and information left over by the adaptation has been processed. More...

Parallel data distribution and communication
const Communication &	comm () const
	return const reference to a communication object. The return type is a model of Dune::Communication. More...

bool	loadBalance ()
	Re-balances the load each process has to handle for a parallel grid,. More...

template<class DataHandle >
bool	loadBalance (DataHandle &data)
	Re-balances the load each process has to handle for a parallel grid and moves the data. More...

template<class EntitySeed >
Codim< EntitySeed::codimension >::Entity	entity (const EntitySeed &seed) const
	obtain Entity from EntitySeed. More...

GridImp &	asImp ()
	Barton-Nackman trick. More...

const GridImp &	asImp () const
	Barton-Nackman trick. More...

Detailed Description

template<int dim, int dimworld, class ct, class GridFamily>
class Dune::Grid< dim, dimworld, ct, GridFamily >

Grid abstract base class.

This class is the base class for all grid implementations. Although no virtual functions are used we call it abstract since its methods do not contain an implementation but forward to the methods of the derived class via the Barton-Nackman trick.

Template Parameters

dim	specifies the dimension of the grid.
dimworld	specifies the dimension of the surrounding space, this can be different from dim, if the grid is defined on a manifold .
ct	field type of the world vector space.
GridFamily	traits class providing all types associated with the grid implementation.

Member Typedef Documentation

◆ CollectiveCommunication

template<int dim, int dimworld, class ct , class GridFamily >

using Dune::Grid< dim, dimworld, ct, GridFamily >::CollectiveCommunication = Communication

Deprecated:: Use Communication instead! Will be removed at some point in the future.

◆ Communication

template<int dim, int dimworld, class ct , class GridFamily >

using Dune::Grid< dim, dimworld, ct, GridFamily >::Communication = detected_or_fallback_t< DeprecatedCollectiveCommunication_t, Communication_t, typename GridFamily::Traits>

A type that is a model of Dune::Communication. It provides a portable way for communication on the set of processes used by the grid.

◆ Communication_t

template<int dim, int dimworld, class ct , class GridFamily >

template<class T >

using Dune::Grid< dim, dimworld, ct, GridFamily >::Communication_t = typename T::Communication

protected

◆ ctype

template<int dim, int dimworld, class ct , class GridFamily >

typedef ct Dune::Grid< dim, dimworld, ct, GridFamily >::ctype

Define type used for coordinates in grid module.

◆ DeprecatedCollectiveCommunication_t

template<int dim, int dimworld, class ct , class GridFamily >

template<class T >

using Dune::Grid< dim, dimworld, ct, GridFamily >::DeprecatedCollectiveCommunication_t = typename T::CollectiveCommunication

protected

◆ GlobalIdSet

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::GlobalIdSet Dune::Grid< dim, dimworld, ct, GridFamily >::GlobalIdSet

A type that is a model of Dune::IdSet which provides a unique and persistent numbering for all entities in the grid. The numbering is unique over all processes over which the grid is partitioned. The numbering is not necessarily consecutive.

◆ HierarchicIterator

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::HierarchicIterator Dune::Grid< dim, dimworld, ct, GridFamily >::HierarchicIterator

A type that is a model of Dune::HierarchicIterator A type of iterator that allows to examine, but not to modify, entities of codimension 0 that result from refinement of an entity of codimension 0.

◆ LeafGridView

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LeafGridView Dune::Grid< dim, dimworld, ct, GridFamily >::LeafGridView

type of view for leaf grid

◆ LeafIndexSet

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LeafIndexSet Dune::Grid< dim, dimworld, ct, GridFamily >::LeafIndexSet

A type that is a model of Dune::IndexSet which provides a consecutive, but non persistent, numbering for entities in the leaf grid.

◆ LeafIntersection

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LeafIntersection Dune::Grid< dim, dimworld, ct, GridFamily >::LeafIntersection

A type that is a model of Dune::Intersection, an intersections of two codimension 1 of two codimension 0 entities in the leaf view.

◆ LeafIntersectionIterator

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LeafIntersectionIterator Dune::Grid< dim, dimworld, ct, GridFamily >::LeafIntersectionIterator

A type that is a model of Dune::IntersectionIterator which is an iterator that allows to examine, but not to modify, the intersections of codimension 1 of an leaf element (entity of codimension 0) with other leaf elements.

◆ LevelGridView

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LevelGridView Dune::Grid< dim, dimworld, ct, GridFamily >::LevelGridView

type of view for level grid

◆ LevelIndexSet

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LevelIndexSet Dune::Grid< dim, dimworld, ct, GridFamily >::LevelIndexSet

A type that is a model of Dune::IndexSet which provides a consecutive, but non persistent, numbering for entities on a grid level.

◆ LevelIntersection

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LevelIntersection Dune::Grid< dim, dimworld, ct, GridFamily >::LevelIntersection

A type that is a model of Dune::Intersection, an intersections of two codimension 1 of two codimension 0 entities in a level view.

◆ LevelIntersectionIterator

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LevelIntersectionIterator Dune::Grid< dim, dimworld, ct, GridFamily >::LevelIntersectionIterator

A type that is a model of Dune::IntersectionIterator which is an iterator that allows to examine, but not to modify, the intersections of codimension 1 of an element (entity of codimension 0) with other elements on the same level.

◆ LocalIdSet

template<int dim, int dimworld, class ct , class GridFamily >

typedef GridFamily::Traits::LocalIdSet Dune::Grid< dim, dimworld, ct, GridFamily >::LocalIdSet

A type that is a model of Dune::IdSet which provides a unique and persistent numbering for all entities in the grid. The numbering is only unique in a single process and it is not necessarily consecutive.

Member Function Documentation

◆ adapt()

template<int dim, int dimworld, class ct , class GridFamily >

bool Dune::Grid< dim, dimworld, ct, GridFamily >::adapt ( )

inline

Refine all positive marked leaf entities, coarsen all negative marked entities if possible.

\return true if a least one entity was refined

The complete adaptation process works as follows:

- mark entities with the mark() method
- call preAdapt()
- if preAdapt() returned true: possibly save current solution
- call adapt()
- if adapt() returned true: possibly interpolate the (saved) solution
- call postAdapt()

◆ asImp() [1/2]

template<int dim, int dimworld, class ct , class GridFamily >

GridImp & Dune::Grid< dim, dimworld, ct, GridFamily >::asImp ( )

inlineprotected

Barton-Nackman trick.

◆ asImp() [2/2]

template<int dim, int dimworld, class ct , class GridFamily >

const GridImp & Dune::Grid< dim, dimworld, ct, GridFamily >::asImp ( ) const

inlineprotected

Barton-Nackman trick.

◆ comm()

template<int dim, int dimworld, class ct , class GridFamily >

const Communication & Dune::Grid< dim, dimworld, ct, GridFamily >::comm ( ) const

inline

return const reference to a communication object. The return type is a model of Dune::Communication.

◆ entity()

template<int dim, int dimworld, class ct , class GridFamily >

template<class EntitySeed >

Codim< EntitySeed::codimension >::Entity Dune::Grid< dim, dimworld, ct, GridFamily >::entity ( const EntitySeed & seed ) const

inline

obtain Entity from EntitySeed.

◆ getMark()

template<int dim, int dimworld, class ct , class GridFamily >

int Dune::Grid< dim, dimworld, ct, GridFamily >::getMark ( const typename Codim< 0 >::Entity & e ) const

inline

returns adaptation mark for given entity

Parameters

[in] e Entity for which adaptation mark should be determined

Returns: int adaptation mark currently set for given Entity e

◆ globalIdSet()

template<int dim, int dimworld, class ct , class GridFamily >

const GlobalIdSet & Dune::Grid< dim, dimworld, ct, GridFamily >::globalIdSet ( ) const

inline

return const reference to the grids global id set

◆ globalRefine()

template<int dim, int dimworld, class ct , class GridFamily >

void Dune::Grid< dim, dimworld, ct, GridFamily >::globalRefine ( int refCount )

inline

Refine the grid refCount times using the default refinement rule.

This behaves like marking all elements for refinement and then calling preAdapt, adapt and postAdapt. The state after globalRefine is comparable to the state after postAdapt.

◆ leafGridView()

template<int dim, int dimworld, class ct , class GridFamily >

LeafGridView Dune::Grid< dim, dimworld, ct, GridFamily >::leafGridView ( ) const

inline

View for the leaf grid for All_Partition.

◆ leafIndexSet()

template<int dim, int dimworld, class ct , class GridFamily >

const LeafIndexSet & Dune::Grid< dim, dimworld, ct, GridFamily >::leafIndexSet ( ) const

inline

return const reference to the grids leaf index set

◆ levelGridView()

template<int dim, int dimworld, class ct , class GridFamily >

LevelGridView Dune::Grid< dim, dimworld, ct, GridFamily >::levelGridView ( int level ) const

inline

View for a grid level for All_Partition.

◆ levelIndexSet()

template<int dim, int dimworld, class ct , class GridFamily >

const LevelIndexSet & Dune::Grid< dim, dimworld, ct, GridFamily >::levelIndexSet ( int level ) const

inline

return const reference to the grids level index set for level level

◆ loadBalance() [1/2]

template<int dim, int dimworld, class ct , class GridFamily >

bool Dune::Grid< dim, dimworld, ct, GridFamily >::loadBalance ( )

inline

Re-balances the load each process has to handle for a parallel grid,.

Returns: True if the grid has changed.

◆ loadBalance() [2/2]

template<int dim, int dimworld, class ct , class GridFamily >

template<class DataHandle >

bool Dune::Grid< dim, dimworld, ct, GridFamily >::loadBalance ( DataHandle & data )

inline

Re-balances the load each process has to handle for a parallel grid and moves the data.

Parameters

data	A data handle telling the method which data should be communicated and how. Has to adhere to the interface describe by CommDataHandleIf just like the data handle for the communicate methods.

Returns: True if the grid has changed.

◆ localIdSet()

template<int dim, int dimworld, class ct , class GridFamily >

const LocalIdSet & Dune::Grid< dim, dimworld, ct, GridFamily >::localIdSet ( ) const

inline

return const reference to the grids local id set

◆ mark()

template<int dim, int dimworld, class ct , class GridFamily >

bool Dune::Grid< dim, dimworld, ct, GridFamily >::mark	(	int	refCount,
		const typename Codim< 0 >::Entity &	e
	)

inline

Marks an entity to be refined/coarsened in a subsequent adapt.

Parameters

[in]	refCount	Number of subdivisions that should be applied. Negative value means coarsening.
[in]	e	Entity that should be marked

Returns: true if Entity was marked, false otherwise.

◆ maxLevel()

template<int dim, int dimworld, class ct , class GridFamily >

int Dune::Grid< dim, dimworld, ct, GridFamily >::maxLevel ( ) const

inline

Return maximum level defined in this grid. Levels are numbered 0 ... maxLevel with 0 the coarsest level.

◆ numBoundarySegments()

template<int dim, int dimworld, class ct , class GridFamily >

size_t Dune::Grid< dim, dimworld, ct, GridFamily >::numBoundarySegments ( ) const

inline

returns the number of boundary segments within the macro grid

Returns: number of boundary segments within the macro grid

◆ postAdapt()

template<int dim, int dimworld, class ct , class GridFamily >

void Dune::Grid< dim, dimworld, ct, GridFamily >::postAdapt ( )

inline

To be called after grid has been adapted and information left over by the adaptation has been processed.

This removes the isNew flags of the elements from the last adapt call.

◆ preAdapt()

template<int dim, int dimworld, class ct , class GridFamily >

bool Dune::Grid< dim, dimworld, ct, GridFamily >::preAdapt ( )

inline

To be called after entities have been marked and before adapt() is called.

This sets the mightVanish flags of the elements for the next adapt call.

Returns: true if an entity may be coarsened during a subsequent adapt(), false otherwise.

◆ size() [1/4]

template<int dim, int dimworld, class ct , class GridFamily >

int Dune::Grid< dim, dimworld, ct, GridFamily >::size ( GeometryType type ) const

inline

Return number of leaf entities per geometry type in this process.

◆ size() [2/4]

template<int dim, int dimworld, class ct , class GridFamily >

int Dune::Grid< dim, dimworld, ct, GridFamily >::size ( int codim ) const

inline

Return number of leaf entities of a given codim in this process.

◆ size() [3/4]

template<int dim, int dimworld, class ct , class GridFamily >

int Dune::Grid< dim, dimworld, ct, GridFamily >::size	(	int	level,
		GeometryType	type
	)		const

inline

Return number of entities per level and geometry type in this process.

◆ size() [4/4]

template<int dim, int dimworld, class ct , class GridFamily >

int Dune::Grid< dim, dimworld, ct, GridFamily >::size	(	int	level,
		int	codim
	)		const

inline

Return number of grid entities of a given codim on a given level in this process.

Member Data Documentation

◆ dimension

template<int dim, int dimworld, class ct , class GridFamily >

constexpr int Dune::Grid< dim, dimworld, ct, GridFamily >::dimension = dim

staticconstexpr

The dimension of the grid.

◆ dimensionworld

template<int dim, int dimworld, class ct , class GridFamily >

constexpr int Dune::Grid< dim, dimworld, ct, GridFamily >::dimensionworld = dimworld

staticconstexpr

The dimension of the world the grid lives in.

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

common/grid.hh

Classes

Exported types

Exported constants

Size methods

Views

Access to index and id sets

Adaptivity and grid refinement

Parallel data distribution and communication

Detailed Description

Member Typedef Documentation

◆ CollectiveCommunication

◆ Communication

◆ Communication_t

◆ ctype

◆ DeprecatedCollectiveCommunication_t

◆ GlobalIdSet

◆ HierarchicIterator

◆ LeafGridView

◆ LeafIndexSet

◆ LeafIntersection

◆ LeafIntersectionIterator

◆ LevelGridView

◆ LevelIndexSet

◆ LevelIntersection

◆ LevelIntersectionIterator

◆ LocalIdSet

Member Function Documentation

◆ adapt()

◆ asImp() [1/2]

◆ asImp() [2/2]

◆ comm()

◆ entity()

◆ getMark()

◆ globalIdSet()

◆ globalRefine()

◆ leafGridView()

◆ leafIndexSet()

◆ levelGridView()

◆ levelIndexSet()

◆ loadBalance() [1/2]

◆ loadBalance() [2/2]

◆ localIdSet()

◆ mark()

◆ maxLevel()

◆ numBoundarySegments()

◆ postAdapt()

◆ preAdapt()

◆ size() [1/4]

◆ size() [2/4]

◆ size() [3/4]

◆ size() [4/4]

Member Data Documentation

◆ dimension

◆ dimensionworld