dune-grid  2.4.1
Classes | Public Member Functions | Protected Member Functions | List of all members
Dune::Grid< dim, dimworld, ct, GridFamily > Class Template Reference

Grid abstract base classThis 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. More...

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

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

Classes

struct  Codim
 A Traits struct that collects all associated types of one implementation. More...
 
struct  Partition
 Types for GridView. More...
 

Public Member Functions

size_t numBoundarySegments () const
 returns the number of boundary segments within the macro grid 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 >
::EntityPointer 
entityPointer (const EntitySeed &seed) const
 obtain EntityPointer from EntitySeed. More...
 
template<class EntitySeed >
Codim< EntitySeed::codimension >
::Entity 
entity (const EntitySeed &seed) const
 obtain Entity from EntitySeed. More...
 

Protected Member Functions

GridImp & asImp ()
 Barton-Nackman trick. More...
 
const GridImp & asImp () const
 Barton-Nackman trick. 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 Partition
< All_Partition >
::LevelGridView 
LevelGridView
 View types for All_Partition. More...
 
typedef Partition
< All_Partition >
::LeafGridView 
LeafGridView
 
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...
 
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. More...
 
typedef ct ctype
 Define type used for coordinates in grid module. 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...
 

Views

template<PartitionIteratorType pitype>
Partition< pitype >::LevelGridView levelGridView (int level) const
 View for a grid level. More...
 
template<PartitionIteratorType pitype>
Partition< pitype >::LeafGridView leafGridView () const
 View for the leaf grid. More...
 
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...
 

Iterators

template<int cd, PartitionIteratorType pitype>
Codim< cd >::template
Partition< pitype >
::LevelIterator 
lbegin (int level) const
 Iterator to first entity of given codim on level. More...
 
template<int cd, PartitionIteratorType pitype>
Codim< cd >::template
Partition< pitype >
::LevelIterator 
lend (int level) const
 one past the end on this level More...
 
template<int cd>
Codim< cd >::template
Partition< All_Partition >
::LevelIterator 
lbegin (int level) const
 Iterator to first entity of given codim on level for PartitionType All_Partition. More...
 
template<int cd>
Codim< cd >::template
Partition< All_Partition >
::LevelIterator 
lend (int level) const
 one past the end on this level for PartitionType All_Partition More...
 
template<int cd, PartitionIteratorType pitype>
Codim< cd >::template
Partition< pitype >
::LeafIterator 
leafbegin () const
 Iterator to first entity of given codim on leaf grid. More...
 
template<int cd, PartitionIteratorType pitype>
Codim< cd >::template
Partition< pitype >
::LeafIterator 
leafend () const
 one past the end on the leaf level grid More...
 
template<int cd>
Codim< cd >::template
Partition< All_Partition >
::LeafIterator 
leafbegin () const
 Iterator to first entity of given codim on leaf grid for PartitionType All_Partition. More...
 
template<int cd>
Codim< cd >::template
Partition< All_Partition >
::LeafIterator 
leafend () const
 one past the end on the leaf grid for PartitionType All_Partition More...
 

Access to index and id sets

const GlobalIdSetglobalIdSet () const
 return const reference to the grids global id set More...
 
const LocalIdSetlocalIdSet () const
 return const reference to the grids local id set More...
 
const LevelIndexSetlevelIndexSet (int level) const
 return const reference to the grids level index set for level level More...
 
const LeafIndexSetleafIndexSet () 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

int overlapSize (int level, int codim) const
 Return size of overlap for a given codim on a given level. More...
 
int overlapSize (int codim) const
 Return size of overlap region for a given codim on the leaf grid. More...
 
int ghostSize (int level, int codim) const
 Return size of ghost region for a given codim on a given level. More...
 
int ghostSize (int codim) const
 Return size of ghost region for a given codim on the leaf grid. More...
 
template<class DataHandleImp , class DataTypeImp >
void communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir, int level) const
 Communicate information on distributed entities on a given level Template parameter is a model of Dune::CommDataHandleIF. More...
 
template<class DataHandleImp , class DataTypeImp >
void communicate (CommDataHandleIF< DataHandleImp, DataTypeImp > &data, InterfaceType iftype, CommunicationDirection dir) const
 Communicate information on distributed entities on the leaf grid Template parameter is a model of Dune::CommDataHandleIF. More...
 
