#include <deal.II/distributed/tria_base.h>

Inheritance diagram for parallel::DistributedTriangulationBase< dim, spacedim >:

Classes
struct	CellAttachedData

class	DataTransfer

Public Types
using	cell_iterator = typename ::Triangulation< dim, spacedim >::cell_iterator

using	CellStatus = typename ::Triangulation< dim, spacedim >::CellStatus

enum	MeshSmoothing { none = 0x0 , limit_level_difference_at_vertices = 0x1 , eliminate_unrefined_islands = 0x2 , patch_level_1 = 0x4 , coarsest_level_1 = 0x8 , allow_anisotropic_smoothing = 0x10 , eliminate_refined_inner_islands = 0x100 , eliminate_refined_boundary_islands = 0x200 , do_not_produce_unrefined_islands = 0x400 , smoothing_on_refinement , smoothing_on_coarsening , maximum_smoothing = 0xffff ^ allow_anisotropic_smoothing }

using	level_cell_iterator = cell_iterator

using	active_cell_iterator = TriaActiveIterator< CellAccessor< dim, spacedim > >

using	face_iterator = TriaIterator< TriaAccessor< dim - 1, dim, spacedim > >

using	active_face_iterator = TriaActiveIterator< TriaAccessor< dim - 1, dim, spacedim > >

using	vertex_iterator = TriaIterator<::TriaAccessor< 0, dim, spacedim > >

using	active_vertex_iterator = TriaActiveIterator<::TriaAccessor< 0, dim, spacedim > >

using	line_iterator = typename IteratorSelector::line_iterator

using	active_line_iterator = typename IteratorSelector::active_line_iterator

using	quad_iterator = typename IteratorSelector::quad_iterator

using	active_quad_iterator = typename IteratorSelector::active_quad_iterator

using	hex_iterator = typename IteratorSelector::hex_iterator

using	active_hex_iterator = typename IteratorSelector::active_hex_iterator

Public Member Functions
	DistributedTriangulationBase (const MPI_Comm mpi_communicator, const typename ::Triangulation< dim, spacedim >::MeshSmoothing smooth_grid=(::Triangulation< dim, spacedim >::none), const bool check_for_distorted_cells=false)

virtual void	clear () override

virtual bool	has_hanging_nodes () const override

virtual void	save (const std::string &filename) const =0

virtual void	load (const std::string &filename)=0

virtual void	load (const std::string &filename, const bool autopartition)=0

unsigned int	register_data_attach (const std::function< std::vector< char >(const cell_iterator &, const CellStatus)> &pack_callback, const bool returns_variable_size_data)

void	notify_ready_to_unpack (const unsigned int handle, const std::function< void(const cell_iterator &, const CellStatus, const boost::iterator_range< std::vector< char >::const_iterator > &)> &unpack_callback)

virtual MPI_Comm	get_communicator () const override

virtual bool	is_multilevel_hierarchy_constructed () const =0

virtual void	copy_triangulation (const ::Triangulation< dim, spacedim > &old_tria) override

virtual void	copy_triangulation (const Triangulation< dim, spacedim > &other_tria)

unsigned int	n_locally_owned_active_cells () const

virtual types::global_cell_index	n_global_active_cells () const override

virtual std::size_t	memory_consumption () const override

virtual unsigned int	n_global_levels () const override

types::subdomain_id	locally_owned_subdomain () const override

const std::set< types::subdomain_id > &	ghost_owners () const

const std::set< types::subdomain_id > &	level_ghost_owners () const

const std::weak_ptr< const Utilities::MPI::Partitioner >	global_active_cell_index_partitioner () const override

const std::weak_ptr< const Utilities::MPI::Partitioner >	global_level_cell_index_partitioner (const unsigned int level) const override

virtual std::vector< types::boundary_id >	get_boundary_ids () const override

virtual std::vector< types::manifold_id >	get_manifold_ids () const override

void	communicate_locally_moved_vertices (const std::vector< bool > &vertex_locally_moved)

virtual types::coarse_cell_id	n_global_coarse_cells () const override

virtual void	set_mesh_smoothing (const MeshSmoothing mesh_smoothing)

virtual const MeshSmoothing &	get_mesh_smoothing () const

void	set_manifold (const types::manifold_id number, const Manifold< dim, spacedim > &manifold_object)

void	reset_manifold (const types::manifold_id manifold_number)

void	reset_all_manifolds ()

void	set_all_manifold_ids (const types::manifold_id number)

void	set_all_manifold_ids_on_boundary (const types::manifold_id number)

void	set_all_manifold_ids_on_boundary (const types::boundary_id b_id, const types::manifold_id number)

const Manifold< dim, spacedim > &	get_manifold (const types::manifold_id number) const

virtual void	create_triangulation (const std::vector< Point< spacedim > > &vertices, const std::vector< CellData< dim > > &cells, const SubCellData &subcelldata)

virtual void	create_triangulation (const TriangulationDescription::Description< dim, spacedim > &construction_data)

virtual void	create_triangulation_compatibility (const std::vector< Point< spacedim > > &vertices, const std::vector< CellData< dim > > &cells, const SubCellData &subcelldata)

void	flip_all_direction_flags ()

bool	prepare_coarsening_and_refinement ()

bool	prepare_coarsening_and_refinement ()

bool	prepare_coarsening_and_refinement ()

unsigned int	n_quads () const

unsigned int	n_quads (const unsigned int) const

unsigned int	n_quads () const

unsigned int	n_quads (const unsigned int) const

unsigned int	n_quads () const

unsigned int	n_quads (const unsigned int) const

unsigned int	n_active_quads (const unsigned int) const

unsigned int	n_active_quads () const

unsigned int	n_active_quads (const unsigned int) const

unsigned int	n_active_quads () const

unsigned int	n_active_quads (const unsigned int) const

unsigned int	n_active_quads () const

unsigned int	n_hexs () const

unsigned int	n_hexs (const unsigned int level) const

unsigned int	n_active_hexs () const

unsigned int	n_active_hexs (const unsigned int level) const

unsigned int	max_adjacent_cells () const

unsigned int	max_adjacent_cells () const

unsigned int	max_adjacent_cells () const

unsigned int	n_raw_quads (const unsigned int) const

unsigned int	n_raw_quads (const unsigned int) const

unsigned int	n_raw_quads (const unsigned int) const

unsigned int	n_raw_quads (const unsigned int level) const

unsigned int	n_raw_quads (const unsigned int level) const

unsigned int	n_raw_quads (const unsigned int) const

unsigned int	n_raw_quads () const

unsigned int	n_raw_hexs (const unsigned int) const

unsigned int	n_raw_hexs (const unsigned int) const

unsigned int	n_raw_hexs (const unsigned int) const

unsigned int	n_raw_hexs (const unsigned int level) const

Mesh refinement
void	set_all_refine_flags ()

void	refine_global (const unsigned int times=1)

void	coarsen_global (const unsigned int times=1)

virtual void	execute_coarsening_and_refinement ()

virtual bool	prepare_coarsening_and_refinement ()

History of a triangulation
void	save_refine_flags (std::ostream &out) const

void	save_refine_flags (std::vector< bool > &v) const

void	load_refine_flags (std::istream &in)

void	load_refine_flags (const std::vector< bool > &v)

void	save_coarsen_flags (std::ostream &out) const

void	save_coarsen_flags (std::vector< bool > &v) const

void	load_coarsen_flags (std::istream &out)

void	load_coarsen_flags (const std::vector< bool > &v)

bool	get_anisotropic_refinement_flag () const

User data
void	clear_user_flags ()

void	save_user_flags (std::ostream &out) const

void	save_user_flags (std::vector< bool > &v) const

void	load_user_flags (std::istream &in)

void	load_user_flags (const std::vector< bool > &v)

void	clear_user_flags_line ()

void	save_user_flags_line (std::ostream &out) const

void	save_user_flags_line (std::vector< bool > &v) const

void	load_user_flags_line (std::istream &in)

void	load_user_flags_line (const std::vector< bool > &v)

void	clear_user_flags_quad ()

void	save_user_flags_quad (std::ostream &out) const

void	save_user_flags_quad (std::vector< bool > &v) const

void	load_user_flags_quad (std::istream &in)

void	load_user_flags_quad (const std::vector< bool > &v)

void	clear_user_flags_hex ()

void	save_user_flags_hex (std::ostream &out) const

void	save_user_flags_hex (std::vector< bool > &v) const

void	load_user_flags_hex (std::istream &in)

void	load_user_flags_hex (const std::vector< bool > &v)

void	clear_user_data ()

void	save_user_indices (std::vector< unsigned int > &v) const

void	load_user_indices (const std::vector< unsigned int > &v)

void	save_user_pointers (std::vector< void * > &v) const

void	load_user_pointers (const std::vector< void * > &v)

void	save_user_indices_line (std::vector< unsigned int > &v) const

void	load_user_indices_line (const std::vector< unsigned int > &v)

void	save_user_indices_quad (std::vector< unsigned int > &v) const

void	load_user_indices_quad (const std::vector< unsigned int > &v)

void	save_user_indices_hex (std::vector< unsigned int > &v) const

void	load_user_indices_hex (const std::vector< unsigned int > &v)

void	save_user_pointers_line (std::vector< void * > &v) const

void	load_user_pointers_line (const std::vector< void * > &v)

void	save_user_pointers_quad (std::vector< void * > &v) const

void	load_user_pointers_quad (const std::vector< void * > &v)

void	save_user_pointers_hex (std::vector< void * > &v) const

void	load_user_pointers_hex (const std::vector< void * > &v)

Cell iterator functions
cell_iterator	begin (const unsigned int level=0) const

active_cell_iterator	begin_active (const unsigned int level=0) const

cell_iterator	end () const

cell_iterator	end (const unsigned int level) const

active_cell_iterator	end_active (const unsigned int level) const

cell_iterator	last () const

active_cell_iterator	last_active () const

cell_iterator	create_cell_iterator (const CellId &cell_id) const

Cell iterator functions returning ranges of iterators
IteratorRange< cell_iterator >	cell_iterators () const

IteratorRange< active_cell_iterator >	active_cell_iterators () const

IteratorRange< cell_iterator >	cell_iterators_on_level (const unsigned int level) const

IteratorRange< active_cell_iterator >	active_cell_iterators_on_level (const unsigned int level) const

Face iterator functions
face_iterator	begin_face () const

active_face_iterator	begin_active_face () const

face_iterator	end_face () const

IteratorRange< active_face_iterator >	active_face_iterators () const

Vertex iterator functions
vertex_iterator	begin_vertex () const

active_vertex_iterator	begin_active_vertex () const

vertex_iterator	end_vertex () const

Information about the triangulation
unsigned int	n_lines () const

unsigned int	n_lines (const unsigned int level) const

unsigned int	n_active_lines () const

unsigned int	n_active_lines (const unsigned int level) const

unsigned int	n_quads () const

unsigned int	n_quads (const unsigned int level) const

unsigned int	n_active_quads () const

unsigned int	n_active_quads (const unsigned int level) const

unsigned int	n_hexs () const

unsigned int	n_hexs (const unsigned int level) const

unsigned int	n_active_hexs () const

unsigned int	n_active_hexs (const unsigned int level) const

unsigned int	n_cells () const

unsigned int	n_cells (const unsigned int level) const

unsigned int	n_active_cells () const

unsigned int	n_active_cells (const unsigned int level) const

unsigned int	n_faces () const

unsigned int	n_active_faces () const

unsigned int	n_levels () const

unsigned int	n_vertices () const

const std::vector< Point< spacedim > > &	get_vertices () const

unsigned int	n_used_vertices () const

bool	vertex_used (const unsigned int index) const

const std::vector< bool > &	get_used_vertices () const

unsigned int	max_adjacent_cells () const

Triangulation< dim, spacedim > &	get_triangulation ()

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

Internal information about the number of objects
unsigned int	n_raw_lines () const

unsigned int	n_raw_lines (const unsigned int level) const

unsigned int	n_raw_quads () const

unsigned int	n_raw_quads (const unsigned int level) const

unsigned int	n_raw_hexs (const unsigned int level) const

unsigned int	n_raw_cells (const unsigned int level) const

unsigned int	n_raw_faces () const

template<class Archive >
void	save (Archive &ar, const unsigned int version) const

template<class Archive >
void	load (Archive &ar, const unsigned int version)

virtual void	add_periodicity (const std::vector< GridTools::PeriodicFacePair< cell_iterator > > &)

const std::map< std::pair< cell_iterator, unsigned int >, std::pair< std::pair< cell_iterator, unsigned int >, std::bitset< 3 > > > &	get_periodic_face_map () const

const std::vector< ReferenceCell > &	get_reference_cells () const

bool	all_reference_cells_are_hyper_cube () const

bool	all_reference_cells_are_simplex () const

bool	is_mixed_mesh () const

template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Subscriptor functionality
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.
void	subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void	unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int	n_subscriptions () const

template<typename StreamType >
void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Static Public Member Functions
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Public Attributes
Keeping up with what happens to a triangulation
Signals	signals

Static Public Attributes
static constexpr unsigned int	dimension = dim

static constexpr unsigned int	space_dimension = spacedim

Protected Types
using	cell_relation_t = typename std::pair< cell_iterator, CellStatus >

