Template specialization of Dune::Entity for Elements (codim==0)
More...
#include <dune/grid/common/entity.hh>
|
template<int codim> |
int | count () const |
| Number of subentities with codimension cc . More...
|
|
unsigned int | subEntities (unsigned int codim) const |
| Number of subentities with codimension codim . More...
|
|
template<int codim> |
Codim< codim >::Entity | subEntity (int i) const |
| Obtain a pointer to a subentity. More...
|
|
Entity | 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. More...
|
|
bool | isLeaf () const |
| Returns true if the entity is contained in the leaf grid. More...
|
|
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. More...
|
|
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() More...
|
|
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. More...
|
|
bool | hasBoundaryIntersections () const |
| Returns true, if entity has intersections with boundary. More...
|
|
|
| Entity (const EntityImp< 0, dim, GridImp > &e) |
| Copy constructor from EntityImp. More...
|
|
| Entity (EntityImp< 0, dim, GridImp > &&e) |
| Move constructor from EntityImp. More...
|
|
|
Iterator range for hierarchic access to the more-refined entities that result from the subdivision of a given element.
|
template<typename Entity > |
IteratorRange<...> | descendantElements (const Entity &e, int maxLevel) |
| Iterates over all descendant elements of the given element up to a maximum level. More...
|
|
template<int dim, class GridImp, template< int, int, class > class EntityImp>
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>
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Copy constructor from an existing entity.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Move constructor from an existing entity.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Dune::Entity< 0, dim, GridImp, EntityImp >::Entity |
( |
const EntityImp< 0, dim, GridImp > & |
e | ) |
|
|
inline |
Copy constructor from EntityImp.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Move constructor from EntityImp.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int codim>
int Dune::Entity< 0, dim, GridImp, EntityImp >::count |
( |
| ) |
const |
|
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.
- Deprecated:
- This method will be removed after the release of dune-grid-2.4. Please use the method subEntities instead.
- Deprecated:
- "Use subEntities(unsigned int) instead!"
template<int dim, class GridImp , template< int, int, class > class EntityImp>
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.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
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).
template<int dim, class GridImp , template< int, int, class > class EntityImp>
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).
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::hasBoundaryIntersections |
( |
| ) |
const |
|
inline |
Returns true, if entity has intersections with boundary.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::hasFather |
( |
| ) |
const |
|
inline |
Return true if entity has a father entity which can be accessed using the father() method.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
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.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
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.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::isLeaf |
( |
| ) |
const |
|
inline |
Returns true if the entity is contained in the leaf grid.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::isNew |
( |
| ) |
const |
|
inline |
Returns true, if the entity has been created during the last call to adapt()
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::isRegular |
( |
| ) |
const |
|
inline |
Returns true if element is of regular type in red/green type refinement. In bisection or hanging node refinement this is always true.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
int Dune::Entity< 0, dim, GridImp, EntityImp >::level |
( |
| ) |
const |
|
inline |
The level of this entity.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::mightVanish |
( |
| ) |
const |
|
inline |
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.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::operator!= |
( |
const Entity< 0, dim, GridImp, EntityImp > & |
other | ) |
const |
|
inline |
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<typename ItImp >
Compares an Entity with an EntityPointer for equality.
- Deprecated:
- This method only exists for backwards compatibility during the 2.4 release cycle and will be removed after dune-grid-2.4 is released.
- Deprecated:
- "EntityPointer is deprecated and will be removed after the release of dune-grid-2.4. Instead, you can copy and store entities directly now."
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Dereference Entity to itself for backwards compatibility with EntityPointer.
- Deprecated:
- This method only exists to provide backwards compatibility for dune-grid-2.4. It will be removed after the release of dune-grid-2.4.
- Deprecated:
- "This is now an Entity instead of an EntityPointer. You do not have to dereference it anymore!"
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Dereference Entity to itself for backwards compatibility with EntityPointer.
- Deprecated:
- This method only exists to provide backwards compatibility for dune-grid-2.4. It will be removed after the release of dune-grid-2.4.
- Deprecated:
- "This is now an Entity instead of an EntityPointer. You do not have to dereference it anymore!"
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Move assignment operator from an existing entity.
References move.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
bool Dune::Entity< 0, dim, GridImp, EntityImp >::operator== |
( |
const Entity< 0, dim, GridImp, EntityImp > & |
other | ) |
const |
|
inline |
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<typename ItImp >
Compares an Entity with an EntityPointer for equality.
- Deprecated:
- This method only exists for backwards compatibility during the 2.4 release cycle and will be removed after dune-grid-2.4 is released.
- Deprecated:
- "EntityPointer is deprecated and will be removed after the release of dune-grid-2.4. Instead, you can copy and store entities directly now."
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Partition type of this entity.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
Return the entity seed which contains sufficient information to generate the entity again and uses as little memory as possible.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
unsigned int Dune::Entity< 0, dim, GridImp, EntityImp >::subEntities |
( |
unsigned int |
codim | ) |
const |
|
inline |
Number of subentities with codimension codim
.
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.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
template<int codim>
Codim< codim >::Entity Dune::Entity< 0, dim, GridImp, EntityImp >::subEntity |
( |
int |
i | ) |
const |
|
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, ..., subEntities( codim )-1
template<int dim, class GridImp , template< int, int, class > class EntityImp>
GeometryType Dune::Entity< 0, dim, GridImp, EntityImp >::type |
( |
| ) |
const |
|
inline |
Return the name of the reference element. The type can be used to access the Dune::ReferenceElement.
template<int dim, class GridImp , template< int, int, class > class EntityImp>
The documentation for this class was generated from the following file: