internal::TriangulationImplementation::TriaObjects Class Reference

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

Detailed Description

General template for information belonging to the geometrical objects of a triangulation, i.e. lines, quads, hexahedra... Apart from the vector of objects additional information is included, namely vectors indicating the children, the used-status, user-flags, material-ids..

Objects of these classes are included in the TriaLevel and TriaFaces classes.

Definition at line 50 of file tria_objects.h.

Classes
struct	BoundaryOrMaterialId
struct	UserData

Public Types
enum	UserDataType { data_unknown , data_pointer , data_index }

Public Member Functions
	TriaObjects ()
	TriaObjects (const unsigned int structdim, const unsigned int children_per_object, const unsigned int faces_per_object)
void	allocate (const std::size_t n_objects)
void	allocate_end (const std::size_t new_objects_in_pairs, const std::size_t new_objects_single)
std::size_t	n_objects () const
int	get_bounding_object (const int index, const unsigned int face_no) const
void	set_bounding_object (const int index, const unsigned int face_no, const int neighbor_index)
ArrayView< int >	get_bounding_object_indices (const unsigned int index)
template<int structdim, int dim, int spacedim>
::TriaRawIterator<::TriaAccessor< structdim, dim, spacedim > >	next_free_single_object (const Triangulation< dim, spacedim > &tria)
template<int structdim, int dim, int spacedim>
::TriaRawIterator<::TriaAccessor< structdim, dim, spacedim > >	next_free_pair_object (const Triangulation< dim, spacedim > &tria)
template<int dim, int spacedim>
Triangulation< dim, spacedim >::raw_hex_iterator	next_free_hex (const Triangulation< dim, spacedim > &tria, const unsigned int level)
void *&	user_pointer (const unsigned int i)
const void *	user_pointer (const unsigned int i) const
unsigned int &	user_index (const unsigned int i)
unsigned int	user_index (const unsigned int i) const
void	clear_user_data (const unsigned int i)
void	clear_user_data ()
void	clear_user_flags ()
std::size_t	memory_consumption () const
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
template<int structdim_, int dim, int spacedim>
::TriaRawIterator<::TriaAccessor< structdim_, dim, spacedim > >	next_free_single_object (const Triangulation< dim, spacedim > &tria)
template<int structdim_, int dim, int spacedim>
::TriaRawIterator<::TriaAccessor< structdim_, dim, spacedim > >	next_free_pair_object (const Triangulation< dim, spacedim > &tria)
template<int dim, int spacedim>
typename::Triangulation< dim, spacedim >::raw_hex_iterator	next_free_hex (const ::Triangulation< dim, spacedim > &tria, const unsigned int level)

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

Public Attributes
unsigned int	structdim
unsigned int	children_per_object
unsigned int	faces_per_object
std::vector< int >	children
std::vector< std::uint8_t >	refinement_cases
std::vector< bool >	used
std::vector< bool >	user_flags
std::vector< BoundaryOrMaterialId >	boundary_or_material_id
std::vector< types::manifold_id >	manifold_id
unsigned int	next_free_single
unsigned int	next_free_pair
bool	reverse_order_next_free_single
std::vector< UserData >	user_data
UserDataType	user_data_type

Private Attributes
std::vector< int >	bounding_objects

Member Enumeration Documentation

UserDataType

enum internal::TriangulationImplementation::TriaObjects::UserDataType

Enum describing the possible types of userdata.

Enumerator
data_unknown	No userdata used yet.
data_pointer	UserData contains pointers.
data_index	UserData contains indices.

Definition at line 405 of file tria_objects.h.

Constructor & Destructor Documentation

TriaObjects() [1/2]

internal::TriangulationImplementation::TriaObjects::TriaObjects ( )

inline

Default constructor. Needed for serialization.

Definition at line 575 of file tria_objects.h.

TriaObjects() [2/2]

internal::TriangulationImplementation::TriaObjects::TriaObjects ( const unsigned int  structdim, const unsigned int  children_per_object, const unsigned int  faces_per_object  )

inline

Constructor for a specific dimension.

Parameters

[in]	structdim	The dimension of the structures which this object stores: e.g., TriaFaces::lines has structdim == 1.
[in]	children_per_object	Number of children to store for each object.
[in]	faces_per_object	Number of faces (i.e., neighbors) to store for each object.

Definition at line 586 of file tria_objects.h.

Member Function Documentation

allocate()

void internal::TriangulationImplementation::TriaObjects::allocate

(

const std::size_t

n_objects

)

Resize all internal arrays and populate with default values.

Parameters

[in]

n_objects

Total number of objects this object should store.

Definition at line 64 of file tria_objects.cc.

allocate_end()

void internal::TriangulationImplementation::TriaObjects::allocate_end	(	const std::size_t	new_objects_in_pairs,
		const std::size_t	new_objects_single
	)

Allocate space at the end of each array for new objects and populate the new values with default values.

Parameters

[in]	new_objects_in_pairs	Number of new objects which should be added as pairs.
[in]	new_objects_single	Number of new objects which should be added alone (i.e., not in pairs). For example, in 2d refined lines have to be stored in pairs, whereas new lines in the interior of refined cells can be stored as single lines.

Definition at line 97 of file tria_objects.cc.

n_objects()

std::size_t internal::TriangulationImplementation::TriaObjects::n_objects ( ) const

inline

Return number of geometric objects stored by this class.

Definition at line 445 of file tria_objects.h.

get_bounding_object()

int internal::TriangulationImplementation::TriaObjects::get_bounding_object ( const int  index, const unsigned int  face_no  ) const

inline

Return the index of the bounding object of index on face face_no.

Definition at line 457 of file tria_objects.h.

set_bounding_object()

void internal::TriangulationImplementation::TriaObjects::set_bounding_object ( const int  index, const unsigned int  face_no, const int  neighbor_index  )

inline

Set the index of the bounding object of index on face face_no to neighbor_index.

Definition at line 471 of file tria_objects.h.

get_bounding_object_indices()

ArrayView< int > internal::TriangulationImplementation::TriaObjects::get_bounding_object_indices ( const unsigned int  index )

inline

Return a view on the indices of the objects that bound the index-th object stored by the current object. For example, if the current object stores cells, then this function returns the equivalent of an array containing the indices of the faces that bound the index-th cell.

Definition at line 487 of file tria_objects.h.

next_free_single_object() [1/2]

template<int structdim, int dim, int spacedim>

::TriaRawIterator<::TriaAccessor< structdim, dim, spacedim > > internal::TriangulationImplementation::TriaObjects::next_free_single_object

(

const Triangulation< dim, spacedim > &

tria

)

Return an iterator to the next free slot for a single object. This function is only used by Triangulation::execute_refinement() in 3d.

Warning

Interestingly, this function is not used for 1d or 2d triangulations, where it seems the authors of the refinement function insist on reimplementing its contents.

Todo:

This function is not instantiated for the codim-one case

next_free_pair_object() [1/2]

template<int structdim, int dim, int spacedim>

::TriaRawIterator<::TriaAccessor< structdim, dim, spacedim > > internal::TriangulationImplementation::TriaObjects::next_free_pair_object

(

const Triangulation< dim, spacedim > &

tria

)

Return an iterator to the next free slot for a pair of objects. This function is only used by Triangulation::execute_refinement() in 3d.

Warning

Interestingly, this function is not used for 1d or 2d triangulations, where it seems the authors of the refinement function insist on reimplementing its contents.

Todo:

This function is not instantiated for the codim-one case

next_free_hex() [1/2]

template<int dim, int spacedim>

Triangulation< dim, spacedim >::raw_hex_iterator internal::TriangulationImplementation::TriaObjects::next_free_hex	(	const Triangulation< dim, spacedim > &	tria,
		const unsigned int	level
	)

