#include <deal.II/dofs/dof_accessor.h>

Inheritance diagram for DoFAccessor< 0, 1, spacedim, level_dof_access >:

Public Types
using	BaseClass = TriaAccessor< 0, 1, spacedim >

using	AccessorData = DoFHandler< 1, spacedim >

enum	VertexKind { left_vertex , interior_vertex , right_vertex }

Public Member Functions
const DoFHandler< 1, spacedim > &	get_dof_handler () const

template<bool level_dof_access2>
void	copy_from (const DoFAccessor< 0, 1, spacedim, level_dof_access2 > &a)

void	copy_from (const TriaAccessorBase< 0, 1, spacedim > &da)

void	copy_from (const TriaAccessor &)

int	index () const

const Triangulation< 1, spacedim > &	get_triangulation () const

bool	at_boundary () const

types::boundary_id	boundary_id () const

const Manifold< 1, spacedim > &	get_manifold () const

types::manifold_id	manifold_id () const

bool	used () const

ReferenceCell	reference_cell () const

unsigned int	n_vertices () const

unsigned int	n_lines () const

std_cxx20::ranges::iota_view< unsigned int, unsigned int >	vertex_indices () const

std_cxx20::ranges::iota_view< unsigned int, unsigned int >	line_indices () const

Constructors
	DoFAccessor ()

	DoFAccessor (const Triangulation< 1, spacedim > tria, const typename TriaAccessor< 0, 1, spacedim >::VertexKind vertex_kind, const unsigned int vertex_index, const DoFHandler< 1, spacedim > dof_handler)

	DoFAccessor (const Triangulation< 1, spacedim > , const int=0, const int=0, const DoFHandler< 1, spacedim > dof_handler=0)

template<int structdim2, int dim2, int spacedim2>
	DoFAccessor (const InvalidAccessor< structdim2, dim2, spacedim2 > &)

template<int structdim2, int dim2, int spacedim2, bool level_dof_access2>
	DoFAccessor (const DoFAccessor< structdim2, dim2, spacedim2, level_dof_access2 > &)

	DoFAccessor (const DoFAccessor< 0, 1, spacedim, level_dof_access > &)=default

	DoFAccessor (DoFAccessor< 0, 1, spacedim, level_dof_access > &&)=default

	~DoFAccessor ()=default

DoFAccessor< 0, 1, spacedim, level_dof_access > &	operator= (const DoFAccessor< 0, 1, spacedim, level_dof_access > &da)=delete

DoFAccessor< 0, 1, spacedim, level_dof_access > &	operator= (DoFAccessor< 0, 1, spacedim, level_dof_access > &&) noexcept=default

Accessing sub-objects
TriaIterator< DoFAccessor< 0, 1, spacedim, level_dof_access > >	child (const unsigned int c) const

typename::internal::DoFHandlerImplementation::Iterators< 1, spacedim, level_dof_access >::line_iterator	line (const unsigned int i) const

typename::internal::DoFHandlerImplementation::Iterators< 1, spacedim, level_dof_access >::quad_iterator	quad (const unsigned int i) const

Accessing the DoF indices of this object
void	get_dof_indices (std::vector< types::global_dof_index > &dof_indices, const types::fe_index fe_index=numbers::invalid_fe_index) const

void	get_mg_dof_indices (const int level, std::vector< types::global_dof_index > &dof_indices, const types::fe_index fe_index=numbers::invalid_fe_index) const

types::global_dof_index	vertex_dof_index (const unsigned int vertex, const unsigned int i, const types::fe_index fe_index=numbers::invalid_fe_index) const

types::global_dof_index	dof_index (const unsigned int i, const types::fe_index fe_index=numbers::invalid_fe_index) const

Accessing the finite element associated with this object
unsigned int	n_active_fe_indices () const

types::fe_index	nth_active_fe_index (const unsigned int n) const

bool	fe_index_is_active (const types::fe_index fe_index) const

const FiniteElement< 1, spacedim > &	get_fe (const types::fe_index fe_index) const

Advancement of iterators
void	operator++ () const

void	operator-- () const

bool	operator== (const TriaAccessor &) const

bool	operator!= (const TriaAccessor &) const

bool	operator< (const TriaAccessor &other) const

User data
bool	user_flag_set () const

void	set_user_flag () const

void	clear_user_flag () const

void	recursively_set_user_flag () const

void	recursively_clear_user_flag () const

void	clear_user_data () const

void	set_user_pointer (void *p) const

void	clear_user_pointer () const

void *	user_pointer () const

void	recursively_set_user_pointer (void *p) const

void	recursively_clear_user_pointer () const

void	set_user_index (const unsigned int p) const

void	clear_user_index () const

unsigned int	user_index () const

void	recursively_set_user_index (const unsigned int p) const

void	recursively_clear_user_index () const

Dealing with boundary indicators
void	set_boundary_id (const types::boundary_id) const

void	set_manifold_id (const types::manifold_id)

void	set_all_boundary_ids (const types::boundary_id) const

void	set_all_manifold_ids (const types::manifold_id)

Static Public Member Functions
static ::ExceptionBase &	ExcInvalidObject ()

static ::ExceptionBase &	ExcVectorNotEmpty ()

static ::ExceptionBase &	ExcVectorDoesNotMatch ()

static ::ExceptionBase &	ExcMatrixDoesNotMatch ()

static ::ExceptionBase &	ExcNotActive ()

static ::ExceptionBase &	ExcCantCompareIterators ()

static IteratorState::IteratorStates	state ()

static int	level ()

Orientation of sub-objects
static types::geometric_orientation	combined_face_orientation (const unsigned int face)
	Always return 0.