Protected Member Functions
void	save_attached_data (const unsigned int global_first_cell, const unsigned int global_num_cells, const std::string &filename) const

void	load_attached_data (const unsigned int global_first_cell, const unsigned int global_num_cells, const unsigned int local_num_cells, const std::string &filename, const unsigned int n_attached_deserialize_fixed, const unsigned int n_attached_deserialize_variable)

virtual void	update_cell_relations ()=0

virtual void	update_number_cache ()

void	update_reference_cells () override

void	reset_global_cell_indices ()

Protected Attributes
std::vector< cell_relation_t >	local_cell_relations

CellAttachedData	cell_attached_data

DataTransfer	data_transfer

const MPI_Comm	mpi_communicator

types::subdomain_id	my_subdomain

types::subdomain_id	n_subdomains

NumberCache	number_cache

Private Types
using	IteratorSelector = ::internal::TriangulationImplementation::Iterators< dim, spacedim >

using	map_value_type = decltype(counter_map)::value_type

using	map_iterator = decltype(counter_map)::iterator

Private Member Functions
void	check_no_subscribers () const noexcept

Line iterator functions for internal use
raw_line_iterator	begin_raw_line (const unsigned int level=0) const

line_iterator	begin_line (const unsigned int level=0) const

active_line_iterator	begin_active_line (const unsigned int level=0) const

line_iterator	end_line () const

Quad iterator functions for internal use
raw_quad_iterator	begin_raw_quad (const unsigned int level=0) const

quad_iterator	begin_quad (const unsigned int level=0) const

active_quad_iterator	begin_active_quad (const unsigned int level=0) const

quad_iterator	end_quad () const

Private Attributes
std::atomic< unsigned int >	counter

std::map< std::string, unsigned int >	counter_map

std::vector< std::atomic< bool > * >	validity_pointers

const std::type_info *	object_info

Static Private Attributes
static std::mutex	mutex

Exceptions
MeshSmoothing	smooth_grid

std::vector< ReferenceCell >	reference_cells

void	update_periodic_face_map ()

std::unique_ptr< ::internal::TriangulationImplementation::Policy< dim, spacedim > >	policy

std::vector< GridTools::PeriodicFacePair< cell_iterator > >	periodic_face_pairs_level_0

std::map< std::pair< cell_iterator, unsigned int >, std::pair< std::pair< cell_iterator, unsigned int >, std::bitset< 3 > > >	periodic_face_map

static ::ExceptionBase &	ExcInvalidLevel (int arg1, int arg2)

static ::ExceptionBase &	ExcTriangulationNotEmpty (int arg1, int arg2)

static ::ExceptionBase &	ExcGridReadError ()

static ::ExceptionBase &	ExcFacesHaveNoLevel ()

static ::ExceptionBase &	ExcEmptyLevel (int arg1)

static ::ExceptionBase &	ExcNonOrientableTriangulation ()

static ::ExceptionBase &	ExcBoundaryIdNotFound (types::boundary_id arg1)

static ::ExceptionBase &	ExcInconsistentCoarseningFlags ()

static void	write_bool_vector (const unsigned int magic_number1, const std::vector< bool > &v, const unsigned int magic_number2, std::ostream &out)

static void	read_bool_vector (const unsigned int magic_number1, std::vector< bool > &v, const unsigned int magic_number2, std::istream &in)

Cell iterator functions for internal use
using	raw_cell_iterator = TriaRawIterator< CellAccessor< dim, spacedim > >

using	raw_face_iterator = TriaRawIterator< TriaAccessor< dim - 1, dim, spacedim > >

using	raw_vertex_iterator = TriaRawIterator<::TriaAccessor< 0, dim, spacedim > >

using	raw_line_iterator = typename IteratorSelector::raw_line_iterator

using	raw_quad_iterator = typename IteratorSelector::raw_quad_iterator

using	raw_hex_iterator = typename IteratorSelector::raw_hex_iterator

raw_cell_iterator	begin_raw (const unsigned int level=0) const

raw_cell_iterator	end_raw (const unsigned int level) const

Hex iterator functions for internal use
std::vector< std::unique_ptr<::internal::TriangulationImplementation::TriaLevel > >	levels

std::unique_ptr<::internal::TriangulationImplementation::TriaFaces >	faces

std::vector< Point< spacedim > >	vertices

std::vector< bool >	vertices_used

std::map< types::manifold_id, std::unique_ptr< const Manifold< dim, spacedim > > >	manifolds

bool	anisotropic_refinement

const bool	check_for_distorted_cells

std::unique_ptr< std::map< unsigned int, types::boundary_id > >	vertex_to_boundary_id_map_1d

std::unique_ptr< std::map< unsigned int, types::manifold_id > >	vertex_to_manifold_id_map_1d

raw_hex_iterator	begin_raw_hex (const unsigned int level=0) const

hex_iterator	begin_hex (const unsigned int level=0) const

active_hex_iterator	begin_active_hex (const unsigned int level=0) const

hex_iterator	end_hex () const

void	clear_despite_subscriptions ()

void	reset_policy ()

void	reset_active_cell_indices ()

void	reset_cell_vertex_indices_cache ()

DistortedCellList	execute_refinement ()

void	execute_coarsening ()

void	fix_coarsen_flags ()

virtual unsigned int	coarse_cell_id_to_coarse_cell_index (const types::coarse_cell_id coarse_cell_id) const

virtual types::coarse_cell_id	coarse_cell_index_to_coarse_cell_id (const unsigned int coarse_cell_index) const

Detailed Description

template<int dim, int spacedim = dim>
class parallel::DistributedTriangulationBase< dim, spacedim >

A base class for distributed triangulations, i.e., triangulations that do not store all cells on all processors. This implies that not every detail of a triangulation may be known on each processor. In particular, you have to expect that triangulations of classes derived from this one only store some of the active cells (namely, the locally owned cells), along with ghost cells and possibly artificial cells. In contrast to the classes derived from parallel::TriangulationBase, it is certain that the classes derived from the current class will not store the entire triangulation as long as it has a large enough number of cells. (The difference to parallel::TriangulationBase is that the parallel::shared::Triangulation is derived from parallel::TriangulationBase, but not from the current class.) The distinction is not large in practice: Everything that is difficult for parallel distributed triangulation is generally also difficult for any other kind of parallel triangulation classes; however, this intermediate base class allows to further differentiate between the different kinds of classes providing parallel mesh functionality.

This class can, then, be used to test whether a pointer or reference to a triangulation object refers to any kind of parallel triangulation, or whether the triangulation is in fact parallel distributed. In other words, one could write a function like this:

template <int dim, int spacedim>
bool
is_parallel_distributed(const ::Triangulation<dim,spacedim> &tria)
{
  if(dynamic_cast<const
                  parallel::DistributedTriangulationBase<dim,spacedim>*>
                 (&tria)
     != nullptr)
    return true;
  else
    return false;
}

Note: This class, function, or variable is a template, and it can only be instantiated if the following condition is true:
(concepts::is_valid_dim_spacedim<dim, spacedim>)

concepts::is_valid_dim_spacedim
Definition template_constraints.h:720

If your compiler supports the C++20 standard, then this constraint will be enforced by a C++20 requires clause.

Definition at line 437 of file tria_base.h.

Member Typedef Documentation

◆ cell_iterator

template<int dim, int spacedim = dim>

using parallel::DistributedTriangulationBase< dim, spacedim >::cell_iterator = typename ::Triangulation<dim, spacedim>::cell_iterator

Definition at line 459 of file tria_base.h.

◆ CellStatus

template<int dim, int spacedim = dim>

using parallel::DistributedTriangulationBase< dim, spacedim >::CellStatus = typename ::Triangulation<dim, spacedim>::CellStatus

Definition at line 462 of file tria_base.h.

◆ cell_relation_t

template<int dim, int spacedim = dim>

using parallel::DistributedTriangulationBase< dim, spacedim >::cell_relation_t = typename std::pair<cell_iterator, CellStatus>

protected

Auxiliary data structure for assigning a CellStatus to a deal.II cell iterator. For an extensive description of the former, see the documentation for the member function register_data_attach().

Definition at line 728 of file tria_base.h.

◆ IteratorSelector

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::IteratorSelector = ::internal::TriangulationImplementation::Iterators<dim, spacedim>

privateinherited

An internal alias to make the definition of the iterator classes simpler.

Definition at line 1143 of file tria.h.

◆ level_cell_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::level_cell_iterator = cell_iterator

inherited

The same as above to allow the usage of the "MeshType concept" also on the refinement levels.

Definition at line 1376 of file tria.h.

◆ raw_cell_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::raw_cell_iterator = TriaRawIterator<CellAccessor<dim, spacedim> >

privateinherited

Declare a number of iterator types for raw iterators, i.e., iterators that also iterate over holes in the list of cells left by cells that have been coarsened away in previous mesh refinement cycles.

Since users should never have to access these internal properties of how we store data, these iterator types are made private.

Definition at line 3821 of file tria.h.

◆ raw_face_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::raw_face_iterator = TriaRawIterator<TriaAccessor<dim - 1, dim, spacedim> >

privateinherited

Definition at line 3822 of file tria.h.

◆ raw_vertex_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::raw_vertex_iterator = TriaRawIterator<::TriaAccessor<0, dim, spacedim> >

privateinherited

Definition at line 3824 of file tria.h.

◆ raw_line_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::raw_line_iterator = typename IteratorSelector::raw_line_iterator

privateinherited

Definition at line 3826 of file tria.h.

◆ raw_quad_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::raw_quad_iterator = typename IteratorSelector::raw_quad_iterator

privateinherited

Definition at line 3827 of file tria.h.

◆ raw_hex_iterator

template<int dim, int spacedim = dim>

using Triangulation< dim, spacedim >::raw_hex_iterator = typename IteratorSelector::raw_hex_iterator

privateinherited

Definition at line 3828 of file tria.h.

◆ map_value_type

using Subscriptor::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

◆ map_iterator

using Subscriptor::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

Member Enumeration Documentation

◆ MeshSmoothing

template<int dim, int spacedim = dim>

enum Triangulation::MeshSmoothing

inherited

Declare some symbolic names for mesh smoothing algorithms. The meaning of these flags is documented in the Triangulation class.

