deal.II version GIT relicensing-2220-ge8e5360a96 2024-12-05 09:50:00+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
InvalidAccessor< structdim, dim, spacedim > Class Template Reference

#include <deal.II/grid/tria_accessor.h>

Inheritance diagram for InvalidAccessor< structdim, dim, spacedim >:
Inheritance graph
[legend]

Public Types

using AccessorData = void
 

Public Member Functions

 InvalidAccessor (const void *parent=nullptr, const int level=-1, const int index=-1, const AccessorData *local_data=nullptr)
 
 InvalidAccessor (const InvalidAccessor &)
 
template<typename OtherAccessor >
 InvalidAccessor (const OtherAccessor &)
 
void copy_from (const InvalidAccessor &)
 
bool operator== (const InvalidAccessor &) const
 
bool operator!= (const InvalidAccessor &) const
 
void operator++ () const
 
void operator-- () const
 
bool used () const
 
bool has_children () const
 
types::manifold_id manifold_id () const
 
unsigned int user_index () const
 
void set_user_index (const unsigned int p) const
 
void set_manifold_id (const types::manifold_id) const
 
Point< spacedim > & vertex (const unsigned int i) const
 
void * line (const unsigned int i) const
 
void * quad (const unsigned int i) const
 

Static Public Member Functions

static IteratorState::IteratorStates state ()
 
static int level ()
 
static int index ()
 

Static Public Attributes

static constexpr unsigned int space_dimension = spacedim
 
static constexpr unsigned int dimension = dim
 
static const unsigned int structure_dimension = structdim
 

Detailed Description

template<int structdim, int dim, int spacedim = dim>
class InvalidAccessor< structdim, dim, spacedim >

A class that represents accessor objects to iterators that don't make sense such as quad iterators in on 1d meshes. This class can not be used to create objects (it will in fact throw an exception if this should ever be attempted but it sometimes allows code to be written in a simpler way in a dimension independent way. For example, it allows to write code that works on quad iterators that is dimension independent – i.e., also compiles in 1d – because quad iterators (via the current class) exist and are syntactically correct. You can not expect, however, to ever create an actual object of one of these iterators in 1d, meaning you need to expect to wrap the code block in which you use quad iterators into something like if (dim>1) – which makes eminent sense anyway.

This class provides the minimal interface necessary for Accessor classes to interact with Iterator classes. However, this is only for syntactic correctness, none of the functions do anything but generate errors.

Definition at line 573 of file tria_accessor.h.

Member Typedef Documentation

◆ AccessorData

template<int structdim, int dim, int spacedim = dim>
using InvalidAccessor< structdim, dim, spacedim >::AccessorData = void

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 603 of file tria_accessor.h.

Constructor & Destructor Documentation

◆ InvalidAccessor() [1/3]

template<int structdim, int dim, int spacedim = dim>
InvalidAccessor< structdim, dim, spacedim >::InvalidAccessor ( const void *  parent = nullptr,
const int  level = -1,
const int  index = -1,
const AccessorData local_data = nullptr 
)

Constructor. This class is used for iterators that do not make sense in a given dimension, for example quads for 1d meshes. Consequently, while the creation of such objects is syntactically valid, they make no semantic sense, and we generate an exception when such an object is actually generated.

◆ InvalidAccessor() [2/3]

template<int structdim, int dim, int spacedim = dim>
InvalidAccessor< structdim, dim, spacedim >::InvalidAccessor ( const InvalidAccessor< structdim, dim, spacedim > &  )

Copy constructor. This class is used for iterators that do not make sense in a given dimension, for example quads for 1d meshes. Consequently, while the creation of such objects is syntactically valid, they make no semantic sense, and we generate an exception when such an object is actually generated.

◆ InvalidAccessor() [3/3]

template<int structdim, int dim, int spacedim>
template<typename OtherAccessor >
InvalidAccessor< structdim, dim, spacedim >::InvalidAccessor ( const OtherAccessor &  )

Conversion from other accessors to the current invalid one. This of course also leads to a run-time error.

Definition at line 4241 of file tria_accessor.h.

Member Function Documentation

◆ copy_from()

template<int structdim, int dim, int spacedim = dim>
void InvalidAccessor< structdim, dim, spacedim >::copy_from ( const InvalidAccessor< structdim, dim, spacedim > &  )

Dummy copy operation.

◆ operator==()