static bool	face_orientation (const unsigned int face)
	Always return false.

static bool	face_flip (const unsigned int face)
	Always return false.

static bool	face_rotation (const unsigned int face)
	Always return false.

static types::geometric_orientation	line_orientation (const unsigned int line)
	Always return numbers::reverse_line_orientation.

Accessing children
static bool	has_children ()

static unsigned int	n_children ()

static unsigned int	n_active_descendants ()

static unsigned int	max_refinement_depth ()

static unsigned int	child_iterator_to_index (const TriaIterator< TriaAccessor< 0, 1, spacedim > > &)
	Return an invalid unsigned integer.

static TriaIterator< TriaAccessor< 0, 1, spacedim > >	child (const unsigned int)
	Return an invalid object.

static TriaIterator< TriaAccessor< 0, 1, spacedim > >	isotropic_child (const unsigned int)
	Return an invalid object.

static RefinementCase< 0 >	refinement_case ()

static int	child_index (const unsigned int i)
	Returns -1.

static int	isotropic_child_index (const unsigned int i)
	Returns -1.

Static Public Attributes
static constexpr unsigned int	dimension = 1

static constexpr unsigned int	space_dimension = spacedim

static const unsigned int	structure_dimension = 0

Protected Member Functions
template<int structdim2, int dim2, int spacedim2, bool level_dof_access2>
bool	operator== (const DoFAccessor< structdim2, dim2, spacedim2, level_dof_access2 > &) const

template<int structdim2, int dim2, int spacedim2, bool level_dof_access2>
bool	operator!= (const DoFAccessor< structdim2, dim2, spacedim2, level_dof_access2 > &) const

void	set_dof_handler (DoFHandler< 1, spacedim > *dh)

void	set_dof_index (const unsigned int i, const types::global_dof_index index, const types::fe_index fe_index=numbers::invalid_fe_index) const

Protected Attributes
DoFHandler< 1, spacedim > *	dof_handler

const Triangulation< 1, spacedim > *	tria

VertexKind	vertex_kind

unsigned int	global_vertex_index

Friends
template<typename >
class	TriaRawIterator

class	DoFHandler< 1, spacedim >

struct	::internal::DoFHandlerImplementation::Policy::Implementation

struct	::internal::DoFHandlerImplementation::Implementation

struct	::internal::hp::DoFHandlerImplementation::Implementation

struct	::internal::DoFCellAccessorImplementation::Implementation

Accessing sub-objects
unsigned int	vertex_index (const unsigned int i=0) const

Point< spacedim > &	vertex (const unsigned int i=0) const

Point< spacedim >	center () const

static typename::internal::TriangulationImplementation::Iterators< 1, spacedim >::line_iterator	line (const unsigned int)

static unsigned int	line_index (const unsigned int i)

static typename::internal::TriangulationImplementation::Iterators< 1, spacedim >::quad_iterator	quad (const unsigned int i)

static unsigned int	quad_index (const unsigned int i)

Detailed Description

template<int spacedim, bool level_dof_access>
class DoFAccessor< 0, 1, spacedim, level_dof_access >

Specialization of the general DoFAccessor class template for the case of zero-dimensional objects (a vertex) that are the face of a one-dimensional cell in spacedim space dimensions. Since vertices function differently than general faces, this class does a few things differently than the general template, but the interface should look the same.

Definition at line 765 of file dof_accessor.h.

Member Typedef Documentation

◆ BaseClass

template<int spacedim, bool level_dof_access>

using DoFAccessor< 0, 1, spacedim, level_dof_access >::BaseClass = TriaAccessor<0, 1, spacedim>

Declare an alias to the base class to make accessing some of the exception classes simpler.

Definition at line 785 of file dof_accessor.h.

◆ AccessorData

template<int spacedim, bool level_dof_access>

using DoFAccessor< 0, 1, spacedim, level_dof_access >::AccessorData = DoFHandler<1, spacedim>

Data type passed by the iterator class.

Definition at line 790 of file dof_accessor.h.

Member Enumeration Documentation

◆ VertexKind

template<int spacedim>

enum TriaAccessor< 0, 1, spacedim >::VertexKind

inherited

Whether the vertex represented here is at the left end of the domain, the right end, or in the interior.

Enumerator
left_vertex	Left vertex.
interior_vertex	Interior vertex.
right_vertex	Right vertex.

Definition at line 2351 of file tria_accessor.h.

Constructor & Destructor Documentation

◆ DoFAccessor() [1/7]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor ( )

inline

Default constructor. Provides an accessor that can't be used.

Definition at line 3908 of file dof_accessor.h.

◆ DoFAccessor() [2/7]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor	(	const Triangulation< 1, spacedim > *	tria,
		const typename TriaAccessor< 0, 1, spacedim >::VertexKind	vertex_kind,
		const unsigned int	vertex_index,
		const DoFHandler< 1, spacedim > *	dof_handler
	)

inline

Constructor to be used if the object here refers to a vertex of a one-dimensional triangulation, i.e. a face of the triangulation.

Since there is no mapping from vertices to cells, an accessor object for a point has no way to figure out whether it is at the boundary of the domain or not. Consequently, the second argument must be passed by the object that generates this accessor – e.g. a 1d cell that can figure out whether its left or right vertex are at the boundary.

The third argument is the global index of the vertex we point to.

The fourth argument is a pointer to the DoFHandler object.

This iterator can only be called for one-dimensional triangulations.

Definition at line 3916 of file dof_accessor.h.