const CollectiveCommunicationcomm () const
 return const reference to a collective communication object. The return type is a model of Dune::CollectiveCommunication. 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
dimspecifies the dimension of the grid.
dimworldspecifies the dimension of the surrounding space, this can be different from dim, if the grid is defined on a manifold .
ctfield type of the world vector space.
GridFamilytraits class providing all types associated with the grid implementation.

Member Typedef Documentation

template<int dim, int dimworld, class ct , class GridFamily >
typedef GridFamily::Traits::CollectiveCommunication Dune::Grid< dim, dimworld, ct, GridFamily >::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.

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.

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.

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.

template<int dim, int dimworld, class ct , class GridFamily >
typedef Partition< All_Partition >:: LeafGridView Dune::Grid< dim, dimworld, ct, GridFamily >::LeafGridView
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.

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.

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.

template<int dim, int dimworld, class ct , class GridFamily >
typedef Partition< All_Partition >:: LevelGridView Dune::Grid< dim, dimworld, ct, GridFamily >::LevelGridView

View types for All_Partition.

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.

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.

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.

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

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.

Returns
true if a least one entity was refined

The complete adaptation process works as follows:

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
GridImp& Dune::Grid< dim, dimworld, ct, GridFamily >::asImp ( )
inlineprotected

Barton-Nackman trick.

Referenced by Dune::Grid< dim, dimworld, ct, GridFamily >::adapt(), Dune::Grid< dim, dimworld, ct, GridFamily >::comm(), Dune::Grid< dim, dimworld, ct, GridFamily >::communicate(), Dune::Grid< dim, dimworld, ct, GridFamily >::entity(), Dune::Grid< dim, dimworld, ct, GridFamily >::entityPointer(), Dune::Grid< dim, dimworld, ct, GridFamily >::getMark(), Dune::Grid< dim, dimworld, ct, GridFamily >::ghostSize(), Dune::Grid< dim, dimworld, ct, GridFamily >::globalIdSet(), Dune::Grid< dim, dimworld, ct, GridFamily >::globalRefine(), Dune::Grid< dim, dimworld, ct, GridFamily >::lbegin(), Dune::GridDefaultImplementation< dim, dimworld, _ctype, SGridFamily< dim, dimworld, _ctype > >::lbegin(), Dune::Grid< dim, dimworld, ct, GridFamily >::leafbegin(), Dune::GridDefaultImplementation< dim, dimworld, _ctype, SGridFamily< dim, dimworld, _ctype > >::leafbegin(), Dune::Grid< dim, dimworld, ct, GridFamily >::leafend(), Dune::GridDefaultImplementation< dim, dimworld, _ctype, SGridFamily< dim, dimworld, _ctype > >::leafend(), Dune::Grid< dim, dimworld, ct, GridFamily >::leafGridView(), Dune::GridDefaultImplementation< dim, dimworld, _ctype, SGridFamily< dim, dimworld, _ctype > >::leafGridView(), Dune::Grid< dim, dimworld, ct, GridFamily >::leafIndexSet(), Dune::Grid< dim, dimworld, ct, GridFamily >::lend(), Dune::GridDefaultImplementation< dim, dimworld, _ctype, SGridFamily< dim, dimworld, _ctype > >::lend(), Dune::Grid< dim, dimworld, ct, GridFamily >::levelGridView(), Dune::GridDefaultImplementation< dim, dimworld, _ctype, SGridFamily< dim, dimworld, _ctype > >::levelGridView(), Dune::Grid< dim, dimworld, ct, GridFamily >::levelIndexSet(), Dune::Grid< dim, dimworld, ct, GridFamily >::loadBalance(), Dune::Grid< dim, dimworld, ct, GridFamily >::localIdSet(), Dune::Grid< dim, dimworld, ct, GridFamily >::mark(), Dune::Grid< dim, dimworld, ct, GridFamily >::maxLevel(), Dune::Grid< dim, dimworld, ct, GridFamily >::numBoundarySegments(), Dune::Grid< dim, dimworld, ct, GridFamily >::overlapSize(), Dune::Grid< dim, dimworld, ct, GridFamily >::postAdapt(), Dune::Grid< dim, dimworld, ct, GridFamily >::preAdapt(), and Dune::Grid< dim, dimworld, ct, GridFamily >::size().

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