Return an iterator to the next free slot for a pair of hexes. Only implemented for G=Hexahedron.

user_pointer() [1/2]

void *& internal::TriangulationImplementation::TriaObjects::user_pointer ( const unsigned int  i )

inline

Access to user pointers.

Definition at line 532 of file tria_objects.h.

user_pointer() [2/2]

const void * internal::TriangulationImplementation::TriaObjects::user_pointer ( const unsigned int  i ) const

inline

Read-only access to user pointers.

Definition at line 544 of file tria_objects.h.

user_index() [1/2]

unsigned int & internal::TriangulationImplementation::TriaObjects::user_index ( const unsigned int  i )

inline

Access to user indices.

Definition at line 556 of file tria_objects.h.

user_index() [2/2]

unsigned int internal::TriangulationImplementation::TriaObjects::user_index ( const unsigned int  i ) const

inline

Read-only access to user pointers.

Definition at line 600 of file tria_objects.h.

clear_user_data() [1/2]

void internal::TriangulationImplementation::TriaObjects::clear_user_data ( const unsigned int  i )

inline

Reset user data to zero.

Definition at line 568 of file tria_objects.h.

clear_user_data() [2/2]

void internal::TriangulationImplementation::TriaObjects::clear_user_data ( )

inline

Clear all user pointers or indices and reset their type, such that the next access may be either or.

Definition at line 612 of file tria_objects.h.

clear_user_flags()

void internal::TriangulationImplementation::TriaObjects::clear_user_flags ( )

inline

Clear all user flags.

Definition at line 621 of file tria_objects.h.

memory_consumption()

std::size_t internal::TriangulationImplementation::TriaObjects::memory_consumption

(

)

const

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 260 of file tria_objects.cc.

serialize()

template<class Archive >

void internal::TriangulationImplementation::TriaObjects::serialize	(	Archive &	ar,
		const unsigned int	version
	)

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

Definition at line 639 of file tria_objects.h.

next_free_single_object() [2/2]

template<int structdim_, int dim, int spacedim>

::TriaRawIterator<::TriaAccessor< structdim_, dim, spacedim > > internal::TriangulationImplementation::TriaObjects::next_free_single_object

(

const Triangulation< dim, spacedim > &

tria

)

Definition at line 659 of file tria_objects.h.

next_free_pair_object() [2/2]

template<int structdim_, int dim, int spacedim>

::TriaRawIterator<::TriaAccessor< structdim_, dim, spacedim > > internal::TriangulationImplementation::TriaObjects::next_free_pair_object

(

const Triangulation< dim, spacedim > &

tria

)

Definition at line 713 of file tria_objects.h.

next_free_hex() [2/2]

template<int dim, int spacedim>

typename::Triangulation< dim, spacedim >::raw_hex_iterator internal::TriangulationImplementation::TriaObjects::next_free_hex	(	const ::Triangulation< dim, spacedim > &	tria,
		const unsigned int	level
	)

Definition at line 33 of file tria_objects.cc.

Member Data Documentation

structdim

unsigned int internal::TriangulationImplementation::TriaObjects::structdim

The dimension of the structures which this object stores.

Definition at line 102 of file tria_objects.h.

children_per_object

unsigned int internal::TriangulationImplementation::TriaObjects::children_per_object

The number of children stored per object. In practice, to support mixed meshes, this is the maximum number of children per ReferenceCell across all relevant ReferenceCell types used by the Triangulation.

Definition at line 109 of file tria_objects.h.

faces_per_object

unsigned int internal::TriangulationImplementation::TriaObjects::faces_per_object

The number of faces (i.e., neighbors) stored per object. Like children_per_object, this is typically the maximum value across all relevant ReferenceCell types.

Definition at line 116 of file tria_objects.h.

children

std::vector<int> internal::TriangulationImplementation::TriaObjects::children

Index of the even children (index 0, 2, 4, ...) of an object. Since when objects are refined, all children are created at the same time, they are appended to the list at least in pairs after each other. We therefore only store the index of the even children, the uneven follow immediately afterwards.

