Represents an entity of a given codim, with positive or negative orientation. More...
#include <EntityRep.hpp>
Public Types | |
| enum | { codimension =codim } |
| enum | { InvalidIndex = INT_MAX } |
Public Member Functions | |
| EntityRep () | |
| Default constructor. More... | |
| EntityRep (int index_arg, bool orientation_arg) | |
| Constructor taking an entity index and an orientation. More... | |
| 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... | |
Detailed Description
class Dune::cpgrid::EntityRep< codim >
Represents an entity of a given codim, with positive or negative orientation.
This class is not a part of the Dune interface, but of our implementation. Since this class has a few friends, and for aid in debugging, we document its interior representation here: The interior representation consists of an integer entityrep_ which, if positive or zero, indicates the index of the entity. In that case, the entity's orientation is positive. If entityrep_ is negative, the orientation is negative, and the index is given by ~entityrep_ (we cannot use -entityrep_, since 0 is a valid index). We may consider changing this representation to using something like a std::pair<int, bool> instead.
- Template Parameters
-
codim Codimension
Member Enumeration Documentation
◆ anonymous enum
◆ anonymous enum
Constructor & Destructor Documentation
◆ EntityRep() [1/2]
|
inline |
Default constructor.
Referenced by Dune::cpgrid::EntityRep< codim >::opposite().
◆ EntityRep() [2/2]
|
inline |
Constructor taking an entity index and an orientation.
- Parameters
-
index_arg Entity index orientation_arg True if the entity's orientation is positive.
Member Function Documentation
◆ increment()
|
inline |
Increments the entityrep's index() by one.
Referenced by Dune::cpgrid::Iterator< cd, pitype >::Iterator(), and Dune::cpgrid::Iterator< cd, pitype >::operator++().
◆ index()
|
inline |
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().
◆ operator!=()
|
inline |
Inequality operator.
- Parameters
-
other The other entity representation.
- Returns
- true if this and the other element are not equal.
References Dune::cpgrid::EntityRep< codim >::operator==().
◆ operator<()
|
inline |
Ordering relation used for maps etc.
Sorting on index and then orientation, with positive orientations first.
- Parameters
-
other The other entity representation.
- Returns
- true if this element is less than the other.
References Dune::cpgrid::EntityRep< codim >::index(), and Dune::cpgrid::EntityRep< codim >::orientation().
◆ operator==()
|
inline |
Equality operator.
- Parameters
-
other The other entity representation.
- Returns
- true if this and the other element are equal.
Referenced by Dune::cpgrid::EntityRep< codim >::operator!=(), and Dune::cpgrid::Entity< codim >::operator==().
◆ opposite()
|
inline |
Returns an EntityRep with opposite orientation.
- Returns
- an EntityRep with opposite orientation.
References Dune::cpgrid::EntityRep< codim >::EntityRep().
Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::makeInverseRelation(), Dune::cpgrid::OrientedEntityRange< codim_to >::operator[](), and Dune::cpgrid::MutableOrientedEntityRange< codim_to >::operator[]().
◆ orientation()
|
inline |
Returns true if the entity has positive orientation. Not a Dune interface method.
- Returns
- true if the entity has positive orientation.
Referenced by Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::makeInverseRelation(), Dune::cpgrid::EntityRep< codim >::operator<(), Dune::cpgrid::SignedEntityVariable< T, codim >::operator[](), Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::operator[](), and Dune::cpgrid::OrientedEntityTable< codim_from, codim_to >::printRelationMatrix().
◆ setValue()
|
inline |
Set entity value.
- Parameters
-
index Entity index orientation True if the entity's orientation is positive.
◆ signedIndex()
|
inline |
The signed index that also tells us the orientation.
The documentation for this class was generated from the following files: