# Dune Core Modules (2.6.0)

Dune::Grid< dim, dimworld, ct, GridFamily > Class Template Reference

Grid abstract base class. More...

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

## Classes

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

## Exported constants

enum  { dimension =dim }
A constant that exports the template parameter dim. More...

enum  { dimensionworld =dimworld }
A constant that exports the template parameter dimworld. More...

## Exported types

typedef GridFamily::Traits::LeafGridView LeafGridView
type of view for leaf grid

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

typedef GridFamily::Traits::CollectiveCommunication CollectiveCommunication
A type that is a model of Dune::CollectiveCommunication. It provides a portable way for collective communication on the set of processes used by the grid.

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

## Size methods

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

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

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

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

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

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.

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

const GlobalIdSetglobalIdSet () const
return const reference to the grids global id set

const LocalIdSetlocalIdSet () const
return const reference to the grids local id set

const LevelIndexSetlevelIndexSet (int level) const
return const reference to the grids level index set for level level

const LeafIndexSetleafIndexSet () const
return const reference to the grids leaf index set

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

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

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

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 CollectiveCommunicationcomm () const
return const reference to a collective communication object. The return type is a model of Dune::CollectiveCommunication.

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

template<class DataHandle >
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.

GridImp & asImp ()
Barton-Nackman trick.

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

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

## ◆ anonymous enum

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

A constant that exports the template parameter dim.

Enumerator
dimension

The dimension of the grid.

## ◆ anonymous enum

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

A constant that exports the template parameter dimworld.

Enumerator
dimensionworld

The dimension of the world the grid lives in.

## Member Function Documentation

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
- if preAdapt() returned true: possibly save current solution
- if adapt() returned true: possibly interpolate the (saved) solution


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

## ◆ 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.

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.

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.

## ◆ 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.

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

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.

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.

The documentation for this class was generated from the following file:
|  Legal Statements / Impressum  |  generated with Hugo v0.80.0 (Dec 6, 23:32, 2022)