Enumerator
none	No mesh smoothing at all, except that meshes have to remain one- irregular.
limit_level_difference_at_vertices	It can be shown, that degradation of approximation occurs if the triangulation contains vertices which are member of cells with levels differing by more than one. One such example is the following: It would seem that in two space dimensions, the maximum jump in levels between cells sharing a common vertex is two (as in the example above). However, this is not true if more than four cells meet at a vertex. It is not uncommon that a coarse (initial) mesh contains vertices at which six or even eight cells meet, when small features of the domain have to be resolved even on the coarsest mesh. In that case, the maximum difference in levels is three or four, respectively. The problem gets even worse in three space dimensions. Looking at an interpolation of the second derivative of the finite element solution (assuming bilinear finite elements), one sees that the numerical solution is almost totally wrong, compared with the true second derivative. Indeed, on regular meshes, there exist sharp estimations that the H²-error is only of order one, so we should not be surprised; however, the numerical solution may show a value for the second derivative which may be a factor of ten away from the true value. These problems are located on the small cell adjacent to the center vertex, where cells of non-subsequent levels meet, as well as on the upper and right neighbor of this cell (but with a less degree of deviation from the true value). If the smoothing indicator given to the constructor contains the bit for limit_level_difference_at_vertices, situations as the above one are eliminated by also marking the upper right cell for refinement. In case of anisotropic refinement, the level of a cell is not linked to the refinement of a cell as directly as in case of isotropic refinement. Furthermore, a cell can be strongly refined in one direction and not or at least much less refined in another. Therefore, it is very difficult to decide, which cases should be excluded from the refinement process. As a consequence, when using anisotropic refinement, the limit_level_difference_at_vertices flag must not be set. On the other hand, the implementation of multigrid methods in deal.II requires that this bit be set.
eliminate_unrefined_islands	Single cells which are not refined and are surrounded by cells which are refined usually also lead to a sharp decline in approximation properties locally. The reason is that the nodes on the faces between unrefined and refined cells are not real degrees of freedom but carry constraints. The patch without additional degrees of freedom is thus significantly larger then the unrefined cell itself. If in the parameter passed to the constructor the bit for eliminate_unrefined_islands is set, all cells which are not flagged for refinement but which are surrounded by more refined cells than unrefined cells are flagged for refinement. Cells which are not yet refined but flagged for that are accounted for the number of refined neighbors. Cells on the boundary are not accounted for at all. An unrefined island is, by this definition also a cell which (in 2d) is surrounded by three refined cells and one unrefined one, or one surrounded by two refined cells, one unrefined one and is at the boundary on one side. It is thus not a true island, as the name of the flag may indicate. However, no better name came to mind to the author by now.
patch_level_1	A triangulation of patch level 1 consists of patches, i.e. of cells that are refined once. This flag ensures that a mesh of patch level 1 is still of patch level 1 after coarsening and refinement. It is, however, the user's responsibility to ensure that the mesh is of patch level 1 before calling Triangulation::execute_coarsening_and_refinement() the first time. The easiest way to achieve this is by calling global_refine(1) straight after creation of the triangulation. It follows that if at least one of the children of a cell is or will be refined than all children need to be refined. If the patch_level_1 flag is set, than the flags eliminate_unrefined_islands, eliminate_refined_inner_islands and eliminate_refined_boundary_islands will be ignored as they will be fulfilled automatically.
coarsest_level_1	Each coarse grid cell is refined at least once, i.e., the triangulation might have active cells on level 1 but not on level 0. This flag ensures that a mesh which has coarsest_level_1 has still coarsest_level_1 after coarsening and refinement. It is, however, the user's responsibility to ensure that the mesh has coarsest_level_1 before calling execute_coarsening_and_refinement the first time. The easiest way to achieve this is by calling global_refine(1) straight after creation of the triangulation. It follows that active cells on level 1 may not be coarsened. The main use of this flag is to ensure that each cell has at least one neighbor in each coordinate direction (i.e. each cell has at least a left or right, and at least an upper or lower neighbor in 2d). This is a necessary precondition for some algorithms that compute finite differences between cells. The DerivativeApproximation class is one of these algorithms that require that a triangulation is coarsest_level_1 unless all cells already have at least one neighbor in each coordinate direction on the coarsest level.
allow_anisotropic_smoothing	This flag is not included in `maximum_smoothing`. The flag is concerned with the following case: consider the case that an unrefined and a refined cell share a common face and that one of the children of the refined cell along the common face is flagged for further refinement. In that case, the resulting mesh would have more than one hanging node along one or more of the edges of the triangulation, a situation that is not allowed. Consequently, in order to perform the refinement, the coarser of the two original cells is also going to be refined. However, in many cases it is sufficient to refine the coarser of the two original cells in an anisotropic way to avoid the case of multiple hanging vertices on a single edge. Doing only the minimal anisotropic refinement can save cells and degrees of freedom. By specifying this flag, the library can produce these anisotropic refinements. The flag is not included by default since it may lead to anisotropically refined meshes even though no cell has ever been refined anisotropically explicitly by a user command. This surprising fact may lead to programs that do the wrong thing since they are not written for the additional cases that can happen with anisotropic meshes, see the discussion in the introduction to step-30.
eliminate_refined_inner_islands	This algorithm seeks for isolated cells which are refined or flagged for refinement. This definition is unlike that for eliminate_unrefined_islands, which would mean that an island is defined as a cell which is refined but more of its neighbors are not refined than are refined. For example, in 2d, a cell's refinement would be reverted if at most one of its neighbors is also refined (or refined but flagged for coarsening). The reason for the change in definition of an island is, that this option would be a bit dangerous, since if you consider a chain of refined cells (e.g. along a kink in the solution), the cells at the two ends would be coarsened, after which the next outermost cells would need to be coarsened. Therefore, only one loop of flagging cells like this could be done to avoid eating up the whole chain of refined cells (‘chain reaction’...). This algorithm also takes into account cells which are not actually refined but are flagged for refinement. If necessary, it takes away the refinement flag. Actually there are two versions of this flag, eliminate_refined_inner_islands and eliminate_refined_boundary_islands. The first eliminates islands defined by the definition above which are in the interior of the domain, while the second eliminates only those islands if the cell is at the boundary. The reason for this split of flags is that one often wants to eliminate such islands in the interior while those at the boundary may well be wanted, for example if one refines the mesh according to a criterion associated with a boundary integral or if one has rough boundary data.
eliminate_refined_boundary_islands	The result of this flag is very similar to eliminate_refined_inner_islands. See the documentation there.
do_not_produce_unrefined_islands	This flag prevents the occurrence of unrefined islands. In more detail: It prohibits the coarsening of a cell if 'most of the neighbors' will be refined after the step.
smoothing_on_refinement	This flag sums up all smoothing algorithms which may be performed upon refinement by flagging some more cells for refinement.
smoothing_on_coarsening	This flag sums up all smoothing algorithms which may be performed upon coarsening by flagging some more cells for coarsening.
maximum_smoothing	This flag includes all the above ones (therefore combines all smoothing algorithms implemented), with the exception of anisotropic smoothing.

Definition at line 1151 of file tria.h.

Constructor & Destructor Documentation

◆ DistributedTriangulationBase()

template<int dim, int spacedim>

parallel::DistributedTriangulationBase< dim, spacedim >::DistributedTriangulationBase	(	const MPI_Comm	mpi_communicator,
		const typename ::Triangulation< dim, spacedim >::MeshSmoothing	smooth_grid = `(::Triangulation<dim, spacedim>::none)`,
		const bool	check_for_distorted_cells = `false`
	)

Constructor.

Definition at line 673 of file tria_base.cc.

Member Function Documentation

◆ clear()

template<int dim, int spacedim>

void parallel::DistributedTriangulationBase< dim, spacedim >::clear

overridevirtual

Reset this triangulation into a virgin state by deleting all data.

Note that this operation is only allowed if no subscriptions to this object exist any more, such as DoFHandler objects using it.

Reimplemented from Triangulation< dim, spacedim >.

Reimplemented in parallel::distributed::Triangulation< dim, spacedim >.

Definition at line 690 of file tria_base.cc.

◆ has_hanging_nodes()

template<int dim, int spacedim>

bool parallel::DistributedTriangulationBase< dim, spacedim >::has_hanging_nodes

overridevirtual

Return true if the triangulation has hanging nodes.

In the context of parallel distributed triangulations, every processor stores only that part of the triangulation it owns locally. However, it also stores coarser levels, and to guarantee the 2:1 relationship between cells, this may mean that there are hanging nodes between cells that are not locally owned or ghost cells (i.e., between ghost cells and artificial cells, or between artificial and artificial cells; see the glossary). One is not typically interested in this case, so the function returns whether there are hanging nodes between any two cells of the "global" mesh, i.e., the union of locally owned cells on all processors.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 739 of file tria_base.cc.

◆ save() [1/2]

template<int dim, int spacedim = dim>

virtual void parallel::DistributedTriangulationBase< dim, spacedim >::save ( const std::string & filename ) const

pure virtual

Save the triangulation into the given file. This file needs to be reachable from all nodes in the computation on a shared network file system. See the SolutionTransfer class on how to store solution vectors into this file. Additional cell-based data can be saved using register_data_attach().

Implemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ load() [1/3]

template<int dim, int spacedim = dim>

virtual void parallel::DistributedTriangulationBase< dim, spacedim >::load ( const std::string & filename )

pure virtual

Load the triangulation saved with save() back in. Cell-based data that was saved with register_data_attach() can be read in with notify_ready_to_unpack() after calling load().

Implemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ load() [2/3]

template<int dim, int spacedim = dim>

virtual void parallel::DistributedTriangulationBase< dim, spacedim >::load	(	const std::string &	filename,
		const bool	autopartition
	)

pure virtual

Load the triangulation saved with save() back in. Cell-based data that was saved with register_data_attach() can be read in with notify_ready_to_unpack() after calling load().

Deprecated:: The autopartition parameter has been removed.

Implemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ register_data_attach()

template<int dim, int spacedim>

unsigned int parallel::DistributedTriangulationBase< dim, spacedim >::register_data_attach	(	const std::function< std::vector< char >(const cell_iterator &, const CellStatus)> &	pack_callback,
		const bool	returns_variable_size_data
	)

Register a function that can be used to attach data of fixed size to cells. This is useful for two purposes: (i) Upon refinement and coarsening of a triangulation (e.g. in parallel::distributed::Triangulation::execute_coarsening_and_refinement()), one needs to be able to store one or more data vectors per cell that characterizes the solution values on the cell so that this data can then be transferred to the new owning processor of the cell (or its parent/children) when the mesh is re-partitioned; (ii) when serializing a computation to a file, it is necessary to attach data to cells so that it can be saved (e.g. in parallel::distributed::Triangulation::save()) along with the cell's other information and, if necessary, later be reloaded from disk with a different subdivision of cells among the processors.

The way this function works is that it allows any number of interest parties to register their intent to attach data to cells. One example of classes that do this is parallel::distributed::SolutionTransfer where each parallel::distributed::SolutionTransfer object that works on the current Triangulation object then needs to register its intent. Each of these parties registers a callback function (the first argument here, pack_callback) that will be called whenever the triangulation's execute_coarsening_and_refinement() or save() functions are called.

The current function then returns an integer handle that corresponds to the number of data set that the callback provided here will attach. While this number could be given a precise meaning, this is not important: You will never actually have to do anything with this number except return it to the notify_ready_to_unpack() function. In other words, each interested party (i.e., the caller of the current function) needs to store their respective returned handle for later use when unpacking data in the callback provided to notify_ready_to_unpack().

Whenever pack_callback is then called by execute_coarsening_and_refinement() or load() on a given cell, it receives a number of arguments. In particular, the first argument passed to the callback indicates the cell for which it is supposed to attach data. This is always an active cell.

The second, CellStatus, argument provided to the callback function will tell you if the given cell will be coarsened, refined, or will persist as is. (This status may be different than the refinement or coarsening flags set on that cell, to accommodate things such as the "one hanging node per edge" rule.). These flags need to be read in context with the p4est quadrant they belong to, as their relations are gathered in local_cell_relations.

Specifically, the values for this argument mean the following:

CELL_PERSIST: The cell won't be refined/coarsened, but might be moved to a different processor. If this is the case, the callback will want to pack up the data on this cell into an array and store it at the provided address for later unpacking wherever this cell may land.
CELL_REFINE: This cell will be refined into 4 or 8 cells (in 2d and 3d, respectively). However, because these children don't exist yet, you cannot access them at the time when the callback is called. Thus, in local_cell_relations, the corresponding p4est quadrants of the children cells are linked to the deal.II cell which is going to be refined. To be specific, only the very first child is marked with CELL_REFINE, whereas the others will be marked with CELL_INVALID, which indicates that these cells will be ignored by default during the packing or unpacking process. This ensures that data is only transferred once onto or from the parent cell. If the callback is called with CELL_REFINE, the callback will want to pack up the data on this cell into an array and store it at the provided address for later unpacking in a way so that it can then be transferred to the children of the cell that will then be available. In other words, if the data the callback will want to pack up corresponds to a finite element field, then the prolongation from parent to (new) children will have to happen during unpacking.
CELL_COARSEN: The children of this cell will be coarsened into the given cell. These children still exist, so if this is the value given to the callback as second argument, the callback will want to transfer data from the children to the current parent cell and pack it up so that it can later be unpacked again on a cell that then no longer has any children (and may also be located on a different processor). In other words, if the data the callback will want to pack up corresponds to a finite element field, then it will need to do the restriction from children to parent at this point.
CELL_INVALID: See CELL_REFINE.

Note: If this function is used for serialization of data using save() and load(), then the cell status argument with which the callback is called will always be CELL_PERSIST.

The callback function is expected to return a memory chunk of the format std::vector<char>, representing the packed data on a certain cell.

The second parameter returns_variable_size_data indicates whether the returned size of the memory region from the callback function varies by cell (=true) or stays constant on each one throughout the whole domain (=false).

Note: The purpose of this function is to register intent to attach data for a single, subsequent call to execute_coarsening_and_refinement() and notify_ready_to_unpack(), save(), load(). Consequently, notify_ready_to_unpack(), save(), and load() all forget the registered callbacks once these callbacks have been called, and you will have to re-register them with a triangulation if you want them to be active for another call to these functions.

Definition at line 803 of file tria_base.cc.

◆ notify_ready_to_unpack()

template<int dim, int spacedim>

void parallel::DistributedTriangulationBase< dim, spacedim >::notify_ready_to_unpack	(	const unsigned int	handle,
		const std::function< void(const cell_iterator &, const CellStatus, const boost::iterator_range< std::vector< char >::const_iterator > &)> &	unpack_callback
	)

This function is the opposite of register_data_attach(). It is called after the execute_coarsening_and_refinement() or save()/load() functions are done when classes and functions that have previously attached data to a triangulation for either transfer to other processors, across mesh refinement, or serialization of data to a file are ready to receive that data back. The important part about this process is that the triangulation cannot do this right away from the end of execute_coarsening_and_refinement() or load() via a previously attached callback function (as the register_data_attach() function does) because the classes that eventually want the data back may need to do some setup between the point in time where the mesh has been recreated and when the data can actually be received. An example is the parallel::distributed::SolutionTransfer class that can really only receive the data once not only the mesh is completely available again on the current processor, but only after a DoFHandler has been reinitialized and distributed degrees of freedom. In other words, there is typically a significant amount of set up that needs to happen in user space before the classes that can receive data attached to cell are ready to actually do so. When they are, they use the current function to tell the triangulation object that now is the time when they are ready by calling the current function.

The supplied callback function is then called for each newly locally owned cell. The first argument to the callback is an iterator that designates the cell; the second argument indicates the status of the cell in question; and the third argument localizes a memory area by two iterators that contains the data that was previously saved from the callback provided to register_data_attach().

The CellStatus will indicate if the cell was refined, coarsened, or persisted unchanged. The cell_iterator argument to the callback will then either be an active, locally owned cell (if the cell was not refined), or the immediate parent if it was refined during execute_coarsening_and_refinement(). Therefore, contrary to during register_data_attach(), you can now access the children if the status is CELL_REFINE but no longer for callbacks with status CELL_COARSEN.