If an object has no children, -1 is stored in this list. An object is called active if it has no children. The function TriaAccessorBase::has_children() tests for this.

Definition at line 160 of file tria_objects.h.

refinement_cases

std::vector<std::uint8_t> internal::TriangulationImplementation::TriaObjects::refinement_cases

Store the refinement case each of the cells is refined with. This vector might be replaced by vector<vector<bool> > (dim, vector<bool> (n_cells)) which is more memory efficient.

Definition at line 167 of file tria_objects.h.

used

std::vector<bool> internal::TriangulationImplementation::TriaObjects::used

Vector storing whether an object is used in the cells vector.

Since it is difficult to delete elements in a vector, when an element is not needed any more (e.g. after derefinement), it is not deleted from the list, but rather the according used flag is set to false.

Definition at line 177 of file tria_objects.h.

user_flags

std::vector<bool> internal::TriangulationImplementation::TriaObjects::user_flags

Make available a field for user data, one bit per object. This field is usually used when an operation runs over all cells and needs information whether another cell (e.g. a neighbor) has already been processed.

You can clear all used flags using Triangulation::clear_user_flags().

Definition at line 188 of file tria_objects.h.

boundary_or_material_id

std::vector<BoundaryOrMaterialId> internal::TriangulationImplementation::TriaObjects::boundary_or_material_id

Store boundary and material data. For example, in one dimension, this field stores the material id of a line, which is a number between 0 and numbers::invalid_material_id-1. In more than one dimension, lines have no material id, but they may be at the boundary; then, we store the boundary indicator in this field, which denotes to which part of the boundary this line belongs and which boundary conditions hold on this part. The boundary indicator also is a number between zero and numbers::internal_face_boundary_id-1; the id numbers::internal_face_boundary_id is reserved for lines in the interior and may be used to check whether a line is at the boundary or not, which otherwise is not possible if you don't know which cell it belongs to.

Definition at line 239 of file tria_objects.h.

manifold_id

std::vector<types::manifold_id> internal::TriangulationImplementation::TriaObjects::manifold_id

Store manifold ids. This field stores the manifold id of each object, which is a number between 0 and numbers::flat_manifold_id-1.

Definition at line 245 of file tria_objects.h.

next_free_single

unsigned int internal::TriangulationImplementation::TriaObjects::next_free_single

Counter for next_free_single_* functions

Definition at line 357 of file tria_objects.h.

next_free_pair

unsigned int internal::TriangulationImplementation::TriaObjects::next_free_pair

Counter for next_free_pair_* functions

Definition at line 362 of file tria_objects.h.

reverse_order_next_free_single

bool internal::TriangulationImplementation::TriaObjects::reverse_order_next_free_single

Bool flag for next_free_single_* functions

Definition at line 367 of file tria_objects.h.

user_data

std::vector<UserData> internal::TriangulationImplementation::TriaObjects::user_data

Pointer which is not used by the library but may be accessed and set by the user to handle data local to a line/quad/etc.

Definition at line 420 of file tria_objects.h.

user_data_type

UserDataType internal::TriangulationImplementation::TriaObjects::user_data_type

mutable

In order to avoid confusion between user pointers and indices, this enum is set by the first function accessing either and subsequent access will not be allowed to change the type of data accessed.

Definition at line 427 of file tria_objects.h.

bounding_objects

std::vector<int> internal::TriangulationImplementation::TriaObjects::bounding_objects

private

Vector of the objects bounding each cell in this level. This is typically accessed via get_bounding_object_indices().

Note

In this context, "bounding_objects" means "geometric entities bounded by other geometric entities": for example, TriaFaces::quads stores quads (structdim 2 objects) which are bounded by lines.

Definition at line 438 of file tria_objects.h.

---

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

• include/deal.II/grid/tria_objects.h
• source/grid/tria_objects.cc