Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes

TriaAccessor< 0, 1, spacedim > Class Template Reference

Inheritance diagram for TriaAccessor< 0, 1, spacedim >:
Inheritance graph
[legend]

List of all members.

Public Types

enum  VertexKind
typedef void AccessorData

Public Member Functions

 TriaAccessor (const Triangulation< 1, spacedim > *tria, const VertexKind vertex_kind, const unsigned int vertex_index)
 TriaAccessor (const Triangulation< 1, spacedim > *=0, const int=0, const int=0, const AccessorData *=0)
template<int structdim2, int dim2, int spacedim2>
 TriaAccessor (const TriaAccessor< structdim2, dim2, spacedim2 > &)
template<int structdim2, int dim2, int spacedim2>
 TriaAccessor (const InvalidAccessor< structdim2, dim2, spacedim2 > &)
void copy_from (const TriaAccessor &)
int index () const
bool at_boundary () const
types::boundary_id_t boundary_indicator () const
Advancement of iterators
void operator++ () const
void operator-- () const
bool operator== (const TriaAccessor &) const
bool operator!= (const TriaAccessor &) const

Static Public Member Functions

static
IteratorState::IteratorStates 
state ()
static int level ()
static int parent_index ()
Orientation of sub-objects
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 bool line_orientation (const unsigned int line)
 Always return false.

Static Public Attributes

static const unsigned int space_dimension = spacedim
static const unsigned int dimension = 1
static const unsigned int structure_dimension = 0

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
internal::Triangulation::Iterators
< 1, spacedim >::line_iterator 
line (const unsigned int)
static unsigned int line_index (const unsigned int i)
static
internal::Triangulation::Iterators
< 1, spacedim >::quad_iterator 
quad (const unsigned int i)
static unsigned int quad_index (const unsigned int i)

Accessing children

const Triangulation
< 1, spacedim > * 
tria
VertexKind vertex_kind
unsigned int global_vertex_index
void set_boundary_indicator (const types::boundary_id_t)
void set_all_boundary_indicators (const types::boundary_id_t)
bool used () const
static bool has_children ()
static unsigned int n_children ()
static unsigned int number_of_children ()
static unsigned int max_refinement_depth ()
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.

Detailed Description

template<int spacedim>
class TriaAccessor< 0, 1, spacedim >

A class that represents an access to a face in 1d -- i.e. to a point. This is not a full fledged access from which you can build an iterator: for example, you can't iterate from one such point to the next. Point also don't have children, and they don't have neighbors.

Author:
Wolfgang Bangerth, 2010

Definition at line 1629 of file tria_accessor.h.


Member Typedef Documentation

template<int spacedim>
typedef void TriaAccessor< 0, 1, spacedim >::AccessorData

Pointer to internal data.

Reimplemented in DoFAccessor< 0, DH< 1, spacedim > >.

Definition at line 1671 of file tria_accessor.h.


Member Enumeration Documentation

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

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

Definition at line 1679 of file tria_accessor.h.


Constructor & Destructor Documentation

template<int spacedim>
TriaAccessor< 0, 1, spacedim >::TriaAccessor ( const Triangulation< 1, spacedim > *  tria,
const VertexKind  vertex_kind,
const unsigned int  vertex_index 
)

Constructor.

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.

template<int spacedim>
TriaAccessor< 0, 1, spacedim >::TriaAccessor ( const Triangulation< 1, spacedim > *  = 0,
const int  = 0,
const int  = 0,
const AccessorData = 0 
)

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.

template<int spacedim>
template<int structdim2, int dim2, int spacedim2>
TriaAccessor< 0, 1, spacedim >::TriaAccessor ( const TriaAccessor< structdim2, dim2, spacedim2 > &  )

Constructor. Should never be called and thus produces an error.

template<int spacedim>
template<int structdim2, int dim2, int spacedim2>
TriaAccessor< 0, 1, spacedim >::TriaAccessor ( const InvalidAccessor< structdim2, dim2, spacedim2 > &  )

Constructor. Should never be called and thus produces an error.


Member Function Documentation

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

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.

