#include <Entity.hpp>
|
| | Entity () |
| | Constructor creating empty entity. More...
|
| |
| | Entity (const CpGridData &grid, EntityRep< codim > entityrep) |
| | Constructor taking a grid and an entity representation. More...
|
| |
| | Entity (const CpGridData &grid, int index_arg, bool orientation_arg) |
| | Constructor taking a grid, entity index, and orientation. More...
|
| |
| | Entity (int index_arg, bool orientation_arg) |
| | Constructor taking a entity index, and orientation. More...
|
| |
| bool | operator== (const Entity &other) const |
| | Equality. More...
|
| |
| bool | operator!= (const Entity &other) const |
| | Inequality. More...
|
| |
| EntitySeed | seed () const |
| | Return an entity seed (light-weight entity). EntitySeed objects are used to obtain an Entity back when combined with the corresponding grid. For CpGrid, EntitySeed and EntityPtr are the same class. More...
|
| |
| const Geometry & | geometry () const |
| | Return the geometry of the entity (does not depend on its orientation). More...
|
| |
| int | level () const |
| | Return the level of the entity in the grid hierarchy. Level = 0 represents the coarsest grid. More...
|
| |
| bool | isLeaf () const |
| | Check if the entity is in the leafview. More...
|
| |
| bool | isRegular () const |
| | Refinement is not defined for CpGrid. More...
|
| |
| PartitionType | partitionType () const |
| | In serial run, the only partitionType() is InteriorEntity. Only needed when distributed_data_ is not empty. In parallel run, the entity each cell inherits the partition type of its origin (either parent cell or equivalent cell in level 0). Only needed when distributed_data_ is not empty. More...
|
| |
| GeometryType | type () const |
| | Return marker object (GeometryType object) representing the reference element of the entity. Currently, cube type for all entities (cells and vertices). More...
|
| |
| unsigned int | subEntities (const unsigned int cc) const |
| | Return the number of all subentities of the entity of a given codimension cc. More...
|
| |
| template<int cc> |
| Codim< cc >::Entity | subEntity (int i) const |
| | Obtain subentity. Example: If cc = 3 and i = 5, it returns the 5th corner/vertex of the entity. More...
|
| |
| LevelIntersectionIterator | ilevelbegin () const |
| | Start level-iterator for the cell-cell intersections of this entity. More...
|
| |
| LevelIntersectionIterator | ilevelend () const |
| | End level-iterator for the cell-cell intersections of this entity. More...
|
| |
| LeafIntersectionIterator | ileafbegin () const |
| | Start leaf-iterator for the cell-cell intersections of this entity. More...
|
| |
| LeafIntersectionIterator | ileafend () const |
| | End leaf-iterator for the cell-cell intersections of this entity. More...
|
| |
| HierarchicIterator | hbegin (int) const |
| | Iterator begin over the children. [If requested, also over descendants more than one generation away.]. More...
|
| |
| HierarchicIterator | hend (int) const |
| | Iterator end over the children/beyond last child iterator. More...
|
| |
| bool | isNew () const |
| | Returns true, if the entity has been created during the last call to adapt(). Dummy. More...
|
| |
| bool | mightVanish () const |
| | Returns true, if entity might disappear during the next call to adapt(). More...
|
| |
| bool | hasFather () const |
| | ONLY FOR CELLS (Entity<0>) Check if the entity comes from an LGR, i.e., it has been created via refinement from coarser level. More...
|
| |
| Entity< 0 > | father () const |
| | ONLY FOR CELLS (Entity<0>). Get the father Entity (in the level-grid the father cell was born), in case entity.hasFather() is true. More...
|
| |
| Dune::cpgrid::Geometry< 3, 3 > | geometryInFather () const |
| | Return LocalGeometry representing the embedding of the entity into its father (when hasFather() is true). Map from the entity's reference element into the reference element of its father. Currently, LGR is built via refinement of a block-shaped patch from the coarse grid. So the LocalGeometry of an entity coming from the LGR is one of the refined cells of the unit cube, with suitable amount of cells in each direction. More...
|
| |
| bool | hasBoundaryIntersections () const |
| |
| const Entity & | impl () const |
| | Access the actual implementation class behind Entity interface class. More...
|
| |
| Entity & | impl () |
| |
| bool | isValid () const |
| |
| Entity< 0 > | getOrigin () const |
| | Returns (1) parent entity in the level-grid the parent cell was born, if the entity was born in any LGR. (2) if the entity has no father, and is a leaf-grid-view entity, it returns the equivalent element on the level that it was born. Namely, for coarse cells on the leaf never involved in any refinement process, we get the equivalent entity in the GLOBAL grid (level 0). Notice that if it's a refined cell on the leaf, it does have a father, in that case, this method returns the father entity. (3) Otherwise, returns itself. Notice that if the element is a refined one, this method returns the father() entity. For a coarse cell never involved in any refinement, if it's also a leaf-grid-cell, it returns the equivalent cell from level 0. Otherwise, it returns itself, which means that its grid is level 0 and the entity itself is already its "origin". More...
|
| |
| Entity< 0 > | getLevelElem () const |
| | Get equivalent element on the level grid where the entity was born, if grid = leaf-grid-view. Otherwise, return itself. More...
|
| |
| int | getLevelCartesianIdx () const |
| | Get Cartesian Index in the level grid view where the Entity was born. More...
|
| |
| int | getIdxInParentCell () const |
| |
| template<int cc> |
| Entity< codim >::template Codim< cc >::Entity | subEntity (int i) const |
| |
| void | setValue (int index_arg, bool orientation_arg) |
| | Set entity value. More...
|
| |
| int | index () const |
| | The (positive) index of an entity. Not a Dune interface method. More...
|
| |
| int | signedIndex () const |
| | The signed index that also tells us the orientation. More...
|
| |
| bool | orientation () const |
| | Returns true if the entity has positive orientation. Not a Dune interface method. More...
|
| |
| EntityRep | opposite () const |
| | Returns an EntityRep with opposite orientation. More...
|
| |
| void | increment () |
| | Increments the entityrep's index() by one. More...
|
| |
| bool | operator< (const EntityRep &other) const |
| | Ordering relation used for maps etc. More...
|
| |
| bool | operator== (const EntityRep &other) const |
| | Equality operator. More...
|
| |
| bool | operator!= (const EntityRep &other) const |
| | Inequality operator. More...
|
| |
template<int codim>
class Dune::cpgrid::Entity< codim > - Template Parameters
-
◆ ctype
◆ EntitySeed
◆ Geometry
◆ HierarchicIterator
◆ LeafIntersectionIterator
◆ LevelIntersectionIterator
◆ LocalGeometry
◆ anonymous enum
◆ anonymous enum
◆ Entity() [1/4]
Constructor creating empty entity.
Constructor taking a grid and an integer entity representation. This constructor should probably be removed, since it exposes details of the implementation of - See also
- EntityRep, see comment in EntityRep<>::EntityRep(int).
◆ Entity() [2/4]
Constructor taking a grid and an entity representation.
◆ Entity() [3/4]
Constructor taking a grid, entity index, and orientation.
◆ Entity() [4/4]
Constructor taking a entity index, and orientation.
◆ father()
ONLY FOR CELLS (Entity<0>). Get the father Entity (in the level-grid the father cell was born), in case entity.hasFather() is true.
- Returns
- father-entity
◆ geometry()
Return the geometry of the entity (does not depend on its orientation).
◆ geometryInFather()
Return LocalGeometry representing the embedding of the entity into its father (when hasFather() is true). Map from the entity's reference element into the reference element of its father. Currently, LGR is built via refinement of a block-shaped patch from the coarse grid. So the LocalGeometry of an entity coming from the LGR is one of the refined cells of the unit cube, with suitable amount of cells in each direction.
◆ getIdxInParentCell()
◆ getLevelCartesianIdx()
Get Cartesian Index in the level grid view where the Entity was born.
◆ getLevelElem()
Get equivalent element on the level grid where the entity was born, if grid = leaf-grid-view. Otherwise, return itself.
◆ getOrigin()
Returns (1) parent entity in the level-grid the parent cell was born, if the entity was born in any LGR. (2) if the entity has no father, and is a leaf-grid-view entity, it returns the equivalent element on the level that it was born. Namely, for coarse cells on the leaf never involved in any refinement process, we get the equivalent entity in the GLOBAL grid (level 0). Notice that if it's a refined cell on the leaf, it does have a father, in that case, this method returns the father entity. (3) Otherwise, returns itself. Notice that if the element is a refined one, this method returns the father() entity. For a coarse cell never involved in any refinement, if it's also a leaf-grid-cell, it returns the equivalent cell from level 0. Otherwise, it returns itself, which means that its grid is level 0 and the entity itself is already its "origin".
◆ hasBoundaryIntersections()
Returns true if any of my intersections are on the boundary. Implementation note: This is a slow, computed, function. Could be speeded up by putting boundary info in the CpGrid class.
◆ hasFather()
ONLY FOR CELLS (Entity<0>) Check if the entity comes from an LGR, i.e., it has been created via refinement from coarser level.
@TODO: When distributed_data_ is not empty, check whether the father element exists on the local process, which can be used to test whether it is safe to call father.
◆ hbegin()
Iterator begin over the children. [If requested, also over descendants more than one generation away.].
◆ hend()
Iterator end over the children/beyond last child iterator.
Dummy beyond last child iterator.
◆ ileafbegin()
Start leaf-iterator for the cell-cell intersections of this entity.
◆ ileafend()
End leaf-iterator for the cell-cell intersections of this entity.
◆ ilevelbegin()
Start level-iterator for the cell-cell intersections of this entity.
◆ ilevelend()
End level-iterator for the cell-cell intersections of this entity.
◆ impl() [1/2]
◆ impl() [2/2]
◆ increment()
◆ index()
The (positive) index of an entity. Not a Dune interface method.
- Returns
- the (positive) index of an entity.
Referenced by Dune::cpgrid::PointViaCellHandleWrapper< Handle >::gather(), Dune::cpgrid::Intersection::id(), Dune::cpgrid::LevelGlobalIdSet::id(), Dune::cpgrid::IndexSet::index(), Dune::cpgrid::Entity< codim >::isValid(), Dune::cpgrid::Iterator< cd, pitype >::Iterator(), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::makeInverseRelation(), Dune::cpgrid::Iterator< cd, pitype >::operator++(), Dune::cpgrid::EntityRep< codim >::operator<(), Dune::cpgrid::EntityVariable< T, codim >::operator[](), Dune::cpgrid::SignedEntityVariable< T, codim >::operator[](), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::operator[](), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::printRelationMatrix(), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::row(), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::rowSize(), Dune::cpgrid::PointViaCellHandleWrapper< Handle >::scatter(), and Dune::cpgrid::PointViaCellHandleWrapper< Handle >::size().
◆ isLeaf()
Check if the entity is in the leafview.
@TODO: Modify the definition to cover serial and parallel cases.
Serial: an element is a leaf <-> hbegin and hend return the same iterator
Parallel: true <-> the element is a leaf entity of the global refinement hierarchy.
◆ isNew()
Returns true, if the entity has been created during the last call to adapt(). Dummy.
◆ isRegular()
Refinement is not defined for CpGrid.
◆ isValid()
◆ level()
Return the level of the entity in the grid hierarchy. Level = 0 represents the coarsest grid.
◆ mightVanish()
Returns true, if entity might disappear during the next call to adapt().
Currently, returns true if the element has been marked to be refined. Therefore, it "vanishes"
in the sense that it gets replaced by its children.
To be modified: When supporting coarsening, mightVanish should return true for all the "siblings"
refined cells of one refined cell that got marked to be coarsened.
◆ operator!=() [1/2]
◆ operator!=() [2/2]
◆ operator<()
◆ operator==() [1/2]
◆ operator==() [2/2]
◆ opposite()
◆ orientation()
◆ partitionType()
◆ seed()
Return an entity seed (light-weight entity). EntitySeed objects are used to obtain an Entity back when combined with the corresponding grid. For CpGrid, EntitySeed and EntityPtr are the same class.
References Dune::cpgrid::Entity< codim >::impl().
◆ setValue()
Set entity value.
- Parameters
-
| index | Entity index |
| orientation | True if the entity's orientation is positive. |
◆ signedIndex()
The signed index that also tells us the orientation.
◆ subEntities()
Return the number of all subentities of the entity of a given codimension cc.
◆ subEntity() [1/2]
template<int codim>
template<int cc>
Obtain subentity. Example: If cc = 3 and i = 5, it returns the 5th corner/vertex of the entity.
◆ subEntity() [2/2]
template<int codim>
template<int cc>
◆ type()
Return marker object (GeometryType object) representing the reference element of the entity. Currently, cube type for all entities (cells and vertices).
◆ CpGridData
◆ GlobalIdSet
◆ HierarchicIterator
◆ LevelGlobalIdSet
◆ codimension
◆ dimension
◆ dimensionworld
◆ mydimension
◆ pgrid_
The documentation for this class was generated from the following files:
|
