deal.II version GIT relicensing-1936-ge55124254b 2024-10-04 21:10:00+00:00
|
#include <deal.II/grid/tria_accessor.h>
Public Types | |
using | LocalData = void * |
Public Member Functions | |
void | operator= (const TriaAccessorBase *)=delete |
Iterator address and state | |
int | level () const |
int | index () const |
IteratorState::IteratorStates | state () const |
const Triangulation< dim, spacedim > & | get_triangulation () const |
Static Public Attributes | |
static constexpr unsigned int | space_dimension = spacedim |
static constexpr unsigned int | dimension = dim |
static const unsigned int | structure_dimension = structdim |
Protected Types | |
using | AccessorData = void |
Protected Member Functions | |
TriaAccessorBase (const Triangulation< dim, spacedim > *parent=nullptr, const int level=-1, const int index=-1, const AccessorData *=nullptr) | |
TriaAccessorBase (const TriaAccessorBase &) | |
void | copy_from (const TriaAccessorBase &) |
TriaAccessorBase & | operator= (const TriaAccessorBase &) |
bool | operator< (const TriaAccessorBase &other) const |
bool | operator== (const TriaAccessorBase &) const |
bool | operator!= (const TriaAccessorBase &) const |
::internal::TriangulationImplementation::TriaObjects & | objects () const |
Advancement of iterators | |
void | operator++ () |
void | operator-- () |
Protected Attributes | |
typename::internal::TriaAccessorImplementation::PresentLevelType< structdim, dim >::type | present_level |
int | present_index |
const Triangulation< dim, spacedim > * | tria |
Friends | |
template<typename Accessor > | |
class | TriaRawIterator |
template<typename Accessor > | |
class | TriaIterator |
template<typename Accessor > | |
class | TriaActiveIterator |
A base class for the accessor classes used by TriaRawIterator and derived classes.
This class offers only the basic functionality required by the iterators (stores the necessary data members, offers comparison operators and the like), but has no functionality to actually dereference data. This is done in the derived classes.
In the implementation, the behavior of this class differs between the cases where structdim==dim
(cells of a mesh) and structdim<dim
(faces and edges). For the latter, present_level is always equal to zero and the constructors may not receive a positive value there. For cells, any level is possible, but only those within the range of the levels of the Triangulation are reasonable. Furthermore, the function objects() returns either the container with all cells on the same level or the container with all objects of this dimension (structdim<dim
).
Some internals of this class are discussed in Iterator and accessor internals.
Definition at line 307 of file tria_accessor.h.
|
protected |
Declare the data type that this accessor class expects to get passed from the iterator classes. Since the pure triangulation iterators need no additional data, this data type is void
.
Definition at line 350 of file tria_accessor.h.
using TriaAccessorBase< structdim, dim, spacedim >::LocalData = void * |
Data type to be used for passing parameters from iterators to the accessor classes in a unified way, no matter what the type of number of these parameters is.
Definition at line 448 of file tria_accessor.h.
|
protected |
Constructor. Protected, thus only callable from friend classes.
|
protected |
Copy constructor. Creates an object with exactly the same data.
|
delete |
Copy operator. These operators are usually used in a context like iterator a,b; *a=*b;
. Presumably, the intent here is to copy the object pointed to by b
to the object pointed to by a
. However, the result of dereferencing an iterator is not an object but an accessor; consequently, this operation is not useful for iterators on triangulations. Consequently, this operator is declared as deleted and can not be used.
|
protected |
Copy operator. Since this is only called from iterators, do not return anything, since the iterator will return itself.
This method is protected, since it is only to be called from the iterator class.
|
protected |
Copy operator. Creates an object with exactly the same data.
|
protected |
Comparison operator for accessors. This operator is used when comparing iterators into objects of a triangulation, for example when putting them into a std::map
.
If structure_dimension is less than dimension, we simply compare the index of such an object because faces and edges do not have levels. If structure_dimension equals dimension, we compare the level first, and the index only if levels are equal.
|
protected |
Compare for equality.
|
protected |
Compare for inequality.
|
protected |
This operator advances the iterator to the next element.
For dim=1
only: The next element is next on this level if there are more. If the present element is the last on this level, the first on the next level is accessed.
|
protected |
This operator moves the iterator to the previous element.
For dim=1
only: The previous element is previous on this level if index>0
. If the present element is the first on this level, the last on the previous level is accessed.
|
protected |
Access to the other objects of a Triangulation with same dimension.
int TriaAccessorBase< structdim, dim, spacedim >::level | ( | ) | const |
For cells, this function returns the level within the mesh hierarchy at which this cell is located. For all other objects, the function returns zero.
(level, index)
where the former is the cell's refinement level and the latter is the index of the cell within this refinement level (the former being what this function returns). Consequently, there may be multiple cells on different refinement levels but with the same index within their level. Contrary to this, if the current object corresponds to a face or edge, then the object is uniquely identified solely by its index as faces and edges do not have a refinement level. For these objects, the current function always returns zero as the level. int TriaAccessorBase< structdim, dim, spacedim >::index | ( | ) | const |
Return the index of the element presently pointed to on the present level.
Within a Triangulation object, cells are uniquely identified by a pair (level, index)
where the former is the cell's refinement level and the latter is the index of the cell within this refinement level (the latter being what this function returns). Consequently, there may be multiple cells on different refinement levels but with the same index within their level. Contrary to this, if the current object corresponds to a face or edge, then the object is uniquely identified solely by its index as faces and edges do not have a refinement level.
IteratorState::IteratorStates TriaAccessorBase< structdim, dim, spacedim >::state | ( | ) | const |
Return the state of the iterator. For the different states an accessor can be in, refer to the TriaRawIterator documentation.
const Triangulation< dim, spacedim > & TriaAccessorBase< structdim, dim, spacedim >::get_triangulation | ( | ) | const |
Return a reference to the triangulation which the object pointed to by this class belongs to.
|
friend |
Definition at line 543 of file tria_accessor.h.
|
friend |
Definition at line 545 of file tria_accessor.h.
|
friend |
Definition at line 547 of file tria_accessor.h.
|
staticconstexpr |
Dimension of the space the object represented by this accessor lives in. For example, if this accessor represents a quadrilateral that is part of a two-dimensional surface in four-dimensional space, then this value is four.
Definition at line 316 of file tria_accessor.h.
|
staticconstexpr |
Dimensionality of the object that the thing represented by this accessor is part of. For example, if this accessor represents a line that is part of a hexahedron, then this value will be three.
Definition at line 323 of file tria_accessor.h.
|
static |
Dimensionality of the current object represented by this accessor. For example, if it is line (irrespective of whether it is part of a 2d or 3d subobject), then this value equals 1.
Definition at line 330 of file tria_accessor.h.
|
protected |
The level if this is a cell (structdim==dim
). Else, contains zero.
Definition at line 528 of file tria_accessor.h.
|
protected |
Used to store the index of the element presently pointed to on the level presently used.
Definition at line 534 of file tria_accessor.h.
|
protected |
Pointer to the triangulation which we act on.
Definition at line 539 of file tria_accessor.h.