template<int spacedim>
static IteratorState::IteratorStates TriaAccessor< 0, 1, spacedim >::state ( ) [static]

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.

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

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

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

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

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

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

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

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

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

Compare for equality.

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

Compare for inequality.

template<int spacedim>
static int TriaAccessor< 0, 1, spacedim >::parent_index ( ) [static]

Index of the parent. You can't do this for points.

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

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.

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

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.

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

Return the center of this object, which of course co-incides with the location of the vertex this object refers to.

template<int spacedim>
static internal::Triangulation::Iterators<1,spacedim>::line_iterator TriaAccessor< 0, 1, spacedim >::line ( const unsigned  int) [static]

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

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

Line index of the ith line bounding this object.

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

template<int spacedim>
static internal::Triangulation::Iterators<1,spacedim>::quad_iterator TriaAccessor< 0, 1, spacedim >::quad ( const unsigned int  i) [static]

Pointer to the ith quad bounding this object.

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

Quad index of the ith quad bounding this object.

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

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

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

template<int spacedim>
types::boundary_id_t TriaAccessor< 0, 1, spacedim >::boundary_indicator ( ) const

Boundary indicator of this object. The convention for one dimensional triangulations is that left end vertices have boundary indicator zero, and right end vertices have boundary indicator one.

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

template<int spacedim>
static bool TriaAccessor< 0, 1, spacedim >::has_children ( ) [static]

Test whether the object has children. Always false.

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

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

template<int spacedim>
static unsigned int TriaAccessor< 0, 1, spacedim >::number_of_children ( ) [static]

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

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

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

template<int spacedim>
static RefinementCase<0> TriaAccessor< 0, 1, spacedim >::refinement_case ( ) [static]

Always return no refinement.

template<int spacedim>
void TriaAccessor< 0, 1, spacedim >::set_boundary_indicator ( const types::boundary_id_t  )

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

Warning:
You should never set the boundary indicator of an interior face (a face not at the boundary of the domain), or set set the boundary indicator of an exterior face to types::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 types::internal_face_boundary_id or if interior cells have boundary indicators other than types::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.
template<int spacedim>
void TriaAccessor< 0, 1, spacedim >::set_all_boundary_indicators ( const types::boundary_id_t  )

Since this object only represents a single vertex, call set_boundary_indicator with the same argument.

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

Return whether the vertex pointed to here is used.


Member Data Documentation

template<int spacedim>
const unsigned int TriaAccessor< 0, 1, spacedim >::space_dimension = spacedim [static]

Dimension of the space the object represented by this accessor lives in. For example, if this accessor represents a quad that is part of a two-dimensional surface in four-dimensional space, then this value is four.

Reimplemented in DoFAccessor< 0, DH< 1, spacedim > >.

Definition at line 1643 of file tria_accessor.h.

template<int spacedim>
const unsigned int TriaAccessor< 0, 1, spacedim >::dimension = 1 [static]

Dimensionality of the object that the thing represented by this accessopr is part of. For example, if this accessor represents a line that is part of a hexahedron, then this value will be three.

Reimplemented in DoFAccessor< 0, DH< 1, spacedim > >.

Definition at line 1654 of file tria_accessor.h.

template<int spacedim>
const unsigned int TriaAccessor< 0, 1, spacedim >::structure_dimension = 0 [static]

Dimensionality of the current object represented by this accessor. For example, if it is line (irrespective of whether it is part of a quad or hex, and what dimension we are in), then this value equals 1.

Definition at line 1666 of file tria_accessor.h.

template<int spacedim>
const Triangulation<1,spacedim>* TriaAccessor< 0, 1, spacedim >::tria [protected]

Pointer to the triangulation we operate on.

Definition at line 2080 of file tria_accessor.h.

template<int spacedim>
VertexKind TriaAccessor< 0, 1, spacedim >::vertex_kind [protected]

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

template<int spacedim>
unsigned int TriaAccessor< 0, 1, spacedim >::global_vertex_index [protected]

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

Definition at line 2096 of file tria_accessor.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Mon May 21 2012 12:06:34 by doxygen 1.7.3