Barton-Nackman trick.

template<int dim, int dimworld, class ct , class GridFamily >
const CollectiveCommunication& Dune::Grid< dim, dimworld, ct, GridFamily >::comm ( ) const
inline

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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<class DataHandleImp , class DataTypeImp >
void Dune::Grid< dim, dimworld, ct, GridFamily >::communicate ( CommDataHandleIF< DataHandleImp, DataTypeImp > &  data,
InterfaceType  iftype,
CommunicationDirection  dir,
int  level 
) const
inline

Communicate information on distributed entities on a given level Template parameter is a model of Dune::CommDataHandleIF.

Parameters
dataA data handle telling the method what data is communicated and how this should be done.
interfaceThe communication interface to use.
dirThe direction of the communication along the interface (forward or backward.
levelThe index of the grid level where the communication should happen.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<class DataHandleImp , class DataTypeImp >
void Dune::Grid< dim, dimworld, ct, GridFamily >::communicate ( CommDataHandleIF< DataHandleImp, DataTypeImp > &  data,
InterfaceType  iftype,
CommunicationDirection  dir 
) const
inline

Communicate information on distributed entities on the leaf grid Template parameter is a model of Dune::CommDataHandleIF.

Parameters
dataA data handle telling the method what data is communicated and how this should be done.
interfaceThe communication interface to use.
dirThe direction of the communication along the interface (forward or backward).

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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
template<int dim, int dimworld, class ct , class GridFamily >
template<class EntitySeed >
Codim< EntitySeed :: codimension >:: EntityPointer Dune::Grid< dim, dimworld, ct, GridFamily >::entityPointer ( const EntitySeed seed) const
inline

obtain EntityPointer from EntitySeed.

Deprecated:
This method is deprecated and will be removed after the release of dune-grid 2.4. Please use entity() instead, which will directly return an Entity object that you can then store for later use. The EntityPointer concept in general is deprecated and will not be available after dune-grid 2.4 has been released.
Deprecated:
"entityPointer() is deprecated and will be removed after the release of dune-grid 2.4. Use entity() instead to directly obtain an Entity object."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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]eEntity for which adaptation mark should be determined
Returns
int adaptation mark currently set for given Entity e

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
int Dune::Grid< dim, dimworld, ct, GridFamily >::ghostSize ( int  level,
int  codim 
) const
inline

Return size of ghost region for a given codim on a given level.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by Dune::Grid< dim, dimworld, ct, GridFamily >::ghostSize().

template<int dim, int dimworld, class ct , class GridFamily >
int Dune::Grid< dim, dimworld, ct, GridFamily >::ghostSize ( int  codim) const
inline

Return size of ghost region for a given codim on the leaf grid.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp(), and Dune::Grid< dim, dimworld, ct, GridFamily >::ghostSize().

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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by main().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd, PartitionIteratorType pitype>
Codim<cd>::template Partition<pitype>::LevelIterator Dune::Grid< dim, dimworld, ct, GridFamily >::lbegin ( int  level) const
inline

Iterator to first entity of given codim on level.

Deprecated:
"The method lbegin( level ) is superseded by levelGridView( level ).begin and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd>
Codim<cd>::template Partition<All_Partition>::LevelIterator Dune::Grid< dim, dimworld, ct, GridFamily >::lbegin ( int  level) const
inline

Iterator to first entity of given codim on level for PartitionType All_Partition.

Deprecated:
"The method lbegin( level ) is superseded by levelGridView( level ).begin and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd, PartitionIteratorType pitype>
Codim<cd>::template Partition<pitype>::LeafIterator Dune::Grid< dim, dimworld, ct, GridFamily >::leafbegin ( ) const
inline

Iterator to first entity of given codim on leaf grid.

Deprecated:
"The method leafbegin() is superseded by leafGridView().begin and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd>
Codim<cd>::template Partition<All_Partition>::LeafIterator Dune::Grid< dim, dimworld, ct, GridFamily >::leafbegin ( ) const
inline

Iterator to first entity of given codim on leaf grid for PartitionType All_Partition.

