Reference documentation for deal.II version Git 32ab9f15fd 2020-11-24 23:04:10 -0500
\(\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\}}\)
Typedefs
types Namespace Reference

Typedefs

using subdomain_id = unsigned int
 
using global_vertex_index = uint64_t
 
using global_dof_index = unsigned int
 
using global_cell_index = unsigned int
 
using coarse_cell_id = global_cell_index
 
using boundary_id = unsigned int
 
using manifold_id = unsigned int
 
using material_id = unsigned int
 
using geometric_entity_type = std::uint8_t
 
using blas_int = int
 
using suitesparse_index = long int
 
using particle_index = unsigned int
 

Detailed Description

A namespace in which we declare alias for types used in deal.II, as well as special values for these types.

Typedef Documentation

◆ subdomain_id

using types::subdomain_id = typedef unsigned int

The type used to denote subdomain_ids of cells.

See the glossary for more information.

There is a special value, numbers::invalid_subdomain_id that is used to indicate an invalid value of this type.

Definition at line 43 of file types.h.

◆ global_vertex_index

using types::global_vertex_index = typedef uint64_t

The type used for global indices of vertices.

Definition at line 48 of file types.h.

◆ global_dof_index

using types::global_dof_index = typedef unsigned int

The type used to denote the global index of degrees of freedom. This type is then also used for querying the global number of degrees of freedom, since the number is simply the largest index plus one.

While in sequential computations the 4 billion indices of 32-bit unsigned integers is plenty, parallel computations using (for example) the parallel::distributed::Triangulation class can overflow this number and consequently, deal.II chooses a larger integer type when configured to use 64-bit indices.

The data type always corresponds to an unsigned integer type.

See the When to use types::global_dof_index instead of unsigned int page for guidance on when this type should or should not be used.

Definition at line 76 of file types.h.

◆ global_cell_index

using types::global_cell_index = typedef unsigned int

The type used to denote the global index of a cell. This type is then also used for querying the global number of cells in a triangulation since the number is simply the largest index plus one.

While in sequential computations the 4 billion indices of 32-bit unsigned integers is plenty, parallel computations using (for example) the parallel::distributed::Triangulation class can overflow this number and consequently, deal.II chooses a larger integer type when configured to use 64-bit indices.

The data type always corresponds to an unsigned integer type.

Definition at line 105 of file types.h.

◆ coarse_cell_id

The type used for coarse-cell ids. See the glossary entry on coarse cell IDs for more information.

Definition at line 114 of file types.h.

◆ boundary_id

using types::boundary_id = typedef unsigned int

The type used to denote boundary indicators associated with every piece of the boundary and, in the case of meshes that describe manifolds in higher dimensions, associated with every cell.

There is a special value, numbers::internal_face_boundary_id that is used to indicate an invalid value of this type and that is used as the boundary indicator for faces that are in the interior of the domain and therefore not part of any addressable boundary component.

See also
Glossary entry on boundary indicators

Definition at line 129 of file types.h.

◆ manifold_id

using types::manifold_id = typedef unsigned int

The type used to denote manifold indicators associated with every object of the mesh.

There is a special value, numbers::flat_manifold_id that is used to indicate the standard cartesian manifold.

See also
Glossary entry on manifold indicators

Definition at line 141 of file types.h.

◆ material_id

using types::material_id = typedef unsigned int

The type used to denote material indicators associated with every cell.

There is a special value, numbers::invalid_material_id that is used to indicate an invalid value of this type.

See also
Glossary entry on material indicators

Definition at line 152 of file types.h.

◆ geometric_entity_type

using types::geometric_entity_type = typedef std::uint8_t

The type used to denote geometric entity types.

Definition at line 157 of file types.h.

◆ blas_int

using types::blas_int = typedef int

Integer type in BLAS.

Definition at line 37 of file lapack_support.h.

◆ suitesparse_index

using types::suitesparse_index = typedef long int

Index type for UMFPACK. SuiteSparse_long has to be used here for the Windows 64 build.

Definition at line 45 of file sparse_direct.h.

◆ particle_index

using types::particle_index = typedef unsigned int

The type used for indices of particles. While in sequential computations the 4 billion indices of 32-bit unsigned integers is plenty, parallel computations using hundreds of processes can overflow this number and we need a bigger index space. We here utilize the same build variable that controls the dof indices because the number of degrees of freedom and the number of particles are typically on the same order of magnitude.

The data type always indicates an unsigned integer type.

Definition at line 69 of file particle.h.