The first argument to this function, handle, corresponds to the return value of register_data_attach(). (The precise meaning of what the numeric value of this handle is supposed to represent is neither important, nor should you try to use it for anything other than transmit information between a call to register_data_attach() to the corresponding call to notify_ready_to_unpack().)

Definition at line 834 of file tria_base.cc.

◆ save_attached_data()

template<int dim, int spacedim>

void parallel::DistributedTriangulationBase< dim, spacedim >::save_attached_data	(	const unsigned int	global_first_cell,
		const unsigned int	global_num_cells,
		const std::string &	filename
	)		const

protected

Save additional cell-attached data into the given file. The first arguments are used to determine the offsets where to write buffers to.

Called by save.

Definition at line 702 of file tria_base.cc.

◆ load_attached_data()

template<int dim, int spacedim>

void parallel::DistributedTriangulationBase< dim, spacedim >::load_attached_data	(	const unsigned int	global_first_cell,
		const unsigned int	global_num_cells,
		const unsigned int	local_num_cells,
		const std::string &	filename,
		const unsigned int	n_attached_deserialize_fixed,
		const unsigned int	n_attached_deserialize_variable
	)

protected

Load additional cell-attached data from the given file, if any was saved. The first arguments are used to determine the offsets where to read buffers from.

Called by load.

Definition at line 766 of file tria_base.cc.

◆ update_cell_relations()

template<int dim, int spacedim = dim>

virtual void parallel::DistributedTriangulationBase< dim, spacedim >::update_cell_relations ( )

protectedpure virtual

A function to record the CellStatus of currently active cells that are locally owned. This information is mandatory to transfer data between meshes during adaptation or serialization, e.g., using parallel::distributed::SolutionTransfer.

Relations will be stored in the private member local_cell_relations. For an extensive description of CellStatus, see the documentation for the member function register_data_attach().

Implemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ get_communicator()

template<int dim, int spacedim>

MPI_Comm parallel::TriangulationBase< dim, spacedim >::get_communicator

overridevirtualinherited

Return MPI communicator used by this triangulation.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 160 of file tria_base.cc.

◆ is_multilevel_hierarchy_constructed()

template<int dim, int spacedim = dim>

virtual bool parallel::TriangulationBase< dim, spacedim >::is_multilevel_hierarchy_constructed ( ) const

pure virtualinherited

Return if multilevel hierarchy is supported and has been constructed.

Implemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::shared::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ copy_triangulation() [1/2]

template<int dim, int spacedim>

void parallel::TriangulationBase< dim, spacedim >::copy_triangulation ( const ::Triangulation< dim, spacedim > & old_tria )

overridevirtualinherited

Implementation of the same function as in the base class.

Note: This function copies the cells, but not the communicator, of the source triangulation. In other words, the resulting triangulation will operate on the communicator it was constructed with.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::shared::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< dim, spacedim >.

Definition at line 68 of file tria_base.cc.

◆ copy_triangulation() [2/2]

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::copy_triangulation ( const Triangulation< dim, spacedim > & other_tria )

virtualinherited

Copy other_tria to this triangulation. This operation is not cheap, so you should be careful with using this. We do not implement this function as a copy constructor, since it makes it easier to maintain collections of triangulations if you can assign them values later on.

Keep in mind that this function also copies the pointer to the boundary descriptor previously set by the set_manifold function. You must therefore also guarantee that the Manifold objects describing the boundary have a lifetime at least as long as the copied triangulation.

This triangulation must be empty beforehand.

The function is made virtual since some derived classes might want to disable or extend the functionality of this function.

Note: Calling this function triggers the 'copy' signal on other_tria, i.e. the triangulation being copied from. It also triggers the 'create' signal of the current triangulation. See the section on signals in the general documentation for more information.; The list of connections to signals is not copied from the old to the new triangulation since these connections were established to monitor how the old triangulation changes, not how any triangulation it may be copied to changes.

Reimplemented in PersistentTriangulation< dim, spacedim >.

◆ n_locally_owned_active_cells()

template<int dim, int spacedim>

unsigned int parallel::TriangulationBase< dim, spacedim >::n_locally_owned_active_cells

inherited

Return the number of active cells in the triangulation that are locally owned, i.e. that have a subdomain_id equal to locally_owned_subdomain(). Note that there may be more active cells in the triangulation stored on the present processor, such as for example ghost cells, or cells further away from the locally owned block of cells but that are needed to ensure that the triangulation that stores this processor's set of active cells still remains balanced with respect to the 2:1 size ratio of adjacent cells.

As a consequence of the remark above, the result of this function is always smaller or equal to the result of the function with the same name in the Triangulation base class, which includes the active ghost and artificial cells (see also GlossArtificialCell and GlossGhostCell).

Definition at line 131 of file tria_base.cc.

◆ n_global_active_cells()

template<int dim, int spacedim>

types::global_cell_index parallel::TriangulationBase< dim, spacedim >::n_global_active_cells

overridevirtualinherited

Return the sum over all processors of the number of active cells owned by each processor. This equals the overall number of active cells in the triangulation.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 151 of file tria_base.cc.

◆ memory_consumption()

template<int dim, int spacedim>

std::size_t parallel::TriangulationBase< dim, spacedim >::memory_consumption

overridevirtualinherited

Return the local memory consumption in bytes.

Reimplemented from Triangulation< dim, spacedim >.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< dim, spacedim >.

Definition at line 93 of file tria_base.cc.

◆ n_global_levels()

template<int dim, int spacedim>

unsigned int parallel::TriangulationBase< dim, spacedim >::n_global_levels

overridevirtualinherited

