Dune Core Modules (2.3.1)
Template specialization of Dune::Entity for Elements (codim==0) More...
#include <dune/grid/common/entity.hh>
Classes | |
struct | Codim |
EntityPointer types of the different codimensions. More... | |
Protected Member Functions | |
Implementation & | impl () |
Return reference to the real implementation. | |
const Implementation & | impl () const |
Return const reference to the real implementation. | |
Exported types and constants | |
enum | { codimension =0 } |
enum | { dimension =dim } |
enum | { mydimension =dim } |
typedef GridImp::template Codim< 0 >::Geometry | Geometry |
The geometry type of this entity. | |
typedef GridImp::template Codim< 0 >::EntitySeed | EntitySeed |
The corresponding entity seed (for storage of entities) | |
typedef GridImp::template Codim< 0 >::LocalGeometry | LocalGeometry |
The geometry type of this entity when the geometry is expressed embedded in the father element. More... | |
typedef GridImp::template Codim< 0 >::EntityPointer | EntityPointer |
The codim==0 EntityPointer type. | |
typedef GridImp::LeafIntersectionIterator | LeafIntersectionIterator |
The Dune::IntersectionIterator type for the LeafGridView. More... | |
typedef GridImp::LevelIntersectionIterator | LevelIntersectionIterator |
The Dune::IntersectionIterator type for the LevelGridView. More... | |
typedef GridImp::HierarchicIterator | HierarchicIterator |
The HierarchicIterator type. | |
typedef GridImp::ctype ctype | DUNE_DEPRECATED_MSG("Use Geometry::ctype instead!") |
Type used for coordinates. | |
static const int | DUNE_DEPRECATED_MSG ("Use Geometry::coorddimension instead!") dimensionworld |
Know the world dimension. | |
Exported types and constants | |
enum | { codimension =cd } |
enum | { dimension =dim } |
enum | { mydimension =dim-cd } |
Interface for the implementor | |
Entity (const Entity &rhs) | |
Entity & | operator= (const Entity &rhs) |
bool | hasBoundaryIntersections () const |
Returns true, if entity has intersections with boundary. | |
Entity (const EntityImp< 0, dim, GridImp > &e) | |
Copy constructor from EntityImp. | |
Methods shared by entities of all codimensions | |
int | level () const |
The level of this entity. More... | |
PartitionType | partitionType () const |
Partition type of this entity. More... | |
Geometry | geometry () const |
obtain geometric realization of the entity More... | |
GeometryType | type () const |
Return the name of the reference element. The type can be used to access the Dune::ReferenceElement. | |
EntitySeed | seed () const |
Return the entity seed which contains sufficient information to generate the entity again and uses as little memory as possible. | |
Extended interface of entities of codimension 0 | |
template<int cc> | |
int | count () const |
Number of subentities with codimension cc . More... | |
template<int codim> | |
Codim< codim >::EntityPointer | subEntity (int i) const |
Obtain a pointer to a subentity. More... | |
LeafIntersectionIterator | ileafbegin () const |
Access to intersections with neighboring leaf elements. A neighbor is an entity of codimension 0 which has an intersection of codimension 1 in common with this entity. Access to those neighbors is provided using the IntersectionIterator. This method returns an iterator refering to the first neighbor. More... | |
LeafIntersectionIterator | ileafend () const |
Reference to an IntersectionIterator one past the last intersection. More... | |
LevelIntersectionIterator | ilevelbegin () const |
Intra-level access to intersections with neighboring elements. A neighbor is an entity of codimension 0 which has an intersection of codimension 1 in common with this entity. Access to those neighbors is provided using the IntersectionIterator. This method returns an iterator refering to the first neighbor. More... | |
LevelIntersectionIterator | ilevelend () const |
Reference to an IntersectionIterator one past the last intersection. More... | |
EntityPointer | father () const |
Inter-level access to father entity on the next-coarser grid. The given entity resulted directly from a subdivision of its father entity. For the macro elements dereferencing the EntityPointer is undefined. More... | |
bool | hasFather () const |
Return true if entity has a father entity which can be accessed using the father() method. | |
bool | isLeaf () const |
Returns true if the entity is contained in the leaf grid. | |
bool | isRegular () const |
Returns true if element is of regular type in red/green type refinement. In bisection or hanging node refinement this is always true. | |
LocalGeometry | geometryInFather () const |
Provides information how this element has been subdivided from its father element. More... | |
HierarchicIterator | hbegin (int maxlevel) const |
Inter-level access to elements that resulted from (recursive) subdivision of this element. More... | |
HierarchicIterator | hend (int maxlevel) const |
Returns iterator to one past the last son element. More... | |
bool | isNew () const |
Returns true, if the entity has been created during the last call to adapt() | |
bool | mightVanish () const |
Returns true, if entity might disappear during the next call to adapt(). If the method returns false, the entity is guaranteed to still be present after adaptation. | |
Detailed Description
class Dune::Entity< 0, dim, GridImp, EntityImp >
Template specialization of Dune::Entity for Elements (codim==0)
- Template Parameters
-
dim Dimension of the grid GridImp Type that is a model of Dune::Grid EntityImp Class template that is a model of Dune::Entity
- See also
- Dune::Entity (general version) for the full documentation
<int cd, int dim, class GridImp, template<int,int,class> class EntityImp>
Member Typedef Documentation
◆ LeafIntersectionIterator
typedef GridImp::LeafIntersectionIterator Dune::Entity< 0, dim, GridImp, EntityImp >::LeafIntersectionIterator |
The Dune::IntersectionIterator type for the LeafGridView.
- Deprecated:
- Will be removed in the release after dune-grid-2.3
◆ LevelIntersectionIterator
typedef GridImp::LevelIntersectionIterator Dune::Entity< 0, dim, GridImp, EntityImp >::LevelIntersectionIterator |
The Dune::IntersectionIterator type for the LevelGridView.
- Deprecated:
- Will be removed in the release after dune-grid-2.3
◆ LocalGeometry
typedef GridImp::template Codim<0>::LocalGeometry Dune::Entity< 0, dim, GridImp, EntityImp >::LocalGeometry |
The geometry type of this entity when the geometry is expressed embedded in the father element.
This differs from Geometry in particular when dim != dimworld, but even when dim == dimworld the implementation may choose to use a different type here.
Member Enumeration Documentation
◆ anonymous enum
|
inherited |
◆ anonymous enum
|
inherited |
◆ anonymous enum
|
inherited |
◆ anonymous enum
anonymous enum |
◆ anonymous enum
anonymous enum |
◆ anonymous enum
anonymous enum |
Constructor & Destructor Documentation
◆ Entity()
|
inlineprotected |
hide copy constructor
Member Function Documentation
◆ count()
|
inline |
Number of subentities with codimension cc
.
Strictly speaking this method is redundant, because the same information can be obtained from the corresponding reference element. It is here for efficiency reasons only.
◆ father()
|
inline |
Inter-level access to father entity on the next-coarser grid. The given entity resulted directly from a subdivision of its father entity. For the macro elements dereferencing the EntityPointer is undefined.
- Note
- If the partitionType of the Entity is GhostEntity, it is not guaranteed that this method is working or implemented in general. For some grids it might be available, though.
◆ geometry()
|
inline |
obtain geometric realization of the entity
Each entity provides an object of type Dune::Geometry< dimension-codimension, dimensionworld, ... > that represents the map from a reference element to world coordinates.
- Note
- Previously, the geometry was encapsulated in the entity object and a const reference was returned.
- The returned geometry object is guaranteed to remain valid until the grid is modified (or deleted).
◆ geometryInFather()
|
inline |
Provides information how this element has been subdivided from its father element.
The returned LocalGeometry is a model of Dune::Geometry<dimension,dimension,...>, mapping the reference element of the given entity to the reference element of its father.
This information is sufficient to interpolate all degrees of freedom in the conforming case. Nonconforming may require access to neighbors of the father and calculations with local coordinates. The on-the-fly case is somewhat inefficient since degrees of freedom may be visited several times. If we store interpolation matrices, this is tolerable. We assume that on-the-fly implementation of interpolation is only done for simple discretizations.
- Note
- For ghost entities, this method is not guaranteed to be implemented.
- Previously, the geometry was encapsulated in the entity object and a const reference was returned.
- The returned geometry object is guaranteed to remain valid until the grid is modified (or deleted).
◆ hbegin()
|
inline |
Inter-level access to elements that resulted from (recursive) subdivision of this element.
- Parameters
-
[in] maxlevel Iterator does not stop at elements with level greater than maxlevel.
- Returns
- Iterator to the first son (level is not greater than maxlevel)
- Note
- If the partitionType of the Entity is GhostEntity, it is not guaranteed that this method is working or implemented in general. For some grids it might be available, though.
◆ hend()
|
inline |
Returns iterator to one past the last son element.
- Note
- If the partitionType of the Entity is GhostEntity, it is not guaranteed that this method is working or implemented in general. For some grids it might be available, though.
◆ ileafbegin()
|
inline |
Access to intersections with neighboring leaf elements. A neighbor is an entity of codimension 0 which has an intersection of codimension 1 in common with this entity. Access to those neighbors is provided using the IntersectionIterator. This method returns an iterator refering to the first neighbor.
- Note
- If the partitionType of the Entity is GhostEntity, this method might give you only one neighbor, which is the interior Entity the GhostEntity is connected to.
- Deprecated:
- This method is deprecated and will be removed after Dune 2.3. Use LeafGridView.ibegin(Entity) instead.
◆ ileafend()
|
inline |
Reference to an IntersectionIterator one past the last intersection.
- Note
- If the partitionType of the Entity is GhostEntity, this method might give you only one neighbor, which is the interior Entity the GhostEntity is connected to.
- Deprecated:
- This method is deprecated and will be removed after Dune 2.3. Use LeafGridView.iend(Entity) instead.
◆ ilevelbegin()
|
inline |
Intra-level access to intersections with neighboring elements. A neighbor is an entity of codimension 0 which has an intersection of codimension 1 in common with this entity. Access to those neighbors is provided using the IntersectionIterator. This method returns an iterator refering to the first neighbor.
- Note
- If the partitionType of the Entity is GhostEntity, this method might give you only one neighbor, which is the interior Entity the GhostEntity is connected to.
- Deprecated:
- This method is deprecated and will be removed after Dune 2.3. Use LevelGridView.ibegin(Entity) instead.
◆ ilevelend()
|
inline |
Reference to an IntersectionIterator one past the last intersection.
- Note
- If the partitionType of the Entity is GhostEntity, this method might give you only one neighbor, which is the interior Entity the GhostEntity is connected to.
- Deprecated:
- This method is deprecated and will be removed after Dune 2.3. Use LevelGridView.iend(Entity) instead.
◆ level()
|
inline |
The level of this entity.
◆ operator=()
|
inlineprotected |
hide assignment operator
◆ partitionType()
|
inline |
Partition type of this entity.
◆ subEntity()
|
inline |
Obtain a pointer to a subentity.
- Template Parameters
-
codim codimension of the desired subentity
- Parameters
-
[in] i number of the subentity (in generic numbering)
- Returns
- an EntityPointer to the specified subentity
- Note
- The subentities are numbered 0, ..., count< codim >-1
The documentation for this class was generated from the following file:
- dune/grid/common/entity.hh
![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/80x15.png)