◆ DoFAccessor() [3/7]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor	(	const Triangulation< 1, spacedim > *	tria,
		const int	level = `0`,
		const int	index = `0`,
		const DoFHandler< 1, spacedim > *	dof_handler = `0`
	)

inline

Constructor. This constructor exists in order to maintain interface compatibility with the other accessor classes. However, it doesn't do anything useful here and so may not actually be called except to default-construct iterator objects.

Definition at line 3928 of file dof_accessor.h.

◆ DoFAccessor() [4/7]

template<int spacedim, bool level_dof_access>

template<int structdim2, int dim2, int spacedim2>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor ( const InvalidAccessor< structdim2, dim2, spacedim2 > & )

Conversion constructor. This constructor exists to make certain constructs simpler to write in dimension independent code. For example, it allows assigning a face iterator to a line iterator, an operation that is useful in 2d but doesn't make any sense in 3d. The constructor here exists for the purpose of making the code conform to C++ but it will unconditionally abort; in other words, assigning a face iterator to a line iterator is better put into an if-statement that checks that the dimension is two, and assign to a quad iterator in 3d (an operator that, without this constructor would be illegal if we happen to compile for 2d).

Definition at line 3960 of file dof_accessor.h.

◆ DoFAccessor() [5/7]

template<int spacedim, bool level_dof_access>

template<int structdim2, int dim2, int spacedim2, bool level_dof_access2>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor ( const DoFAccessor< structdim2, dim2, spacedim2, level_dof_access2 > & )

inline

Another conversion operator between objects that don't make sense, just like the previous one.

Definition at line 3970 of file dof_accessor.h.

◆ DoFAccessor() [6/7]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor ( const DoFAccessor< 0, 1, spacedim, level_dof_access > & )

default

Copy constructor.

◆ DoFAccessor() [7/7]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access >::DoFAccessor ( DoFAccessor< 0, 1, spacedim, level_dof_access > && )

default

Move constructor.

◆ ~DoFAccessor()

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access >::~DoFAccessor ( )

default

Destructor.

Member Function Documentation

◆ operator=() [1/2]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access > & DoFAccessor< 0, 1, spacedim, level_dof_access >::operator= ( const DoFAccessor< 0, 1, spacedim, level_dof_access > & da )

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 DoF handler objects. Consequently, this operator is declared as deleted and can not be used.

◆ operator=() [2/2]

template<int spacedim, bool level_dof_access>

DoFAccessor< 0, 1, spacedim, level_dof_access > & DoFAccessor< 0, 1, spacedim, level_dof_access >::operator= ( DoFAccessor< 0, 1, spacedim, level_dof_access > && )

defaultnoexcept

Move assignment operator.

◆ get_dof_handler()

template<int spacedim, bool level_dof_access>

const DoFHandler< 1, spacedim > & DoFAccessor< 0, 1, spacedim, level_dof_access >::get_dof_handler ( ) const

inline

Return a handle on the DoFHandler object which we are using.

Definition at line 4003 of file dof_accessor.h.

◆ copy_from() [1/3]

template<int spacedim, bool level_dof_access>

template<bool level_dof_access2>

void DoFAccessor< 0, 1, spacedim, level_dof_access >::copy_from ( const DoFAccessor< 0, 1, spacedim, level_dof_access2 > & a )

inline

Implement the copy operator needed for the iterator classes.

Definition at line 4153 of file dof_accessor.h.

◆ copy_from() [2/3]

template<int spacedim, bool level_dof_access>

void DoFAccessor< 0, 1, spacedim, level_dof_access >::copy_from ( const TriaAccessorBase< 0, 1, spacedim > & da )

inline

Copy operator used by the iterator class. Keeps the previously set dof handler, but sets the object coordinates of the TriaAccessor.

Definition at line 4141 of file dof_accessor.h.

◆ child() [1/2]

template<int spacedim, bool level_dof_access>

TriaIterator< DoFAccessor< 0, 1, spacedim, level_dof_access > > DoFAccessor< 0, 1, spacedim, level_dof_access >::child ( const unsigned int c ) const

inline

Return an invalid iterator of a type that represents pointing to a child of the current object. The object is invalid because points (as represented by the current class) do not have children.

Definition at line 4164 of file dof_accessor.h.

◆ line() [1/2]

template<int spacedim, bool level_dof_access>

typename::internal::DoFHandlerImplementation::Iterators< 1, spacedim, level_dof_access >::line_iterator DoFAccessor< 0, 1, spacedim, level_dof_access >::line ( const unsigned int i ) const

inline

Pointer to the ith line bounding this object.

Since meshes with dimension 1 do not have quads this method just throws an exception.

Definition at line 4175 of file dof_accessor.h.

◆ quad() [1/2]

template<int spacedim, bool level_dof_access>

typename::internal::DoFHandlerImplementation::Iterators< 1, spacedim, level_dof_access >::quad_iterator DoFAccessor< 0, 1, spacedim, level_dof_access >::quad ( const unsigned int i ) const

inline

Pointer to the ith quad bounding this object.

Since meshes with dimension 1 do not have quads this method just throws an exception.

Definition at line 4188 of file dof_accessor.h.

◆ get_dof_indices()

template<int spacedim, bool level_dof_access>

void DoFAccessor< 0, 1, spacedim, level_dof_access >::get_dof_indices	(	std::vector< types::global_dof_index > &	dof_indices,
		const types::fe_index	fe_index = `numbers::invalid_fe_index`
	)		const

inline

Return the global indices of the degrees of freedom located on this object in the standard ordering defined by the finite element. This function is only available on active objects (see this glossary entry).

The present vertex must belong to an active cell (and not artificial in a parallel distributed computation).

The vector has to have the right size before being passed to this function.