Return the global maximum level. This may be bigger than the number Triangulation::n_levels() (a function in this class's base class) returns if the current processor only stores cells in parts of the domain that are not very refined, but if other processors store cells in more deeply refined parts of the domain.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 141 of file tria_base.cc.

◆ locally_owned_subdomain()

template<int dim, int spacedim>

types::subdomain_id parallel::TriangulationBase< dim, spacedim >::locally_owned_subdomain

overridevirtualinherited

Return the subdomain id of those cells that are owned by the current processor. All cells in the triangulation that do not have this subdomain id are either owned by another processor or have children that only exist on other processors.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 345 of file tria_base.cc.

◆ ghost_owners()

template<int dim, int spacedim>

const std::set< types::subdomain_id > & parallel::TriangulationBase< dim, spacedim >::ghost_owners

inherited

Return a set of MPI ranks of the processors that have at least one ghost cell adjacent to the cells of the local processor. In other words, this is the set of subdomain_id() for all ghost cells.

The returned sets are symmetric, that is if i is contained in the list of processor j, then j will also be contained in the list of processor i.

Definition at line 355 of file tria_base.cc.

◆ level_ghost_owners()

template<int dim, int spacedim>

const std::set< types::subdomain_id > & parallel::TriangulationBase< dim, spacedim >::level_ghost_owners

inherited

Return a set of MPI ranks of the processors that have at least one level ghost cell adjacent to our cells used in geometric multigrid. In other words, this is the set of level_subdomain_id() for all level ghost cells.

The returned sets are symmetric, that is if i is contained in the list of processor j, then j will also be contained in the list of processor i.

Note: The level ghost owners can only be determined if the multigrid ownership has been assigned (by setting the construct_multigrid_hierarchy flag at construction time), otherwise the returned set will be empty.

Definition at line 365 of file tria_base.cc.

◆ global_active_cell_index_partitioner()

template<int dim, int spacedim>

const std::weak_ptr< const Utilities::MPI::Partitioner > parallel::TriangulationBase< dim, spacedim >::global_active_cell_index_partitioner ( ) const

overridevirtualinherited

Return the partitioner for the global indices of the cells on the active level of the triangulation, which is returned by the function CellAccessor::global_active_cell_index().

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 639 of file tria_base.cc.

◆ global_level_cell_index_partitioner()

template<int dim, int spacedim>

const std::weak_ptr< const Utilities::MPI::Partitioner > parallel::TriangulationBase< dim, spacedim >::global_level_cell_index_partitioner ( const unsigned int level ) const

overridevirtualinherited

Return the partitioner for the global indices of the cells on the given level of the triangulation, which is returned by the function CellAccessor::global_level_cell_index().

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 650 of file tria_base.cc.

◆ get_boundary_ids()

template<int dim, int spacedim>

std::vector< types::boundary_id > parallel::TriangulationBase< dim, spacedim >::get_boundary_ids

overridevirtualinherited

Return a vector containing all boundary indicators assigned to boundary faces of active cells of this Triangulation object. Note, that each boundary indicator is reported only once. The size of the return vector will represent the number of different indicators (which is greater or equal one).

See also: Glossary entry on boundary indicators

Note: This function involves a global communication gathering all current IDs from all processes.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 374 of file tria_base.cc.

◆ get_manifold_ids()

template<int dim, int spacedim>

std::vector< types::manifold_id > parallel::TriangulationBase< dim, spacedim >::get_manifold_ids

overridevirtualinherited

Return a vector containing all manifold indicators assigned to the objects of the active cells of this Triangulation. Note, that each manifold indicator is reported only once. The size of the return vector will represent the number of different indicators (which is greater or equal one).

See also: Glossary entry on manifold indicators

Note: This function involves a global communication gathering all current IDs from all processes.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 386 of file tria_base.cc.

◆ communicate_locally_moved_vertices()

template<int dim, int spacedim>

void parallel::TriangulationBase< dim, spacedim >::communicate_locally_moved_vertices ( const std::vector< bool > & vertex_locally_moved )

inherited

When vertices have been moved locally, for example using code like

cell->vertex(0) = new_location;

then this function can be used to update the location of vertices between MPI processes.

All the vertices that have been moved and might be in the ghost layer of a process have to be reported in the vertex_locally_moved argument. This ensures that that part of the information that has to be send between processes is actually sent. Additionally, it is quite important that vertices on the boundary between processes are reported on exactly one process (e.g. the one with the highest id). Otherwise we could expect undesirable results if multiple processes move a vertex differently. A typical strategy is to let processor \(i\) move those vertices that are adjacent to cells whose owners include processor \(i\) but no other processor \(j\) with \(j<i\); in other words, for vertices at the boundary of a subdomain, the processor with the lowest subdomain id "owns" a vertex.

Note: It only makes sense to move vertices that are either located on locally owned cells or on cells in the ghost layer. This is because you can be sure that these vertices indeed exist on the finest mesh aggregated over all processors, whereas vertices on artificial cells but not at least in the ghost layer may or may not exist on the globally finest mesh. Consequently, the vertex_locally_moved argument may not contain vertices that aren't at least on ghost cells.; This function moves vertices in such a way that on every processor, the vertices of every locally owned and ghost cell is consistent with the corresponding location of these cells on other processors. On the other hand, the locations of artificial cells will in general be wrong since artificial cells may or may not exist on other processors and consequently it is not possible to determine their location in any way. This is not usually a problem since one never does anything on artificial cells. However, it may lead to problems if the mesh with moved vertices is refined in a later step. If that's what you want to do, the right way to do it is to save the offset applied to every vertex, call this function, and before refining or coarsening the mesh apply the opposite offset and call this function again.

Parameters

vertex_locally_moved A bitmap indicating which vertices have been moved. The size of this array must be equal to Triangulation::n_vertices() and must be a subset of those vertices flagged by GridTools::get_locally_owned_vertices().

See also: This function is used, for example, in GridTools::distort_random().

Definition at line 582 of file tria_base.cc.

◆ n_global_coarse_cells()

template<int dim, int spacedim>

types::coarse_cell_id parallel::TriangulationBase< dim, spacedim >::n_global_coarse_cells ( ) const

overridevirtualinherited

Return the total number of coarse cells. If the coarse mesh is replicated on each process, this simply returns n_cells(0).

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 664 of file tria_base.cc.

◆ update_number_cache()

template<int dim, int spacedim>

void parallel::TriangulationBase< dim, spacedim >::update_number_cache

protectedvirtualinherited

Update the number_cache variable after mesh creation or refinement.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >.

Definition at line 170 of file tria_base.cc.

◆ update_reference_cells()

template<int dim, int spacedim>

void parallel::TriangulationBase< dim, spacedim >::update_reference_cells

overrideprotectedvirtualinherited

Update the internal reference_cells vector.

Reimplemented from Triangulation< dim, spacedim >.

Definition at line 315 of file tria_base.cc.

◆ reset_global_cell_indices()

template<int dim, int spacedim>

void parallel::TriangulationBase< dim, spacedim >::reset_global_cell_indices

protectedinherited

Reset global active cell indices and global level cell indices.

Definition at line 398 of file tria_base.cc.

◆ set_mesh_smoothing()

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::set_mesh_smoothing ( const MeshSmoothing mesh_smoothing )

virtualinherited

Set the mesh smoothing to mesh_smoothing. This overrides the MeshSmoothing given to the constructor. It is allowed to call this function only if the triangulation is empty.

◆ get_mesh_smoothing()

template<int dim, int spacedim = dim>

virtual const MeshSmoothing & Triangulation< dim, spacedim >::get_mesh_smoothing ( ) const

virtualinherited

Return the mesh smoothing requirements that are obeyed.

◆ create_triangulation() [1/2]

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::create_triangulation	(	const std::vector< Point< spacedim > > &	vertices,
		const std::vector< CellData< dim > > &	cells,
		const SubCellData &	subcelldata
	)

virtualinherited

Create a triangulation from a list of vertices and a list of cells, each of the latter being a list of 1<<dim vertex indices. The triangulation must be empty upon calling this function and the cell list should be useful (connected domain, etc.). The result of calling this function is a coarse mesh.

Material data for the cells is given within the cells array, while boundary information is given in the subcelldata field.

The numbering of vertices within the cells array is subject to some constraints; see the general class documentation for this.

For conditions when this function can generate a valid triangulation, see the documentation of this class, and the GridIn and GridReordering class.

If the check_for_distorted_cells flag was specified upon creation of this object, at the very end of its operation, the current function walks over all cells and verifies that none of the cells is deformed (see the entry on distorted cells in the glossary), where we call a cell deformed if the determinant of the Jacobian of the mapping from reference cell to real cell is negative at least at one of the vertices (this computation is done using the GeometryInfo::jacobian_determinants_at_vertices function). If there are deformed cells, this function throws an exception of kind DistortedCellList. Since this happens after all data structures have been set up, you can catch and ignore this exception if you know what you do – for example, it may be that the determinant is zero (indicating that you have collapsed edges in a cell) but that this is ok because you didn't intend to integrate on this cell anyway. On the other hand, deformed cells are often a sign of a mesh that is too coarse to resolve the geometry of the domain, and in this case ignoring the exception is probably unwise.

Note: This function is used in step-14 and step-19.; This function triggers the "create" signal after doing its work. See the section on signals in the general documentation of this class. For example as a consequence of this, all DoFHandler objects connected to this triangulation will be reinitialized via DoFHandler::reinit().; The check for distorted cells is only done if dim==spacedim, as otherwise cells can legitimately be twisted if the manifold they describe is twisted.

Reimplemented in parallel::shared::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and PersistentTriangulation< dim, spacedim >.

◆ create_triangulation() [2/2]

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::create_triangulation ( const TriangulationDescription::Description< dim, spacedim > & construction_data )

virtualinherited

Create a triangulation from the provided TriangulationDescription::Description.

Note: Don't forget to attach the manifolds with set_manifold() before calling this function if manifolds are needed.; The namespace TriangulationDescription::Utilities contains functions to create TriangulationDescription::Description.

Parameters

construction_data The data needed for this process.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::shared::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and PersistentTriangulation< dim, spacedim >.

◆ create_triangulation_compatibility()

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::create_triangulation_compatibility	(	const std::vector< Point< spacedim > > &	vertices,
		const std::vector< CellData< dim > > &	cells,
		const SubCellData &	subcelldata
	)

virtualinherited

For backward compatibility, only. This function takes the cell data in the ordering as requested by deal.II versions up to 5.2, converts it to the new (lexicographic) ordering and calls create_triangulation().

Note: This function internally calls create_triangulation and therefore can throw the same exception as the other function.

Reimplemented in PersistentTriangulation< dim, spacedim >.

◆ flip_all_direction_flags()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::flip_all_direction_flags ( )

inherited

Revert or flip the direction_flags of a dim<spacedim triangulation, see GlossDirectionFlag.

This function throws an exception if dim equals spacedim.

◆ set_all_refine_flags()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::set_all_refine_flags ( )

inherited

Flag all active cells for refinement. This will refine all cells of all levels which are not already refined (i.e. only cells are refined which do not yet have children). The cells are only flagged, not refined, thus you have the chance to save the refinement flags.

◆ refine_global()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::refine_global ( const unsigned int times = 1 )

inherited

Refine all cells times times. In other words, in each one of the times iterations, loop over all cells and refine each cell uniformly into \(2^\text{dim}\) children. In practice, this function repeats the following operations times times: call set_all_refine_flags() followed by execute_coarsening_and_refinement(). The end result is that the number of cells increases by a factor of \((2^\text{dim})^\text{times}=2^{\text{dim} \times \text{times}}\).

The execute_coarsening_and_refinement() function called in this loop may throw an exception if it creates cells that are distorted (see its documentation for an explanation). This exception will be propagated through this function if that happens, and you may not get the actual number of refinement steps in that case.

Note: This function triggers the pre- and post-refinement signals before and after doing each individual refinement cycle (i.e. more than once if times > 1) . See the section on signals in the general documentation of this class.

◆ coarsen_global()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::coarsen_global ( const unsigned int times = 1 )

inherited

Coarsen all cells the given number of times.

In each of one of the times iterations, all cells will be marked for coarsening. If an active cell is already on the coarsest level, it will be ignored.

Note: This function triggers the pre- and post-refinement signals before and after doing each individual coarsening cycle (i.e. more than once if times > 1) . See the section on signals in the general documentation of this class.

◆ execute_coarsening_and_refinement()

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::execute_coarsening_and_refinement ( )

virtualinherited

Execute both refinement and coarsening of the triangulation.

The function resets all refinement and coarsening flags to false. It uses the user flags for internal purposes. They will therefore be overwritten by undefined content.

To allow user programs to fix up these cells if that is desired, this function after completing all other work may throw an exception of type DistortedCellList that contains a list of those cells that have been refined and have at least one child that is distorted. The function does not create such an exception if no cells have created distorted children. Note that for the check for distorted cells to happen, the check_for_distorted_cells flag has to be specified upon creation of a triangulation object.

See the general docs for more information.

Note: This function triggers the pre- and post-refinement signals before and after doing its work. See the section on signals in the general documentation of this class.; If the boundary description is sufficiently irregular, it can happen that some of the children produced by mesh refinement are distorted (see the extensive discussion on distorted cells).; This function is virtual to allow derived classes to insert hooks, such as saving refinement flags and the like (see e.g. the PersistentTriangulation class).

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::shared::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and PersistentTriangulation< dim, spacedim >.

◆ prepare_coarsening_and_refinement() [1/4]

template<int dim, int spacedim = dim>

virtual bool Triangulation< dim, spacedim >::prepare_coarsening_and_refinement ( )

virtualinherited

Do both preparation for refinement and coarsening as well as mesh smoothing.

Regarding the refinement process it fixes the closure of the refinement in dim>=2 (make sure that no two cells are adjacent with a refinement level differing with more than one), etc. It performs some mesh smoothing if the according flag was given to the constructor of this class. The function returns whether additional cells have been flagged for refinement.

See the general doc of this class for more information on smoothing upon refinement.

Regarding the coarsening part, flagging and deflagging cells in preparation of the actual coarsening step are done. This includes deleting coarsen flags from cells which may not be deleted (e.g. because one neighbor is more refined than the cell), doing some smoothing, etc.

The effect is that only those cells are flagged for coarsening which will actually be coarsened. This includes the fact that all flagged cells belong to parent cells of which all children are flagged.

The function returns whether some cells' flagging has been changed in the process.

This function uses the user flags, so store them if you still need them afterwards.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< dim, spacedim >.

◆ prepare_coarsening_and_refinement() [2/4]

bool Triangulation< 1, 1 >::prepare_coarsening_and_refinement ( )

inherited

Definition at line 15168 of file tria.cc.

◆ prepare_coarsening_and_refinement() [3/4]

bool Triangulation< 1, 2 >::prepare_coarsening_and_refinement ( )

inherited

Definition at line 15186 of file tria.cc.

◆ prepare_coarsening_and_refinement() [4/4]

bool Triangulation< 1, 3 >::prepare_coarsening_and_refinement ( )

inherited

Definition at line 15204 of file tria.cc.

◆ save_refine_flags() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_refine_flags ( std::ostream & out ) const

inherited

Save the addresses of the cells which are flagged for refinement to out. For usage, read the general documentation for this class.

◆ save_refine_flags() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_refine_flags ( std::vector< bool > & v ) const

inherited

Same as above, but store the flags to a bitvector rather than to a file.

◆ load_refine_flags() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_refine_flags ( std::istream & in )

inherited

Read the information stored by save_refine_flags.

◆ load_refine_flags() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_refine_flags ( const std::vector< bool > & v )

inherited

Read the information stored by save_refine_flags.

◆ save_coarsen_flags() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_coarsen_flags ( std::ostream & out ) const

inherited

Analogue to save_refine_flags.

◆ save_coarsen_flags() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_coarsen_flags ( std::vector< bool > & v ) const

inherited

Same as above, but store the flags to a bitvector rather than to a file.

◆ load_coarsen_flags() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_coarsen_flags ( std::istream & out )

inherited

Analogue to load_refine_flags.

◆ load_coarsen_flags() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_coarsen_flags ( const std::vector< bool > & v )

inherited

Analogue to load_refine_flags.

◆ get_anisotropic_refinement_flag()

template<int dim, int spacedim = dim>

bool Triangulation< dim, spacedim >::get_anisotropic_refinement_flag ( ) const

inherited

Return whether this triangulation has ever undergone anisotropic (as opposed to only isotropic) refinement.

◆ clear_user_flags()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::clear_user_flags ( )

inherited

Clear all user flags. See also GlossUserFlags.

◆ save_user_flags() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags ( std::ostream & out ) const

inherited

Save all user flags. See the general documentation for this class and the documentation for the save_refine_flags for more details. See also GlossUserFlags.

◆ save_user_flags() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags ( std::vector< bool > & v ) const

inherited

Same as above, but store the flags to a bitvector rather than to a file. The output vector is resized if necessary. See also GlossUserFlags.

◆ load_user_flags() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags ( std::istream & in )

inherited

Read the information stored by save_user_flags. See also GlossUserFlags.

◆ load_user_flags() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags ( const std::vector< bool > & v )

inherited

Read the information stored by save_user_flags. See also GlossUserFlags.

◆ clear_user_flags_line()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::clear_user_flags_line ( )

inherited

Clear all user flags on lines. See also GlossUserFlags.

◆ save_user_flags_line() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags_line ( std::ostream & out ) const

inherited

Save the user flags on lines. See also GlossUserFlags.

◆ save_user_flags_line() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags_line ( std::vector< bool > & v ) const

inherited

Same as above, but store the flags to a bitvector rather than to a file. The output vector is resized if necessary. See also GlossUserFlags.

◆ load_user_flags_line() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags_line ( std::istream & in )

inherited

Load the user flags located on lines. See also GlossUserFlags.

◆ load_user_flags_line() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags_line ( const std::vector< bool > & v )

inherited

Load the user flags located on lines. See also GlossUserFlags.

◆ clear_user_flags_quad()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::clear_user_flags_quad ( )

inherited

Clear all user flags on quads. See also GlossUserFlags.

◆ save_user_flags_quad() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags_quad ( std::ostream & out ) const

inherited

Save the user flags on quads. See also GlossUserFlags.

◆ save_user_flags_quad() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags_quad ( std::vector< bool > & v ) const

inherited

Same as above, but store the flags to a bitvector rather than to a file. The output vector is resized if necessary. See also GlossUserFlags.

◆ load_user_flags_quad() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags_quad ( std::istream & in )

inherited

Load the user flags located on quads. See also GlossUserFlags.

◆ load_user_flags_quad() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags_quad ( const std::vector< bool > & v )

inherited

Load the user flags located on quads. See also GlossUserFlags.

◆ clear_user_flags_hex()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::clear_user_flags_hex ( )

inherited

Clear all user flags on quads. See also GlossUserFlags.

◆ save_user_flags_hex() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags_hex ( std::ostream & out ) const

inherited

Save the user flags on hexs. See also GlossUserFlags.

◆ save_user_flags_hex() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_flags_hex ( std::vector< bool > & v ) const

inherited

Same as above, but store the flags to a bitvector rather than to a file. The output vector is resized if necessary. See also GlossUserFlags.

◆ load_user_flags_hex() [1/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags_hex ( std::istream & in )

inherited

Load the user flags located on hexs. See also GlossUserFlags.

◆ load_user_flags_hex() [2/2]

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_flags_hex ( const std::vector< bool > & v )

inherited

Load the user flags located on hexs. See also GlossUserFlags.

◆ clear_user_data()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::clear_user_data ( )

inherited

Clear all user pointers and indices and allow the use of both for next access. See also GlossUserData.

◆ save_user_indices()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_indices ( std::vector< unsigned int > & v ) const

inherited

Save all user indices. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_indices()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_indices ( const std::vector< unsigned int > & v )

inherited

Read the information stored by save_user_indices(). See also GlossUserData.

◆ save_user_pointers()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_pointers ( std::vector< void * > & v ) const

inherited

Save all user pointers. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_pointers()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_pointers ( const std::vector< void * > & v )

inherited

Read the information stored by save_user_pointers(). See also GlossUserData.

◆ save_user_indices_line()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_indices_line ( std::vector< unsigned int > & v ) const

inherited

Save the user indices on lines. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_indices_line()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_indices_line ( const std::vector< unsigned int > & v )

inherited

Load the user indices located on lines. See also GlossUserData.

◆ save_user_indices_quad()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_indices_quad ( std::vector< unsigned int > & v ) const

inherited

Save the user indices on quads. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_indices_quad()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_indices_quad ( const std::vector< unsigned int > & v )

inherited

Load the user indices located on quads. See also GlossUserData.

◆ save_user_indices_hex()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_indices_hex ( std::vector< unsigned int > & v ) const

inherited

Save the user indices on hexes. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_indices_hex()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_indices_hex ( const std::vector< unsigned int > & v )

inherited

Load the user indices located on hexs. See also GlossUserData.

◆ save_user_pointers_line()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_pointers_line ( std::vector< void * > & v ) const

inherited

Save the user indices on lines. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_pointers_line()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_pointers_line ( const std::vector< void * > & v )

inherited

Load the user pointers located on lines. See also GlossUserData.

◆ save_user_pointers_quad()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_pointers_quad ( std::vector< void * > & v ) const

inherited

Save the user pointers on quads. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_pointers_quad()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_pointers_quad ( const std::vector< void * > & v )

inherited

Load the user pointers located on quads. See also GlossUserData.

◆ save_user_pointers_hex()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::save_user_pointers_hex ( std::vector< void * > & v ) const

inherited

Save the user pointers on hexes. The output vector is resized if necessary. See also GlossUserData.

◆ load_user_pointers_hex()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::load_user_pointers_hex ( const std::vector< void * > & v )

inherited

Load the user pointers located on hexs. See also GlossUserData.

◆ begin()

template<int dim, int spacedim = dim>

cell_iterator Triangulation< dim, spacedim >::begin ( const unsigned int level = 0 ) const

inherited

Iterator to the first used cell on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ begin_active()

template<int dim, int spacedim = dim>

active_cell_iterator Triangulation< dim, spacedim >::begin_active ( const unsigned int level = 0 ) const

inherited

Iterator to the first active cell on level level. If the given level does not contain any active cells (i.e., all cells on this level are further refined, then this function returns end_active(level) so that loops of the kind

for (const auto cell=tria.begin_active(level);
     cell!=tria.end_active(level);
     ++cell)
  {
    ...
  }

have zero iterations, as may be expected if there are no active cells on this level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ end() [1/2]

template<int dim, int spacedim = dim>

cell_iterator Triangulation< dim, spacedim >::end ( ) const

inherited

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

◆ end() [2/2]

template<int dim, int spacedim = dim>

cell_iterator Triangulation< dim, spacedim >::end ( const unsigned int level ) const

inherited

Return an iterator which is the first iterator not on level. If level is the last level, then this returns end().

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ end_active()

template<int dim, int spacedim = dim>

active_cell_iterator Triangulation< dim, spacedim >::end_active ( const unsigned int level ) const

inherited

Return an active iterator which is the first active iterator not on the given level. If level is the last level, then this returns end().

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ last()

template<int dim, int spacedim = dim>

cell_iterator Triangulation< dim, spacedim >::last ( ) const

inherited

Return an iterator pointing to the last used cell.

◆ last_active()

template<int dim, int spacedim = dim>

active_cell_iterator Triangulation< dim, spacedim >::last_active ( ) const

inherited

Return an iterator pointing to the last active cell.

◆ create_cell_iterator()

template<int dim, int spacedim = dim>

cell_iterator Triangulation< dim, spacedim >::create_cell_iterator ( const CellId & cell_id ) const

inherited

Return an iterator to a cell of this Triangulation object constructed from an independent CellId object.

If the given argument corresponds to a valid cell in this triangulation, this operation will always succeed for sequential triangulations where the current processor stores all cells that are part of the triangulation. On the other hand, if this is a parallel triangulation, then the current processor may not actually know about this cell. In this case, this operation will succeed for locally relevant cells, but may not for artificial cells that are less refined on the current processor.

◆ begin_face()

template<int dim, int spacedim = dim>

face_iterator Triangulation< dim, spacedim >::begin_face ( ) const

inherited

Iterator to the first used face.

◆ begin_active_face()

template<int dim, int spacedim = dim>

active_face_iterator Triangulation< dim, spacedim >::begin_active_face ( ) const

inherited

Iterator to the first active face.

◆ end_face()

template<int dim, int spacedim = dim>

face_iterator Triangulation< dim, spacedim >::end_face ( ) const

inherited

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

◆ begin_vertex()

template<int dim, int spacedim = dim>

vertex_iterator Triangulation< dim, spacedim >::begin_vertex ( ) const

inherited

Iterator to the first used vertex. This function can only be used if dim is not one.

◆ begin_active_vertex()

template<int dim, int spacedim = dim>

active_vertex_iterator Triangulation< dim, spacedim >::begin_active_vertex ( ) const

inherited

Iterator to the first active vertex. Because all vertices are active, begin_vertex() and begin_active_vertex() return the same vertex. This function can only be used if dim is not one.

◆ end_vertex()

template<int dim, int spacedim = dim>

vertex_iterator Triangulation< dim, spacedim >::end_vertex ( ) const

inherited

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states. This function can only be used if dim is not one.

◆ n_lines() [1/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_lines ( ) const

inherited

In the following, most functions are provided in two versions, with and without an argument describing the level. The versions with this argument are only applicable for objects describing the cells of the present triangulation. For example: in 2d n_lines(level) cannot be called, only n_lines(), as lines are faces in 2d and therefore have no level. Return the total number of used lines, active or not.

◆ n_lines() [2/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_lines ( const unsigned int level ) const

inherited

Return the total number of used lines, active or not on level level.

◆ n_active_lines() [1/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_lines ( ) const

inherited

Return the total number of active lines.

◆ n_active_lines() [2/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_lines ( const unsigned int level ) const

inherited

Return the total number of active lines, on level level.

◆ n_quads() [1/8]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_quads ( ) const

inherited

Return the total number of used quads, active or not.

◆ n_quads() [2/8]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_quads ( const unsigned int level ) const

inherited

Return the total number of used quads, active or not on level level.

◆ n_quads() [3/8]

unsigned int Triangulation< 1, 1 >::n_quads ( ) const

inherited

Definition at line 14116 of file tria.cc.

◆ n_quads() [4/8]

unsigned int Triangulation< 1, 1 >::n_quads ( const unsigned int ) const

inherited

Definition at line 14124 of file tria.cc.

◆ n_quads() [5/8]

unsigned int Triangulation< 1, 2 >::n_quads ( ) const

inherited

Definition at line 14165 of file tria.cc.

◆ n_quads() [6/8]

unsigned int Triangulation< 1, 2 >::n_quads ( const unsigned int ) const

inherited

Definition at line 14173 of file tria.cc.

◆ n_quads() [7/8]

unsigned int Triangulation< 1, 3 >::n_quads ( ) const

inherited

Definition at line 14213 of file tria.cc.

◆ n_quads() [8/8]

unsigned int Triangulation< 1, 3 >::n_quads ( const unsigned int ) const

inherited

Definition at line 14221 of file tria.cc.

◆ n_active_quads() [1/8]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_quads ( ) const

inherited

Return the total number of active quads, active or not.

◆ n_active_quads() [2/8]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_quads ( const unsigned int level ) const

inherited

Return the total number of active quads, active or not on level level.

◆ n_active_quads() [3/8]

unsigned int Triangulation< 1, 1 >::n_active_quads ( const unsigned int ) const

inherited

Definition at line 14148 of file tria.cc.

◆ n_active_quads() [4/8]

unsigned int Triangulation< 1, 1 >::n_active_quads ( ) const

inherited

Definition at line 14156 of file tria.cc.

◆ n_active_quads() [5/8]

unsigned int Triangulation< 1, 2 >::n_active_quads ( const unsigned int ) const

inherited

Definition at line 14197 of file tria.cc.

◆ n_active_quads() [6/8]

unsigned int Triangulation< 1, 2 >::n_active_quads ( ) const

inherited

Definition at line 14205 of file tria.cc.

◆ n_active_quads() [7/8]

unsigned int Triangulation< 1, 3 >::n_active_quads ( const unsigned int ) const

inherited

Definition at line 14245 of file tria.cc.

◆ n_active_quads() [8/8]

unsigned int Triangulation< 1, 3 >::n_active_quads ( ) const

inherited

Definition at line 14253 of file tria.cc.

◆ n_hexs() [1/4]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_hexs ( ) const

inherited

Return the total number of used hexahedra, active or not.

◆ n_hexs() [2/4]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_hexs ( const unsigned int level ) const

inherited

Return the total number of used hexahedra, active or not on level level.

◆ n_hexs() [3/4]

unsigned int Triangulation< 3, 3 >::n_hexs ( ) const

inherited

Definition at line 14394 of file tria.cc.

◆ n_hexs() [4/4]

unsigned int Triangulation< 3, 3 >::n_hexs ( const unsigned int level ) const

inherited

Definition at line 14403 of file tria.cc.

◆ n_active_hexs() [1/4]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_hexs ( ) const

inherited

Return the total number of active hexahedra, active or not.

◆ n_active_hexs() [2/4]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_hexs ( const unsigned int level ) const

inherited

Return the total number of active hexahedra, active or not on level level.

◆ n_active_hexs() [3/4]

unsigned int Triangulation< 3, 3 >::n_active_hexs ( ) const

inherited

Definition at line 14423 of file tria.cc.

◆ n_active_hexs() [4/4]

unsigned int Triangulation< 3, 3 >::n_active_hexs ( const unsigned int level ) const

inherited

Definition at line 14432 of file tria.cc.

◆ n_cells() [1/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_cells ( ) const

inherited

Return the total number of used cells, active or not. Maps to n_lines() in one space dimension and so on.

◆ n_cells() [2/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_cells ( const unsigned int level ) const

inherited

Return the total number of used cells, active or not, on level level. Maps to n_lines(level) in one space dimension and so on.

◆ n_active_cells() [1/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_cells ( ) const

inherited

Return the total number of active cells. Maps to n_active_lines() in one space dimension and so on.

◆ n_active_cells() [2/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_cells ( const unsigned int level ) const

inherited

Return the total number of active cells on level level. Maps to n_active_lines(level) in one space dimension and so on.

◆ n_faces()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_faces ( ) const

inherited

Return the total number of used faces, active or not. In 2d, the result equals n_lines(), in 3d it equals n_quads(), while in 1d it equals the number of used vertices.

◆ n_active_faces()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_active_faces ( ) const

inherited

Return the total number of active faces. In 2d, the result equals n_active_lines(), in 3d it equals n_active_quads(), while in 1d it equals the number of used vertices.

◆ n_levels()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_levels ( ) const

inherited

Return the number of levels in this triangulation.

Note: Internally, triangulations store data in levels, and there may be more levels in this data structure than one may think – for example, imagine a triangulation that we just got by coarsening the highest level so that it was completely depopulated. That level is not removed, since it will most likely be repopulated soon by the next refinement process. As a consequence, if you happened to run through raw cell iterators (which you can't do as a user of this class, but can internally), then the number of objects in the levels hierarchy is larger than the level of the most refined cell plus one. On the other hand, since this is rarely what a user of this class cares about, the function really just returns the level of the most refined active cell plus one. (The plus one is because in a coarse, unrefined mesh, all cells have level zero – making the number of levels equal to one.)

◆ n_vertices()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_vertices ( ) const

inherited

Return the total number of vertices. Some of them may not be used, which usually happens upon coarsening of a triangulation when some vertices are discarded, but we do not want to renumber the remaining ones, leading to holes in the numbers of used vertices. You can get the number of used vertices using n_used_vertices function.

◆ get_vertices()

template<int dim, int spacedim = dim>

const std::vector< Point< spacedim > > & Triangulation< dim, spacedim >::get_vertices ( ) const

inherited

Return a constant reference to all the vertices present in this triangulation. Note that not necessarily all vertices in this array are actually used; for example, if you coarsen a mesh, then some vertices are deleted, but their positions in this array are unchanged as the indices of vertices are only allocated once. You can find out about which vertices are actually used by the function get_used_vertices().

◆ n_used_vertices()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_used_vertices ( ) const

inherited

Return the number of vertices that are presently in use, i.e. belong to at least one used element.

◆ vertex_used()

template<int dim, int spacedim = dim>

bool Triangulation< dim, spacedim >::vertex_used ( const unsigned int index ) const

inherited

Return true if the vertex with this index is used.

◆ get_used_vertices()

template<int dim, int spacedim = dim>

const std::vector< bool > & Triangulation< dim, spacedim >::get_used_vertices ( ) const

inherited

Return a constant reference to the array of bools indicating whether an entry in the vertex array is used or not.

◆ max_adjacent_cells() [1/4]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::max_adjacent_cells ( ) const

inherited

Return the maximum number of cells meeting at a common vertex. Since this number is an invariant under refinement, only the cells on the coarsest level are considered. The operation is thus reasonably fast. The invariance is only true for sufficiently many cells in the coarsest triangulation (e.g. for a single cell one would be returned), so a minimum of four is returned in two dimensions, 8 in three dimensions, etc, which is how many cells meet if the triangulation is refined.

In one space dimension, two is returned.

◆ max_adjacent_cells() [2/4]

unsigned int Triangulation< 1, 1 >::max_adjacent_cells ( ) const

inherited

Definition at line 14461 of file tria.cc.

◆ max_adjacent_cells() [3/4]

unsigned int Triangulation< 1, 2 >::max_adjacent_cells ( ) const

inherited

Definition at line 14470 of file tria.cc.

◆ max_adjacent_cells() [4/4]

unsigned int Triangulation< 1, 3 >::max_adjacent_cells ( ) const

inherited

Definition at line 14478 of file tria.cc.

◆ get_triangulation() [1/2]

template<int dim, int spacedim = dim>

Triangulation< dim, spacedim > & Triangulation< dim, spacedim >::get_triangulation ( )

inherited

Return a reference to the current object.

This doesn't seem to be very useful but allows to write code that can access the underlying triangulation for anything that satisfies the MeshType concept (which may not only be a triangulation, but also a DoFHandler, for example).

◆ get_triangulation() [2/2]

template<int dim, int spacedim = dim>

const Triangulation< dim, spacedim > & Triangulation< dim, spacedim >::get_triangulation ( ) const

inherited

Return a reference to the current object. This is the const-version of the previous function.

◆ n_raw_lines() [1/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_lines ( ) const

inherited

Total number of lines, used or unused.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ n_raw_lines() [2/2]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_lines ( const unsigned int level ) const

inherited

Number of lines, used or unused, on the given level.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ n_raw_quads() [1/9]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_quads ( ) const

inherited

Total number of quads, used or unused.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ n_raw_quads() [2/9]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_quads ( const unsigned int level ) const

inherited

Number of quads, used or unused, on the given level.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ n_raw_quads() [3/9]

unsigned int Triangulation< 1, 1 >::n_raw_quads ( const unsigned int ) const

inherited

Definition at line 14132 of file tria.cc.

◆ n_raw_quads() [4/9]

unsigned int Triangulation< 1, 2 >::n_raw_quads ( const unsigned int ) const

inherited

Definition at line 14181 of file tria.cc.

◆ n_raw_quads() [5/9]

unsigned int Triangulation< 1, 3 >::n_raw_quads ( const unsigned int ) const

inherited

Definition at line 14229 of file tria.cc.

◆ n_raw_quads() [6/9]

unsigned int Triangulation< 2, 2 >::n_raw_quads ( const unsigned int level ) const

inherited

Definition at line 14282 of file tria.cc.

◆ n_raw_quads() [7/9]

unsigned int Triangulation< 2, 3 >::n_raw_quads ( const unsigned int level ) const

inherited

Definition at line 14292 of file tria.cc.

◆ n_raw_quads() [8/9]

unsigned int Triangulation< 3, 3 >::n_raw_quads ( const unsigned int ) const

inherited

Definition at line 14301 of file tria.cc.

◆ n_raw_quads() [9/9]

unsigned int Triangulation< 3, 3 >::n_raw_quads ( ) const

inherited

Definition at line 14321 of file tria.cc.

◆ n_raw_hexs() [1/5]

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_hexs ( const unsigned int level ) const

inherited

Number of hexs, used or unused, on the given level.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ n_raw_hexs() [2/5]

unsigned int Triangulation< 1, 1 >::n_raw_hexs ( const unsigned int ) const

inherited

Definition at line 14140 of file tria.cc.

◆ n_raw_hexs() [3/5]

unsigned int Triangulation< 1, 2 >::n_raw_hexs ( const unsigned int ) const

inherited

Definition at line 14189 of file tria.cc.

◆ n_raw_hexs() [4/5]

unsigned int Triangulation< 1, 3 >::n_raw_hexs ( const unsigned int ) const

inherited

Definition at line 14237 of file tria.cc.

◆ n_raw_hexs() [5/5]

unsigned int Triangulation< 3, 3 >::n_raw_hexs ( const unsigned int level ) const

inherited

Definition at line 14414 of file tria.cc.

◆ n_raw_cells()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_cells ( const unsigned int level ) const

inherited

Number of cells, used or unused, on the given level.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ n_raw_faces()

template<int dim, int spacedim = dim>

unsigned int Triangulation< dim, spacedim >::n_raw_faces ( ) const

inherited

Return the total number of faces, used or not. In 2d, the result equals n_raw_lines(), in 3d it equals n_raw_quads(), while in 1d it equals the number of vertices.

Note: This function really exports internal information about the triangulation. It shouldn't be used in applications. The function is only part of the public interface of this class because it is used in some of the other classes that build very closely on it (in particular, the DoFHandler class).

◆ save() [2/2]

template<int dim, int spacedim = dim>

template<class Archive >

void Triangulation< dim, spacedim >::save	(	Archive &	ar,
		const unsigned int	version
	)		const

inherited

Write the data of this object to a stream for the purpose of serialization using the BOOST serialization library.

Note: This function does not save all member variables of the current triangulation. Rather, only certain kinds of information are stored. For more information see the general documentation of this class.

◆ load() [3/3]

template<int dim, int spacedim = dim>

template<class Archive >

void Triangulation< dim, spacedim >::load	(	Archive &	ar,
		const unsigned int	version
	)

inherited

Read the data of this object from a stream for the purpose of serialization using the BOOST serialization library. Throw away the previous content.

Note: This function does not reset all member variables of the current triangulation to the ones of the triangulation that was previously stored to an archive. Rather, only certain kinds of information are loaded. For more information see the general documentation of this class.; This function calls the Triangulation::clear() function and consequently triggers the "clear" signal. After loading all data from the archive, it then triggers the "create" signal. For more information on signals, see the general documentation of this class.

◆ add_periodicity()

template<int dim, int spacedim = dim>

virtual void Triangulation< dim, spacedim >::add_periodicity ( const std::vector< GridTools::PeriodicFacePair< cell_iterator > > & )

virtualinherited

Declare the (coarse) face pairs given in the argument of this function as periodic. This way it is possible to obtain neighbors across periodic boundaries.

The vector can be filled by the function GridTools::collect_periodic_faces.

For more information on periodic boundary conditions see GridTools::collect_periodic_faces, DoFTools::make_periodicity_constraints and step-45.

Note: Before this function can be used the Triangulation has to be initialized and must not be refined.

◆ get_periodic_face_map()

template<int dim, int spacedim = dim>

const std::map< std::pair< cell_iterator, unsigned int >, std::pair< std::pair< cell_iterator, unsigned int >, std::bitset< 3 > > > & Triangulation< dim, spacedim >::get_periodic_face_map ( ) const

inherited

Return the periodic_face_map.

◆ get_reference_cells()

template<int dim, int spacedim = dim>

const std::vector< ReferenceCell > & Triangulation< dim, spacedim >::get_reference_cells ( ) const

inherited

Return vector filled with the used reference-cell types of this triangulation.

◆ all_reference_cells_are_hyper_cube()

template<int dim, int spacedim = dim>

bool Triangulation< dim, spacedim >::all_reference_cells_are_hyper_cube ( ) const

inherited

Indicate if the triangulation only consists of hypercube-like cells, i.e., lines, quadrilaterals, or hexahedra.

◆ all_reference_cells_are_simplex()

template<int dim, int spacedim = dim>

bool Triangulation< dim, spacedim >::all_reference_cells_are_simplex ( ) const

inherited

Indicate if the triangulation only consists of simplex-like cells, i.e., lines, triangles, or tetrahedra.

◆ is_mixed_mesh()

template<int dim, int spacedim = dim>

bool Triangulation< dim, spacedim >::is_mixed_mesh ( ) const

inherited

Indicate if the triangulation consists of different cell types (mix of simplices, hypercubes, ...) or different face types, as in the case of pyramids or wedges..

◆ serialize()

template<int dim, int spacedim = dim>

template<class Archive >

void Triangulation< dim, spacedim >::serialize	(	Archive &	archive,
		const unsigned int	version
	)

inherited

Write and read the data of this object from a stream for the purpose of serialization. using the BOOST serialization library.

◆ write_bool_vector()

template<int dim, int spacedim = dim>

static void Triangulation< dim, spacedim >::write_bool_vector	(	const unsigned int	magic_number1,
		const std::vector< bool > &	v,
		const unsigned int	magic_number2,
		std::ostream &	out
	)

staticprotectedinherited

Write a bool vector to the given stream, writing a pre- and a postfix magic number. The vector is written in an almost binary format, i.e. the bool flags are packed but the data is written as ASCII text.

The flags are stored in a binary format: for each true, a 1 bit is stored, a 0 bit otherwise. The bits are stored as unsigned char, thus avoiding endianness. They are written to out in plain text, thus amounting to 3.6 bits in the output per bits in the input on the average. Other information (magic numbers and number of elements of the input vector) is stored as plain text as well. The format should therefore be interplatform compatible.

◆ read_bool_vector()

template<int dim, int spacedim = dim>

static void Triangulation< dim, spacedim >::read_bool_vector	(	const unsigned int	magic_number1,
		std::vector< bool > &	v,
		const unsigned int	magic_number2,
		std::istream &	in
	)

staticprotectedinherited

Re-read a vector of bools previously written by write_bool_vector and compare with the magic numbers.

◆ update_periodic_face_map()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::update_periodic_face_map ( )

protectedinherited

Recreate information about periodic neighbors from periodic_face_pairs_level_0.

◆ begin_raw()

template<int dim, int spacedim = dim>

raw_cell_iterator Triangulation< dim, spacedim >::begin_raw ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first cell, used or not, on level level. If a level has no cells, a past-the-end iterator is returned.

◆ end_raw()

template<int dim, int spacedim = dim>

raw_cell_iterator Triangulation< dim, spacedim >::end_raw ( const unsigned int level ) const

privateinherited

Return a raw iterator which is the first iterator not on level. If level is the last level, then this returns end().

◆ begin_raw_line()

template<int dim, int spacedim = dim>

raw_line_iterator Triangulation< dim, spacedim >::begin_raw_line ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first line, used or not, on level level. If a level has no lines, a past-the-end iterator is returned. If lines are no cells, i.e. for dim>1 no level argument must be given. The same applies for all the other functions above, of course.

◆ begin_line()

template<int dim, int spacedim = dim>

line_iterator Triangulation< dim, spacedim >::begin_line ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first used line on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ begin_active_line()

template<int dim, int spacedim = dim>

active_line_iterator Triangulation< dim, spacedim >::begin_active_line ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first active line on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ end_line()

template<int dim, int spacedim = dim>

line_iterator Triangulation< dim, spacedim >::end_line ( ) const

privateinherited

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

◆ begin_raw_quad()

template<int dim, int spacedim = dim>

raw_quad_iterator Triangulation< dim, spacedim >::begin_raw_quad ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first quad, used or not, on the given level. If a level has no quads, a past-the-end iterator is returned. If quads are no cells, i.e. for \(dim>2\) no level argument must be given.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ begin_quad()

template<int dim, int spacedim = dim>

quad_iterator Triangulation< dim, spacedim >::begin_quad ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first used quad on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ begin_active_quad()

template<int dim, int spacedim = dim>

active_quad_iterator Triangulation< dim, spacedim >::begin_active_quad ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first active quad on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ end_quad()

template<int dim, int spacedim = dim>

quad_iterator Triangulation< dim, spacedim >::end_quad ( ) const

privateinherited

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

◆ begin_raw_hex()

template<int dim, int spacedim = dim>

raw_hex_iterator Triangulation< dim, spacedim >::begin_raw_hex ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first hex, used or not, on level level. If a level has no hexes, a past-the-end iterator is returned.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ begin_hex()

template<int dim, int spacedim = dim>

hex_iterator Triangulation< dim, spacedim >::begin_hex ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first used hex on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ begin_active_hex()

template<int dim, int spacedim = dim>

active_hex_iterator Triangulation< dim, spacedim >::begin_active_hex ( const unsigned int level = 0 ) const

privateinherited

Iterator to the first active hex on level level.

Note: The given level argument needs to correspond to a level of the triangulation, i.e., should be less than the value returned by n_levels(). On the other hand, for parallel computations using a parallel::distributed::Triangulation object, it is often convenient to write loops over the cells of all levels of the global mesh, even if the local portion of the triangulation does not actually have cells at one of the higher levels. In those cases, the level argument is accepted if it is less than what the n_global_levels() function returns. If the given level is between the values returned by n_levels() and n_global_levels(), then no cells exist in the local portion of the triangulation at this level, and the function simply returns what end() would return.

◆ end_hex()

template<int dim, int spacedim = dim>

hex_iterator Triangulation< dim, spacedim >::end_hex ( ) const

privateinherited

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

◆ clear_despite_subscriptions()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::clear_despite_subscriptions ( )

privateinherited

The (public) function clear() will only work when the triangulation is not subscribed to by other users. The clear_despite_subscriptions() function now allows the triangulation being cleared even when there are subscriptions.

Make sure, you know what you do, when calling this function, as its use is reasonable in very rare cases, only. For example, when the subscriptions were for the initially empty Triangulation and the Triangulation object wants to release its memory before throwing an assertion due to input errors (e.g. in the create_triangulation() function).

◆ reset_policy()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::reset_policy ( )

privateinherited

Reset triangulation policy.

◆ reset_active_cell_indices()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::reset_active_cell_indices ( )

privateinherited

For all cells, set the active cell indices so that active cells know the how many-th active cell they are, and all other cells have an invalid value. This function is called after mesh creation, refinement, and serialization.

◆ reset_cell_vertex_indices_cache()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::reset_cell_vertex_indices_cache ( )

privateinherited

Reset cache for the cells' vertex indices.

◆ execute_refinement()

template<int dim, int spacedim = dim>

DistortedCellList Triangulation< dim, spacedim >::execute_refinement ( )

privateinherited

Refine all cells on all levels which were previously flagged for refinement.

Note, that this function uses the line->user_flags for dim=2,3 and the quad->user_flags for dim=3.

The function returns a list of cells that have produced children that satisfy the criteria of distorted cells if the check_for_distorted_cells flag was specified upon creation of this object, at

◆ execute_coarsening()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::execute_coarsening ( )

privateinherited

Coarsen all cells which were flagged for coarsening, or rather: delete all children of those cells of which all child cells are flagged for coarsening and several other constraints hold (see the general doc of this class).

◆ fix_coarsen_flags()

template<int dim, int spacedim = dim>

void Triangulation< dim, spacedim >::fix_coarsen_flags ( )

privateinherited

Make sure that either all or none of the children of a cell are tagged for coarsening.

◆ coarse_cell_id_to_coarse_cell_index()

template<int dim, int spacedim = dim>

virtual unsigned int Triangulation< dim, spacedim >::coarse_cell_id_to_coarse_cell_index ( const types::coarse_cell_id coarse_cell_id ) const

privatevirtualinherited

Translate the unique id of a coarse cell to its index. See the glossary entry on coarse cell IDs for more information.

Note: For serial and shared triangulation both id and index are the same. For distributed triangulations setting both might differ, since the id might correspond to a global id and the index to a local id.

Parameters

coarse_cell_id Unique id of the coarse cell.

Returns: Index of the coarse cell within the current triangulation.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ coarse_cell_index_to_coarse_cell_id()

template<int dim, int spacedim = dim>

virtual types::coarse_cell_id Triangulation< dim, spacedim >::coarse_cell_index_to_coarse_cell_id ( const unsigned int coarse_cell_index ) const

privatevirtualinherited

Translate the index of coarse cell to its unique id. See the glossary entry on coarse cell IDs for more information.

Note: See the note of the method coarse_cell_id_to_coarse_cell_index().

Parameters

coarse_cell_index Index of the coarse cell.

Returns: Id of the coarse cell.

Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< 1, spacedim >.

◆ subscribe()

void Subscriptor::subscribe	(	std::atomic< bool > *const	validity,
		const std::string &	identifier = `""`
	)		const

inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe	(	std::atomic< bool > *const	validity,
		const std::string &	identifier = `""`
	)		const

inherited

Unsubscribes a user from the object.

Note: The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const

inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void Subscriptor::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

◆ check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const

privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note: Since this function is just a consistency check it does nothing in release mode.; If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

Member Data Documentation

◆ local_cell_relations

template<int dim, int spacedim = dim>

std::vector<cell_relation_t> parallel::DistributedTriangulationBase< dim, spacedim >::local_cell_relations

protected

Vector of pairs, each containing a deal.II cell iterator and its respective CellStatus. To update its contents, use the update_cell_relations() member function.

Definition at line 735 of file tria_base.h.

◆ cell_attached_data

template<int dim, int spacedim = dim>

CellAttachedData parallel::DistributedTriangulationBase< dim, spacedim >::cell_attached_data

protected

Definition at line 768 of file tria_base.h.

◆ data_transfer

template<int dim, int spacedim = dim>

DataTransfer parallel::DistributedTriangulationBase< dim, spacedim >::data_transfer

protected

Definition at line 923 of file tria_base.h.

◆ mpi_communicator

template<int dim, int spacedim = dim>

const MPI_Comm parallel::TriangulationBase< dim, spacedim >::mpi_communicator

protectedinherited

MPI communicator to be used for the triangulation. We create a unique communicator for this class, which is a duplicate of the one passed to the constructor.

Definition at line 296 of file tria_base.h.

◆ my_subdomain

template<int dim, int spacedim = dim>

types::subdomain_id parallel::TriangulationBase< dim, spacedim >::my_subdomain

protectedinherited

The subdomain id to be used for the current processor. This is the MPI rank.

Definition at line 302 of file tria_base.h.

◆ n_subdomains

template<int dim, int spacedim = dim>

types::subdomain_id parallel::TriangulationBase< dim, spacedim >::n_subdomains

protectedinherited

The total number of subdomains (or the size of the MPI communicator).

Definition at line 307 of file tria_base.h.

◆ number_cache

template<int dim, int spacedim = dim>

NumberCache parallel::TriangulationBase< dim, spacedim >::number_cache

protectedinherited

Definition at line 365 of file tria_base.h.

◆ dimension

template<int dim, int spacedim = dim>

constexpr unsigned int Triangulation< dim, spacedim >::dimension = dim

staticconstexprinherited

Make the dimension available in function templates.

Definition at line 1557 of file tria.h.

◆ space_dimension

template<int dim, int spacedim = dim>

constexpr unsigned int Triangulation< dim, spacedim >::space_dimension = spacedim

staticconstexprinherited

Make the space-dimension available in function templates.

Definition at line 1562 of file tria.h.

◆ signals

template<int dim, int spacedim = dim>

Signals Triangulation< dim, spacedim >::signals

mutableinherited

Signals for the various actions that a triangulation can do to itself.

Definition at line 2479 of file tria.h.

◆ smooth_grid

template<int dim, int spacedim = dim>

MeshSmoothing Triangulation< dim, spacedim >::smooth_grid

protectedinherited

Do some smoothing in the process of refining the triangulation. See the general doc of this class for more information about this.

Definition at line 3731 of file tria.h.

◆ reference_cells

template<int dim, int spacedim = dim>

std::vector<ReferenceCell> Triangulation< dim, spacedim >::reference_cells

protectedinherited

Vector caching all reference-cell types of the given triangulation (also in the distributed case).

Definition at line 3737 of file tria.h.

◆ policy

template<int dim, int spacedim = dim>

std::unique_ptr< ::internal::TriangulationImplementation::Policy<dim, spacedim> > Triangulation< dim, spacedim >::policy

privateinherited

Policy with the Triangulation-specific tasks related to creation, refinement, and coarsening.

Definition at line 3789 of file tria.h.

◆ periodic_face_pairs_level_0

template<int dim, int spacedim = dim>

std::vector<GridTools::PeriodicFacePair<cell_iterator> > Triangulation< dim, spacedim >::periodic_face_pairs_level_0

privateinherited

If add_periodicity() is called, this variable stores the given periodic face pairs on level 0 for later access during the identification of ghost cells for the multigrid hierarchy and for setting up the periodic_face_map.

Definition at line 3798 of file tria.h.

◆ periodic_face_map

template<int dim, int spacedim = dim>

std::map<std::pair<cell_iterator, unsigned int>, std::pair<std::pair<cell_iterator, unsigned int>, std::bitset<3> > > Triangulation< dim, spacedim >::periodic_face_map

privateinherited

If add_periodicity() is called, this variable stores the active periodic face pairs.

Definition at line 3806 of file tria.h.

◆ levels

template<int dim, int spacedim = dim>

std::vector< std::unique_ptr<::internal::TriangulationImplementation::TriaLevel> > Triangulation< dim, spacedim >::levels

privateinherited

Array of pointers pointing to the objects storing the cell data on the different levels.

Definition at line 4184 of file tria.h.

◆ faces

template<int dim, int spacedim = dim>

std::unique_ptr<::internal::TriangulationImplementation::TriaFaces> Triangulation< dim, spacedim >::faces

privateinherited

Pointer to the faces of the triangulation. In 1d this contains nothing, in 2d it contains data concerning lines and in 3d quads and lines. All of these have no level and are therefore treated separately.

Definition at line 4192 of file tria.h.

◆ vertices

template<int dim, int spacedim = dim>

std::vector<Point<spacedim> > Triangulation< dim, spacedim >::vertices

privateinherited

Array of the vertices of this triangulation.

Definition at line 4198 of file tria.h.

◆ vertices_used

template<int dim, int spacedim = dim>

std::vector<bool> Triangulation< dim, spacedim >::vertices_used

privateinherited

Array storing a bit-pattern which vertices are used.

Definition at line 4203 of file tria.h.

◆ manifolds

template<int dim, int spacedim = dim>

std::map<types::manifold_id, std::unique_ptr<const Manifold<dim, spacedim> > > Triangulation< dim, spacedim >::manifolds

privateinherited

Collection of manifold objects. We store only objects, which are not of type FlatManifold.

Definition at line 4210 of file tria.h.

◆ anisotropic_refinement

template<int dim, int spacedim = dim>

bool Triangulation< dim, spacedim >::anisotropic_refinement

privateinherited

Flag indicating whether anisotropic refinement took place.

Definition at line 4215 of file tria.h.

◆ check_for_distorted_cells

template<int dim, int spacedim = dim>

const bool Triangulation< dim, spacedim >::check_for_distorted_cells

privateinherited

A flag that determines whether we are to check for distorted cells upon creation and refinement of a mesh.

Definition at line 4222 of file tria.h.

◆ vertex_to_boundary_id_map_1d

template<int dim, int spacedim = dim>

std::unique_ptr<std::map<unsigned int, types::boundary_id> > Triangulation< dim, spacedim >::vertex_to_boundary_id_map_1d

privateinherited

A map that relates the number of a boundary vertex to the boundary indicator. This field is only used in 1d. We have this field because we store boundary indicator information with faces in 2d and higher where we have space in the structures that store data for faces, but in 1d there is no such space for faces.

The field is declared as a pointer for a rather mundane reason: all other fields of this class that can be modified by the TriaAccessor hierarchy are pointers, and so these accessor classes store a const pointer to the triangulation. We could no longer do so for TriaAccessor<0,1,spacedim> if this field (that can be modified by TriaAccessor::set_boundary_id) were not a pointer.

Definition at line 4250 of file tria.h.

◆ vertex_to_manifold_id_map_1d

template<int dim, int spacedim = dim>

std::unique_ptr<std::map<unsigned int, types::manifold_id> > Triangulation< dim, spacedim >::vertex_to_manifold_id_map_1d

privateinherited

A map that relates the number of a boundary vertex to the manifold indicator. This field is only used in 1d. We have this field because we store manifold indicator information with faces in 2d and higher where we have space in the structures that store data for faces, but in 1d there is no such space for faces.

Note: Manifold objects are pretty useless for points since they are neither refined nor are their interiors mapped. We nevertheless allow storing manifold ids for points to be consistent in dimension-independent programs.

The field is declared as a pointer for a rather mundane reason: all other fields of this class that can be modified by the TriaAccessor hierarchy are pointers, and so these accessor classes store a const pointer to the triangulation. We could no longer do so for TriaAccessor<0,1,spacedim> if this field (that can be modified by TriaAccessor::set_manifold_id) were not a pointer.

Definition at line 4273 of file tria.h.

◆ counter

std::atomic<unsigned int> Subscriptor::counter

mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 219 of file subscriptor.h.

◆ counter_map

std::map<std::string, unsigned int> Subscriptor::counter_map

mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

◆ validity_pointers

std::vector<std::atomic<bool> *> Subscriptor::validity_pointers

mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::object_info

mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 249 of file subscriptor.h.

◆ mutex

std::mutex Subscriptor::mutex

staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.

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

include/deal.II/distributed/tria_base.h
source/distributed/tria_base.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Exceptions

Cell iterator functions for internal use

Hex iterator functions for internal use

Detailed Description

Member Typedef Documentation

◆ cell_iterator

◆ CellStatus

◆ cell_relation_t

◆ IteratorSelector

◆ level_cell_iterator

◆ raw_cell_iterator

◆ raw_face_iterator

◆ raw_vertex_iterator

◆ raw_line_iterator

◆ raw_quad_iterator

◆ raw_hex_iterator

◆ map_value_type

◆ map_iterator

Member Enumeration Documentation

◆ MeshSmoothing

Constructor & Destructor Documentation

◆ DistributedTriangulationBase()

Member Function Documentation

◆ clear()

◆ has_hanging_nodes()

◆ save() [1/2]

◆ load() [1/3]

◆ load() [2/3]

◆ register_data_attach()

◆ notify_ready_to_unpack()

◆ save_attached_data()

◆ load_attached_data()

◆ update_cell_relations()

◆ get_communicator()

◆ is_multilevel_hierarchy_constructed()

◆ copy_triangulation() [1/2]

◆ copy_triangulation() [2/2]

◆ n_locally_owned_active_cells()

◆ n_global_active_cells()

◆ memory_consumption()

◆ n_global_levels()

◆ locally_owned_subdomain()

◆ ghost_owners()

◆ level_ghost_owners()

◆ global_active_cell_index_partitioner()

◆ global_level_cell_index_partitioner()

◆ get_boundary_ids()

◆ get_manifold_ids()

◆ communicate_locally_moved_vertices()

◆ n_global_coarse_cells()

◆ update_number_cache()

◆ update_reference_cells()

◆ reset_global_cell_indices()

◆ set_mesh_smoothing()

◆ get_mesh_smoothing()

◆ create_triangulation() [1/2]

◆ create_triangulation() [2/2]

◆ create_triangulation_compatibility()

◆ flip_all_direction_flags()

◆ set_all_refine_flags()

◆ refine_global()

◆ coarsen_global()

◆ execute_coarsening_and_refinement()

◆ prepare_coarsening_and_refinement() [1/4]

◆ prepare_coarsening_and_refinement() [2/4]

◆ prepare_coarsening_and_refinement() [3/4]

◆ prepare_coarsening_and_refinement() [4/4]