Deprecated:
"The method leafbegin() is superseded by leafGridView().begin and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd, PartitionIteratorType pitype>
Codim<cd>::template Partition<pitype>::LeafIterator Dune::Grid< dim, dimworld, ct, GridFamily >::leafend ( ) const
inline

one past the end on the leaf level grid

Deprecated:
"The method leafend() is superseded by leafGridView().end and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd>
Codim<cd>::template Partition<All_Partition>::LeafIterator Dune::Grid< dim, dimworld, ct, GridFamily >::leafend ( ) const
inline

one past the end on the leaf grid for PartitionType All_Partition

Deprecated:
"The method leafend() is superseded by leafGridView().end and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<PartitionIteratorType pitype>
Partition<pitype>::LeafGridView Dune::Grid< dim, dimworld, ct, GridFamily >::leafGridView ( ) const
inline

View for the leaf grid.

Deprecated:
"After DUNE 2.4, grid views will always model the All_Partition. The template method leafGridView< pitype > will be removed without replacement. Use leafGridView() instead."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by Dune::Grid< dim, dimworld, ct, GridFamily >::leafGridView(), and main().

template<int dim, int dimworld, class ct , class GridFamily >
LeafGridView Dune::Grid< dim, dimworld, ct, GridFamily >::leafGridView ( ) const
inline
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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd, PartitionIteratorType pitype>
Codim<cd>::template Partition<pitype>::LevelIterator Dune::Grid< dim, dimworld, ct, GridFamily >::lend ( int  level) const
inline

one past the end on this level

Deprecated:
"The method lend( level ) is superseded by levelGridView( level ).end and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<int cd>
Codim<cd>::template Partition<All_Partition>::LevelIterator Dune::Grid< dim, dimworld, ct, GridFamily >::lend ( int  level) const
inline

one past the end on this level for PartitionType All_Partition

Deprecated:
"The method lend( level ) is superseded by levelGridView( level ).end and will be removed after Dune 2.4."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
template<PartitionIteratorType pitype>
Partition<pitype>::LevelGridView Dune::Grid< dim, dimworld, ct, GridFamily >::levelGridView ( int  level) const
inline

View for a grid level.

Deprecated:
"After DUNE 2.4, grid views will always model the All_Partition. The template method levelGridView< pitype > will be removed without replacement. Use levelGridView() instead."

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by Dune::Grid< dim, dimworld, ct, GridFamily >::levelGridView().

template<int dim, int dimworld, class ct , class GridFamily >
LevelGridView Dune::Grid< dim, dimworld, ct, GridFamily >::levelGridView ( int  level) const
inline
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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by Dune::Grid< dim, dimworld, ct, GridFamily >::loadBalance().

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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp(), and Dune::Grid< dim, dimworld, ct, GridFamily >::loadBalance().

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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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]refCountNumber of subdivisions that should be applied. Negative value means coarsening.
[in]eEntity that should be marked
Returns
true if Entity was marked, false otherwise.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by Dune::ALUGridLoadBalanceDataHandle< Grid, DataHandleImpl, Data >::inlineData(), and Dune::ALUGridLoadBalanceDataHandle< Grid, DataHandleImpl, Data >::xtractData().

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

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
int Dune::Grid< dim, dimworld, ct, GridFamily >::overlapSize ( int  level,
int  codim 
) const
inline

Return size of overlap for a given codim on a given level.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

Referenced by Dune::Grid< dim, dimworld, ct, GridFamily >::overlapSize().

template<int dim, int dimworld, class ct , class GridFamily >
int Dune::Grid< dim, dimworld, ct, GridFamily >::overlapSize ( int  codim) const
inline

Return size of overlap region for a given codim on the leaf grid.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp(), and Dune::Grid< dim, dimworld, ct, GridFamily >::overlapSize().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp().

template<int dim, int dimworld, class ct , class GridFamily >
int Dune::Grid< dim, dimworld, ct, GridFamily >::size ( int  level,
int  codim 
) const
inline
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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp(), and Dune::Grid< dim, dimworld, ct, GridFamily >::size().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp(), and Dune::Grid< dim, dimworld, ct, GridFamily >::size().

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.

References Dune::Grid< dim, dimworld, ct, GridFamily >::asImp(), and Dune::Grid< dim, dimworld, ct, GridFamily >::size().


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