The last argument denotes the finite element index. For the standard DoFHandler class, this value must be equal to its default value since that class only supports the same finite element on all cells anyway.

However, when the relevant DoFHandler has hp-capabilities, different finite element objects may be used on different cells. On faces between two cells, as well as vertices, there may therefore be two sets of degrees of freedom, one for each of the finite elements used on the adjacent cells. In order to specify which set of degrees of freedom to work on, the last argument is used to disambiguate. Finally, if this function is called for a cell object, there can only be a single set of degrees of freedom, and fe_index has to match the result of active_fe_index().

For cells, there is only a single possible finite element index (namely the one for that cell, returned by cell->active_fe_index. Consequently, the derived DoFCellAccessor class has an overloaded version of this function that calls the present function with cell->active_fe_index as last argument.

Definition at line 4012 of file dof_accessor.h.

◆ get_mg_dof_indices()

template<int spacedim, bool level_dof_access>

void DoFAccessor< 0, 1, spacedim, level_dof_access >::get_mg_dof_indices	(	const int	level,
		std::vector< types::global_dof_index > &	dof_indices,
		const types::fe_index	fe_index = `numbers::invalid_fe_index`
	)		const

inline

Return the global multilevel indices of the degrees of freedom that live on the current object with respect to the given level within the multigrid hierarchy. The indices refer to the local numbering for the level this line lives on.

Definition at line 4034 of file dof_accessor.h.

◆ vertex_dof_index()

template<int spacedim, bool level_dof_access>

types::global_dof_index DoFAccessor< 0, 1, spacedim, level_dof_access >::vertex_dof_index	(	const unsigned int	vertex,
		const unsigned int	i,
		const types::fe_index	fe_index = `numbers::invalid_fe_index`
	)		const

inline

Global DoF index of the i degree associated with the vertexth vertex of the present cell.

The last argument denotes the finite element index. For the standard DoFHandler class, this value must be equal to its default value since that class only supports the same finite element on all cells anyway.

However, when the relevant DoFHandler has hp-capabilities, different finite element objects may be used on different cells. On faces between two cells, as well as vertices, there may therefore be two sets of degrees of freedom, one for each of the finite elements used on the adjacent cells. In order to specify which set of degrees of freedom to work on, the last argument is used to disambiguate. Finally, if this function is called for a cell object, there can only be a single set of degrees of freedom, and fe_index has to match the result of active_fe_index().

Definition at line 4055 of file dof_accessor.h.

◆ dof_index()

template<int spacedim, bool level_dof_access>

types::global_dof_index DoFAccessor< 0, 1, spacedim, level_dof_access >::dof_index	(	const unsigned int	i,
		const types::fe_index	fe_index = `numbers::invalid_fe_index`
	)		const

inline

Index of the ith degree of freedom of this object.

The last argument denotes the finite element index. For the standard DoFHandler class, this value must be equal to its default value since that class only supports the same finite element on all cells anyway.

However, when the relevant DoFHandler has hp-capabilities, different finite element objects may be used on different cells. On faces between two cells, as well as vertices, there may therefore be two sets of degrees of freedom, one for each of the finite elements used on the adjacent cells. In order to specify which set of degrees of freedom to work on, the last argument is used to disambiguate. Finally, if this function is called for a cell object, there can only be a single set of degrees of freedom, and fe_index has to match the result of active_fe_index().

Definition at line 4079 of file dof_accessor.h.

◆ n_active_fe_indices()

template<int spacedim, bool level_dof_access>

unsigned int DoFAccessor< 0, 1, spacedim, level_dof_access >::n_active_fe_indices ( ) const

inline

Return the number of finite elements that are active on a given object.

Since vertices do not store the information necessary for this to be calculated, this method just raises an exception and only exists to enable dimension-independent programming.

Definition at line 4100 of file dof_accessor.h.

◆ nth_active_fe_index()

template<int spacedim, bool level_dof_access>

types::fe_index DoFAccessor< 0, 1, spacedim, level_dof_access >::nth_active_fe_index ( const unsigned int n ) const

inline

Return the n-th active FE index on this object.

Since vertices do not store the information necessary for this to be calculated, this method just raises an exception and only exists to enable dimension-independent programming.

Definition at line 4109 of file dof_accessor.h.

◆ fe_index_is_active()

template<int spacedim, bool level_dof_access>

bool DoFAccessor< 0, 1, spacedim, level_dof_access >::fe_index_is_active ( const types::fe_index fe_index ) const

inline

Return true if the finite element with given index is active on the present object.

Since vertices do not store the information necessary for this to be calculated, this method just raises an exception and only exists to enable dimension-independent programming.

Definition at line 4119 of file dof_accessor.h.

◆ get_fe()

template<int spacedim, bool level_dof_access>

const FiniteElement< 1, spacedim > & DoFAccessor< 0, 1, spacedim, level_dof_access >::get_fe ( const types::fe_index fe_index ) const

inline

Return a reference to the finite element used on this object with the given fe_index. fe_index must be used on this object, i.e. fe_index_is_active(fe_index) must return true.

Definition at line 4130 of file dof_accessor.h.

◆ operator==() [1/2]

template<int spacedim, bool level_dof_access>

template<int structdim2, int dim2, int spacedim2, bool level_dof_access2>

bool DoFAccessor< 0, 1, spacedim, level_dof_access >::operator== ( const DoFAccessor< structdim2, dim2, spacedim2, level_dof_access2 > & a ) const

inlineprotected

Compare for equality.

Definition at line 4201 of file dof_accessor.h.

◆ operator!=() [1/2]

template<int spacedim, bool level_dof_access>

template<int structdim2, int dim2, int spacedim2, bool level_dof_access2>

bool DoFAccessor< 0, 1, spacedim, level_dof_access >::operator!= ( const DoFAccessor< structdim2, dim2, spacedim2, level_dof_access2 > & a ) const

inlineprotected

Compare for inequality.

Definition at line 4214 of file dof_accessor.h.

◆ set_dof_handler()

template<int spacedim, bool level_dof_access>

void DoFAccessor< 0, 1, spacedim, level_dof_access >::set_dof_handler ( DoFHandler< 1, spacedim > * dh )

inlineprotected

Reset the DoF handler pointer.

Definition at line 3980 of file dof_accessor.h.

◆ set_dof_index()

template<int spacedim, bool level_dof_access>

void DoFAccessor< 0, 1, spacedim, level_dof_access >::set_dof_index	(	const unsigned int	i,
		const types::global_dof_index	index,
		const types::fe_index	fe_index = `numbers::invalid_fe_index`
	)		const

inlineprotected

Set the index of the ith degree of freedom of this object to index.

The last argument denotes the finite element index. For the standard DoFHandler class, this value must be equal to its default value since that class only supports the same finite element on all cells anyway.

However, when the relevant DoFHandler has hp-capabilities, different finite element objects may be used on different cells. On faces between two cells, as well as vertices, there may therefore be two sets of degrees of freedom, one for each of the finite elements used on the adjacent cells. In order to specify which set of degrees of freedom to work on, the last argument is used to disambiguate. Finally, if this function is called for a cell object, there can only be a single set of degrees of freedom, and fe_index has to match the result of active_fe_index().

Definition at line 3991 of file dof_accessor.h.

◆ copy_from() [3/3]

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::copy_from ( const TriaAccessor< 0, 1, spacedim > & )

inherited

Copy operator. Since this is only called from iterators, do not return anything, since the iterator will return itself.

◆ state()

template<int spacedim>

static IteratorState::IteratorStates TriaAccessor< 0, 1, spacedim >::state ( )

staticinherited

Return the state of the iterator. Since an iterator to points can not be incremented or decremented, its state remains constant, and in particular equal to IteratorState::valid.

◆ level()

template<int spacedim>

static int TriaAccessor< 0, 1, spacedim >::level ( )

staticinherited

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

◆ index()

template<int spacedim>

int TriaAccessor< 0, 1, spacedim >::index ( ) const

inherited

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

◆ get_triangulation()

template<int spacedim>

const Triangulation< 1, spacedim > & TriaAccessor< 0, 1, spacedim >::get_triangulation ( ) const

inherited

Return a reference to the triangulation which the object pointed to by this class belongs to.

◆ operator++()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::operator++ ( ) const

inherited

This operator advances the iterator to the next element. For points, this operation is not defined, so you can't iterate over point iterators.

◆ operator--()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::operator-- ( ) const

inherited

This operator moves the iterator to the previous element. For points, this operation is not defined, so you can't iterate over point iterators.

◆ operator==() [2/2]

template<int spacedim>

bool TriaAccessor< 0, 1, spacedim >::operator== ( const TriaAccessor< 0, 1, spacedim > & ) const

inherited

Compare for equality.

◆ operator!=() [2/2]

template<int spacedim>

bool TriaAccessor< 0, 1, spacedim >::operator!= ( const TriaAccessor< 0, 1, spacedim > & ) const

inherited

Compare for inequality.

◆ operator<()

template<int spacedim>

bool TriaAccessor< 0, 1, spacedim >::operator< ( const TriaAccessor< 0, 1, spacedim > & other ) const

inherited

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.

This operator simply compares the global index of the vertex the current object points to.

◆ vertex_index()

template<int spacedim>

unsigned int TriaAccessor< 0, 1, spacedim >::vertex_index ( const unsigned int i = 0 ) const

inherited

Return the global index of i-th vertex of the current object. If i is zero, this returns the index of the current point to which this object refers. Otherwise, it throws an exception.

Note that the returned value is only the index of the geometrical vertex. It has nothing to do with possible degrees of freedom associated with it. For this, see the DoFAccessor::vertex_dof_index functions.

Note: Despite the name, the index returned here is only global in the sense that it is specific to a particular Triangulation object or, in the case the triangulation is actually of type parallel::distributed::Triangulation, specific to that part of the distributed triangulation stored on the current processor.

◆ vertex()

template<int spacedim>

Point< spacedim > & TriaAccessor< 0, 1, spacedim >::vertex ( const unsigned int i = 0 ) const

inherited

Return a reference to the ith vertex. If i is zero, this returns a reference to the current point to which this object refers. Otherwise, it throws an exception.

◆ center()

template<int spacedim>

Point< spacedim > TriaAccessor< 0, 1, spacedim >::center ( ) const

inherited

Return the center of this object, which of course coincides with the location of the vertex this object refers to.

◆ line() [2/2]

template<int spacedim>

static typename::internal::TriangulationImplementation::Iterators< 1, spacedim >::line_iterator TriaAccessor< 0, 1, spacedim >::line ( const unsigned int )

staticinherited

Pointer to the ith line bounding this object. Will point to an invalid object.

◆ line_index()

template<int spacedim>

static unsigned int TriaAccessor< 0, 1, spacedim >::line_index ( const unsigned int i )

staticinherited

Line index of the ith line bounding this object.

Implemented only for structdim>1, otherwise an exception generated.

◆ quad() [2/2]

template<int spacedim>

static typename::internal::TriangulationImplementation::Iterators< 1, spacedim >::quad_iterator TriaAccessor< 0, 1, spacedim >::quad ( const unsigned int i )

staticinherited

Pointer to the ith quad bounding this object.

◆ quad_index()

template<int spacedim>

static unsigned int TriaAccessor< 0, 1, spacedim >::quad_index ( const unsigned int i )

staticinherited

Quad index of the ith quad bounding this object.

Implemented only for structdim>2, otherwise an exception generated.

◆ at_boundary()

template<int spacedim>

bool TriaAccessor< 0, 1, spacedim >::at_boundary ( ) const

inherited

Return whether this point is at the boundary of the one-dimensional triangulation we deal with here.

◆ boundary_id()

template<int spacedim>

types::boundary_id TriaAccessor< 0, 1, spacedim >::boundary_id ( ) const

inherited

Return the boundary indicator of this object. The convention for one dimensional triangulations is that left end vertices (of each line segment from which the triangulation may be constructed) have boundary indicator zero, and right end vertices have boundary indicator one, unless explicitly set differently.

If the return value is the special value numbers::internal_face_boundary_id, then this object is in the interior of the domain.

See also: Glossary entry on boundary indicators

◆ get_manifold()

template<int spacedim>

const Manifold< 1, spacedim > & TriaAccessor< 0, 1, spacedim >::get_manifold ( ) const

inherited

Return a constant reference to the manifold object used for this object.

◆ manifold_id()

template<int spacedim>

types::manifold_id TriaAccessor< 0, 1, spacedim >::manifold_id ( ) const

inherited

Return the manifold indicator of this object.

See also: Glossary entry on manifold indicators.

◆ user_flag_set()

template<int spacedim>

bool TriaAccessor< 0, 1, spacedim >::user_flag_set ( ) const

inherited

Read the user flag. See GlossUserFlags for more information.

Definition at line 1733 of file tria_accessor.cc.

◆ set_user_flag()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::set_user_flag ( ) const

inherited

Set the user flag. See GlossUserFlags for more information.

Definition at line 1744 of file tria_accessor.cc.

◆ clear_user_flag()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::clear_user_flag ( ) const

inherited

Clear the user flag. See GlossUserFlags for more information.

Definition at line 1754 of file tria_accessor.cc.

◆ recursively_set_user_flag()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::recursively_set_user_flag ( ) const

inherited

Set the user flag for this and all descendants. See GlossUserFlags for more information.

Definition at line 1764 of file tria_accessor.cc.

◆ recursively_clear_user_flag()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::recursively_clear_user_flag ( ) const

inherited

Clear the user flag for this and all descendants. See GlossUserFlags for more information.

Definition at line 1777 of file tria_accessor.cc.

◆ clear_user_data()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::clear_user_data ( ) const

inherited

Reset the user data to zero, independent if pointer or index. See GlossUserData for more information.

Definition at line 1790 of file tria_accessor.cc.

◆ set_user_pointer()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::set_user_pointer ( void * p ) const

inherited

Set the user pointer to p.

Note: User pointers and user indices are mutually exclusive. Therefore, you can only use one of them, unless you call Triangulation::clear_user_data() in between.

See GlossUserData for more information.

Definition at line 1800 of file tria_accessor.cc.

◆ clear_user_pointer()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::clear_user_pointer ( ) const

inherited

Reset the user pointer to nullptr. See GlossUserData for more information.

Definition at line 1810 of file tria_accessor.cc.

◆ user_pointer()

template<int spacedim>

void * TriaAccessor< 0, 1, spacedim >::user_pointer ( ) const

inherited

Access the value of the user pointer. It is in the responsibility of the user to make sure that the pointer points to something useful. You should use the new style cast operator to maintain a minimum of type safety, e.g.

Note: User pointers and user indices are mutually exclusive. Therefore, you can only use one of them, unless you call Triangulation::clear_user_data() in between. A a=static_cast<A>(cell->user_pointer());.

See GlossUserData for more information.

Definition at line 1820 of file tria_accessor.cc.

◆ recursively_set_user_pointer()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::recursively_set_user_pointer ( void * p ) const

inherited

Set the user pointer of this object and all its children to the given value. This is useful for example if all cells of a certain subdomain, or all faces of a certain part of the boundary should have user pointers pointing to objects describing this part of the domain or boundary.

Note that the user pointer is not inherited under mesh refinement, so after mesh refinement there might be cells or faces that don't have user pointers pointing to the describing object. In this case, simply loop over all the elements of the coarsest level that has this information, and use this function to recursively set the user pointer of all finer levels of the triangulation.

Note: User pointers and user indices are mutually exclusive. Therefore, you can only use one of them, unless you call Triangulation::clear_user_data() in between.

See GlossUserData for more information.

Definition at line 1831 of file tria_accessor.cc.

◆ recursively_clear_user_pointer()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::recursively_clear_user_pointer ( ) const

inherited

Clear the user pointer of this object and all of its descendants. The same holds as said for the recursively_set_user_pointer() function. See GlossUserData for more information.

Definition at line 1844 of file tria_accessor.cc.

◆ set_user_index()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::set_user_index ( const unsigned int p ) const

inherited

Set the user index to p.

Note: User pointers and user indices are mutually exclusive. Therefore, you can only use one of them, unless you call Triangulation::clear_user_data() in between. See GlossUserData for more information.

Definition at line 1857 of file tria_accessor.cc.

◆ clear_user_index()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::clear_user_index ( ) const

inherited

Reset the user index to 0. See GlossUserData for more information.

Definition at line 1867 of file tria_accessor.cc.

◆ user_index()

template<int spacedim>

unsigned int TriaAccessor< 0, 1, spacedim >::user_index ( ) const

inherited

Access the value of the user index.

Note: User pointers and user indices are mutually exclusive. Therefore, you can only use one of them, unless you call Triangulation::clear_user_data() in between.

See GlossUserData for more information.

Definition at line 1877 of file tria_accessor.cc.

◆ recursively_set_user_index()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::recursively_set_user_index ( const unsigned int p ) const

inherited

Set the user index of this object and all its children.

Note that the user index is not inherited under mesh refinement, so after mesh refinement there might be cells or faces that don't have the expected user indices. In this case, simply loop over all the elements of the coarsest level that has this information, and use this function to recursively set the user index of all finer levels of the triangulation.

Note: User pointers and user indices are mutually exclusive. Therefore, you can only use one of them, unless you call Triangulation::clear_user_data() in between.

See GlossUserData for more information.

Definition at line 1888 of file tria_accessor.cc.

◆ recursively_clear_user_index()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::recursively_clear_user_index ( ) const

inherited

Clear the user index of this object and all of its descendants. The same holds as said for the recursively_set_user_index() function.

See GlossUserData for more information.

Definition at line 1901 of file tria_accessor.cc.

◆ has_children()

template<int spacedim>

static bool TriaAccessor< 0, 1, spacedim >::has_children ( )

staticinherited

Test whether the object has children. Always false.

◆ n_children()

template<int spacedim>

static unsigned int TriaAccessor< 0, 1, spacedim >::n_children ( )

staticinherited

Return the number of immediate children of this object.This is always zero in dimension 0.

◆ n_active_descendants()

template<int spacedim>

static unsigned int TriaAccessor< 0, 1, spacedim >::n_active_descendants ( )

staticinherited

Compute and return the number of active descendants of this objects. Always zero.

◆ max_refinement_depth()

template<int spacedim>

static unsigned int TriaAccessor< 0, 1, spacedim >::max_refinement_depth ( )

staticinherited

Return the number of times that this object is refined. Always 0.

◆ child_iterator_to_index()

template<int spacedim>

static unsigned int TriaAccessor< 0, 1, spacedim >::child_iterator_to_index ( const TriaIterator< TriaAccessor< 0, 1, spacedim > > & )

staticinherited

Return an invalid unsigned integer.

◆ child() [2/2]

template<int spacedim>

static TriaIterator< TriaAccessor< 0, 1, spacedim > > TriaAccessor< 0, 1, spacedim >::child ( const unsigned int )

staticinherited

Return an invalid object.

◆ isotropic_child()

template<int spacedim>

static TriaIterator< TriaAccessor< 0, 1, spacedim > > TriaAccessor< 0, 1, spacedim >::isotropic_child ( const unsigned int )

staticinherited

Return an invalid object.

◆ refinement_case()

template<int spacedim>

static RefinementCase< 0 > TriaAccessor< 0, 1, spacedim >::refinement_case ( )

staticinherited

Always return no refinement.

◆ child_index()

template<int spacedim>

static int TriaAccessor< 0, 1, spacedim >::child_index ( const unsigned int i )

staticinherited

Returns -1.

◆ isotropic_child_index()

template<int spacedim>

static int TriaAccessor< 0, 1, spacedim >::isotropic_child_index ( const unsigned int i )

staticinherited

Returns -1.

◆ set_boundary_id()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::set_boundary_id ( const types::boundary_id ) const

inherited

Set the boundary indicator. The same applies as for the boundary_id() function.

Warning: You should never set the boundary indicator of an interior face (a face not at the boundary of the domain), or set the boundary indicator of an exterior face to numbers::internal_face_boundary_id (this value is reserved for another purpose). Algorithms may not work or produce very confusing results if boundary cells have a boundary indicator of numbers::internal_face_boundary_id or if interior cells have boundary indicators other than numbers::internal_face_boundary_id. Unfortunately, the current object has no means of finding out whether it really is at the boundary of the domain and so cannot determine whether the value you are trying to set makes sense under the current circumstances.

See also: Glossary entry on boundary indicators

◆ set_manifold_id()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::set_manifold_id ( const types::manifold_id )

inherited

Set the manifold indicator of this vertex. This does nothing so far since manifolds are only used to refine and map objects, but vertices are not refined and the mapping is trivial. This function is here only to allow dimension independent programming.

◆ set_all_boundary_ids()

template<int spacedim>

void TriaAccessor< 0, 1, spacedim >::set_all_boundary_ids ( const types::boundary_id ) const

inherited

Set the boundary indicator of this object and all of its lower-dimensional sub-objects. Since this object only represents a single vertex, there are no lower-dimensional object and this function is equivalent to calling set_boundary_id() with the same argument.

See also: Glossary entry on boundary indicators

◆ used()

template<int spacedim>

bool TriaAccessor< 0, 1, spacedim >::used ( ) const

inherited

Return whether the vertex pointed to here is used.

◆ reference_cell()

template<int spacedim>

ReferenceCell TriaAccessor< 0, 1, spacedim >::reference_cell ( ) const

inherited

Reference cell type of the current object.

◆ n_vertices()

template<int spacedim>

unsigned int TriaAccessor< 0, 1, spacedim >::n_vertices ( ) const

inherited

Number of vertices.

◆ n_lines()

template<int spacedim>

unsigned int TriaAccessor< 0, 1, spacedim >::n_lines ( ) const

inherited

Number of lines.

◆ vertex_indices()

template<int spacedim>

std_cxx20::ranges::iota_view< unsigned int, unsigned int > TriaAccessor< 0, 1, spacedim >::vertex_indices ( ) const

inherited

Return an object that can be thought of as an array containing all indices from zero to n_vertices().

◆ line_indices()

template<int spacedim>

std_cxx20::ranges::iota_view< unsigned int, unsigned int > TriaAccessor< 0, 1, spacedim >::line_indices ( ) const

inherited

Return an object that can be thought of as an array containing all indices from zero to n_lines().

Friends And Related Symbol Documentation

◆ TriaRawIterator

template<int spacedim, bool level_dof_access>

template<typename >

friend class TriaRawIterator

friend

Definition at line 1209 of file dof_accessor.h.

◆ DoFHandler< 1, spacedim >

template<int spacedim, bool level_dof_access>

friend class DoFHandler< 1, spacedim >

friend

Definition at line 1209 of file dof_accessor.h.

◆ ::internal::DoFHandlerImplementation::Policy::Implementation

template<int spacedim, bool level_dof_access>

friend struct ::internal::DoFHandlerImplementation::Policy::Implementation

friend

Definition at line 1216 of file dof_accessor.h.

◆ ::internal::DoFHandlerImplementation::Implementation

template<int spacedim, bool level_dof_access>

friend struct ::internal::DoFHandlerImplementation::Implementation

friend

Definition at line 1218 of file dof_accessor.h.

◆ ::internal::hp::DoFHandlerImplementation::Implementation

template<int spacedim, bool level_dof_access>

friend struct ::internal::hp::DoFHandlerImplementation::Implementation

friend

Definition at line 1219 of file dof_accessor.h.

◆ ::internal::DoFCellAccessorImplementation::Implementation

template<int spacedim, bool level_dof_access>

friend struct ::internal::DoFCellAccessorImplementation::Implementation

friend

Definition at line 1220 of file dof_accessor.h.

Member Data Documentation

◆ dimension

template<int spacedim, bool level_dof_access>

constexpr unsigned int DoFAccessor< 0, 1, spacedim, level_dof_access >::dimension = 1

staticconstexpr

A static variable that allows users of this class to discover the value of the second template argument.

Definition at line 773 of file dof_accessor.h.

◆ space_dimension

template<int spacedim, bool level_dof_access>

constexpr unsigned int DoFAccessor< 0, 1, spacedim, level_dof_access >::space_dimension = spacedim

staticconstexpr

A static variable that allows users of this class to discover the value of the third template argument.

Definition at line 779 of file dof_accessor.h.

◆ dof_handler

template<int spacedim, bool level_dof_access>

DoFHandler<1, spacedim>* DoFAccessor< 0, 1, spacedim, level_dof_access >::dof_handler

protected

Store the address of the DoFHandler object to be accessed.

Definition at line 1158 of file dof_accessor.h.

◆ structure_dimension

template<int spacedim>

const unsigned int TriaAccessor< 0, 1, spacedim >::structure_dimension = 0

staticinherited

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

◆ tria

template<int spacedim>

const Triangulation<1, spacedim>* TriaAccessor< 0, 1, spacedim >::tria

protectedinherited

Pointer to the triangulation we operate on.

Definition at line 3030 of file tria_accessor.h.

◆ vertex_kind

template<int spacedim>

VertexKind TriaAccessor< 0, 1, spacedim >::vertex_kind

protectedinherited

Whether this is a left end, right end, or interior vertex. This information is provided by the cell at the time of creation.

Definition at line 3036 of file tria_accessor.h.

◆ global_vertex_index

template<int spacedim>

unsigned int TriaAccessor< 0, 1, spacedim >::global_vertex_index

protectedinherited

The global vertex index of the vertex this object corresponds to.

Definition at line 3041 of file tria_accessor.h.

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

include/deal.II/dofs/dof_accessor.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Accessing sub-objects

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ AccessorData

Member Enumeration Documentation

◆ VertexKind

Constructor & Destructor Documentation

◆ DoFAccessor() [1/7]

◆ DoFAccessor() [2/7]

◆ DoFAccessor() [3/7]

◆ DoFAccessor() [4/7]

◆ DoFAccessor() [5/7]

◆ DoFAccessor() [6/7]

◆ DoFAccessor() [7/7]

◆ ~DoFAccessor()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ get_dof_handler()

◆ copy_from() [1/3]

◆ copy_from() [2/3]

◆ child() [1/2]

◆ line() [1/2]

◆ quad() [1/2]

◆ get_dof_indices()

◆ get_mg_dof_indices()

◆ vertex_dof_index()

◆ dof_index()

◆ n_active_fe_indices()

◆ nth_active_fe_index()

◆ fe_index_is_active()

◆ get_fe()

◆ operator==() [1/2]

◆ operator!=() [1/2]

◆ set_dof_handler()

◆ set_dof_index()

◆ copy_from() [3/3]

◆ state()

◆ level()

◆ index()

◆ get_triangulation()

◆ operator++()

◆ operator--()

◆ operator==() [2/2]

◆ operator!=() [2/2]

◆ operator<()

◆ vertex_index()

◆ vertex()

◆ center()

◆ line() [2/2]

◆ line_index()

◆ quad() [2/2]

◆ quad_index()

◆ at_boundary()

◆ boundary_id()

◆ get_manifold()

◆ manifold_id()

◆ user_flag_set()

◆ set_user_flag()

◆ clear_user_flag()

◆ recursively_set_user_flag()

◆ recursively_clear_user_flag()

◆ clear_user_data()

◆ set_user_pointer()

◆ clear_user_pointer()

◆ user_pointer()

◆ recursively_set_user_pointer()

◆ recursively_clear_user_pointer()

◆ set_user_index()

◆ clear_user_index()

◆ user_index()

◆ recursively_set_user_index()