template<int structdim, int dim, int spacedim = dim>
bool InvalidAccessor< structdim, dim, spacedim >::operator== ( const InvalidAccessor< structdim, dim, spacedim > &  ) const

Dummy comparison operators.

◆ operator!=()

template<int structdim, int dim, int spacedim = dim>
bool InvalidAccessor< structdim, dim, spacedim >::operator!= ( const InvalidAccessor< structdim, dim, spacedim > &  ) const

◆ operator++()

template<int structdim, int dim, int spacedim = dim>
void InvalidAccessor< structdim, dim, spacedim >::operator++ ( ) const

Dummy operators to make things compile. Does nothing.

◆ operator--()

template<int structdim, int dim, int spacedim = dim>
void InvalidAccessor< structdim, dim, spacedim >::operator-- ( ) const

◆ state()

template<int structdim, int dim, int spacedim>
IteratorState::IteratorStates InvalidAccessor< structdim, dim, spacedim >::state ( )
static

Return the state of the iterator. For the different states an accessor can be in, refer to the TriaRawIterator documentation.

Definition at line 3478 of file tria_accessor.cc.

◆ level()

template<int structdim, int dim, int spacedim>
int InvalidAccessor< structdim, dim, spacedim >::level ( )
static

Level of this object. Vertices have no level, so this function always returns zero.

Definition at line 3487 of file tria_accessor.cc.

◆ index()

template<int structdim, int dim, int spacedim>
int InvalidAccessor< structdim, dim, spacedim >::index ( )
static

Index of this object. Returns the global index of the vertex this object points to.

Definition at line 3496 of file tria_accessor.cc.

◆ used()

template<int structdim, int dim, int spacedim = dim>
bool InvalidAccessor< structdim, dim, spacedim >::used ( ) const

Dummy function representing whether the accessor points to a used or an unused object.

◆ has_children()

template<int structdim, int dim, int spacedim = dim>
bool InvalidAccessor< structdim, dim, spacedim >::has_children ( ) const

Dummy function representing whether the accessor points to an object that has children.

◆ manifold_id()

template<int structdim, int dim, int spacedim = dim>
types::manifold_id InvalidAccessor< structdim, dim, spacedim >::manifold_id ( ) const

Dummy function that always returns numbers::flat_manifold_id.

◆ user_index()

template<int structdim, int dim, int spacedim = dim>
unsigned int InvalidAccessor< structdim, dim, spacedim >::user_index ( ) const

Dummy function that always returns numbers::invalid_unsigned_int.

◆ set_user_index()

template<int structdim, int dim, int spacedim = dim>
void InvalidAccessor< structdim, dim, spacedim >::set_user_index ( const unsigned int  p) const

Dummy function that always throws.

◆ set_manifold_id()

template<int structdim, int dim, int spacedim = dim>
void InvalidAccessor< structdim, dim, spacedim >::set_manifold_id ( const types::manifold_id  ) const

Dummy function that always throws.

◆ vertex()

template<int structdim, int dim, int spacedim = dim>
Point< spacedim > & InvalidAccessor< structdim, dim, spacedim >::vertex ( const unsigned int  i) const

Dummy function to extract vertices. Returns the origin.

◆ line()

template<int structdim, int dim, int spacedim = dim>
void * InvalidAccessor< structdim, dim, spacedim >::line ( const unsigned int  i) const

Dummy function to extract lines. Returns a default-constructed line iterator.

◆ quad()

template<int structdim, int dim, int spacedim = dim>
void * InvalidAccessor< structdim, dim, spacedim >::quad ( const unsigned int  i) const

Dummy function to extract quads. Returns a default-constructed quad iterator.

Member Data Documentation

◆ space_dimension

template<int structdim, int dim, int spacedim = dim>
constexpr unsigned int InvalidAccessor< structdim, dim, spacedim >::space_dimension = spacedim
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 582 of file tria_accessor.h.

◆ dimension

template<int structdim, int dim, int spacedim = dim>
constexpr unsigned int InvalidAccessor< structdim, dim, spacedim >::dimension = dim
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 589 of file tria_accessor.h.

◆ structure_dimension

template<int structdim, int dim, int spacedim = dim>
const unsigned int InvalidAccessor< structdim, dim, spacedim >::structure_dimension = structdim
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 596 of file tria_accessor.h.


The documentation for this class was generated from the following files: