Reference documentation for deal.II version Git 3f1f337db3 20211023 13:19:02 0600

#include <deal.II/distributed/tria_base.h>
Classes  
struct  NumberCache 
Public Member Functions  
TriangulationBase (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  ~TriangulationBase () override 
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 
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 
const std::weak_ptr< const Utilities::MPI::Partitioner >  global_level_cell_index_partitioner (const unsigned int level) const 
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  clear () 
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  copy_triangulation (const Triangulation< dim, spacedim > &other_tria) 
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 () 
template<>  
bool  prepare_coarsening_and_refinement () 
template<>  
bool  prepare_coarsening_and_refinement () 
template<>  
bool  prepare_coarsening_and_refinement () 
template<>  
unsigned int  n_quads () const 
template<>  
unsigned int  n_quads (const unsigned int) const 
template<>  
unsigned int  n_quads () const 
template<>  
unsigned int  n_quads (const unsigned int) const 
template<>  
unsigned int  n_quads () const 
template<>  
unsigned int  n_quads (const unsigned int) const 
template<>  
unsigned int  n_active_quads (const unsigned int) const 
template<>  
unsigned int  n_active_quads () const 
template<>  
unsigned int  n_active_quads (const unsigned int) const 
template<>  
unsigned int  n_active_quads () const 
template<>  
unsigned int  n_active_quads (const unsigned int) const 
template<>  
unsigned int  n_active_quads () const 
template<>  
unsigned int  n_hexs () const 
template<>  
unsigned int  n_hexs (const unsigned int level) const 
template<>  
unsigned int  n_active_hexs () const 
template<>  
unsigned int  n_active_hexs (const unsigned int level) const 
template<>  
unsigned int  max_adjacent_cells () const 
template<>  
unsigned int  max_adjacent_cells () const 
template<>  
unsigned int  max_adjacent_cells () const 
template<>  
unsigned int  n_raw_quads (const unsigned int) const 
template<>  
unsigned int  n_raw_quads (const unsigned int) const 
template<>  
unsigned int  n_raw_quads (const unsigned int) const 
template<>  
unsigned int  n_raw_quads (const unsigned int level) const 
template<>  
unsigned int  n_raw_quads (const unsigned int level) const 
template<>  
unsigned int  n_raw_quads (const unsigned int) const 
template<>  
unsigned int  n_raw_quads () const 
template<>  
unsigned int  n_raw_hexs (const unsigned int) const 
template<>  
unsigned int  n_raw_hexs (const unsigned int) const 
template<>  
unsigned int  n_raw_hexs (const unsigned int) const 
template<>  
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 
virtual bool  has_hanging_nodes () 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 
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) 
Static Public Attributes  
static const unsigned int  dimension = dim 
static const unsigned int  space_dimension = spacedim 
Protected Member Functions  
virtual void  update_number_cache () 
void  update_reference_cells () override 
void  reset_global_cell_indices () 
Protected Attributes  
const MPI_Comm  mpi_communicator 
types::subdomain_id  my_subdomain 
types::subdomain_id  n_subdomains 
NumberCache  number_cache 
Keeping up with what happens to a triangulation  
enum  CellStatus { CELL_PERSIST, CELL_REFINE, CELL_COARSEN, CELL_INVALID } 
Signals  signals 
Exceptions  
MeshSmoothing  smooth_grid 
std::vector< ReferenceCell >  reference_cells 
void  update_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) 
This class describes the interface for all triangulation classes that work in parallel, namely parallel::distributed::Triangulation, parallel::fullydistributed::Triangulation, and parallel::shared::Triangulation.
It is, consequently, a class that can be used to test whether a pointer of reference to a triangulation object refers to a sequential triangulation, or whether the triangulation is in fact parallel. In other words, one could write a function like this:
All parallel triangulations share certain traits, such as the fact that they communicate via MPI communicators or that they have locally owned, ghost, and possibly artificial cells. This class provides a number of member functions that allows querying some information about the triangulation that is independent of how exactly a parallel triangulation is implemented (i.e., which of the various classes derived from the current one it actually is).
Definition at line 78 of file tria_base.h.

inherited 

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^{2}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 nonsubsequent 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 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 step30. 
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. 

inherited 
Used to inform functions in derived classes how the cell with the given cell_iterator is going to change. Note that this may me different than the refine_flag() and coarsen_flag() in the cell_iterator in parallel calculations because of refinement constraints that this machine does not see.
parallel::TriangulationBase< dim, spacedim >::TriangulationBase  (  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 45 of file tria_base.cc.

overridevirtual 
Destructor.
Definition at line 103 of file tria_base.cc.

overridevirtual 
Return MPI communicator used by this triangulation.
Reimplemented from Triangulation< dim, spacedim >.
Definition at line 141 of file tria_base.cc.

pure virtual 
Return if multilevel hierarchy is supported and has been constructed.
Implemented in parallel::distributed::Triangulation< 1, spacedim >, parallel::distributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim >, parallel::shared::Triangulation< dim, spacedim >, and parallel::fullydistributed::Triangulation< dim, spacedim >.

overridevirtual 
Implementation of the same function as in the base class.
Definition at line 65 of file tria_base.cc.
unsigned int parallel::TriangulationBase< dim, spacedim >::n_locally_owned_active_cells  (  )  const 
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 120 of file tria_base.cc.

overridevirtual 
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 134 of file tria_base.cc.

overridevirtual 
Return the local memory consumption in bytes.
Reimplemented from Triangulation< dim, spacedim >.
Reimplemented in parallel::distributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim >, and parallel::fullydistributed::Triangulation< dim, spacedim >.
Definition at line 90 of file tria_base.cc.

overridevirtual 
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 127 of file tria_base.cc.

overridevirtual 
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 318 of file tria_base.cc.
const std::set< types::subdomain_id > & parallel::TriangulationBase< dim, spacedim >::ghost_owners  (  )  const 
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 327 of file tria_base.cc.
const std::set< types::subdomain_id > & parallel::TriangulationBase< dim, spacedim >::level_ghost_owners  (  )  const 
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
.
Definition at line 336 of file tria_base.cc.
const std::weak_ptr< const Utilities::MPI::Partitioner > parallel::TriangulationBase< dim, spacedim >::global_active_cell_index_partitioner  (  )  const 
Return partitioner for the global indices of the cells on the active level of the triangulation.
Definition at line 632 of file tria_base.cc.
const std::weak_ptr< const Utilities::MPI::Partitioner > parallel::TriangulationBase< dim, spacedim >::global_level_cell_index_partitioner  (  const unsigned int  level  )  const 
Return partitioner for the global indices of the cells on the given level
of the triangulation.
Definition at line 639 of file tria_base.cc.

overridevirtual 
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).
Reimplemented from Triangulation< dim, spacedim >.
Definition at line 345 of file tria_base.cc.

overridevirtual 
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).
Reimplemented from Triangulation< dim, spacedim >.
Definition at line 356 of file tria_base.cc.
void parallel::TriangulationBase< dim, spacedim >::communicate_locally_moved_vertices  (  const std::vector< bool > &  vertex_locally_moved  ) 
When vertices have been moved locally, for example using code like
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.
vertex_locally_moved
argument may not contain vertices that aren't at least on ghost cells.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(). 
Definition at line 582 of file tria_base.cc.

overridevirtual 
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 652 of file tria_base.cc.

protectedvirtual 
Update the number_cache variable after mesh creation or refinement.
Reimplemented in parallel::fullydistributed::Triangulation< dim, spacedim >.
Definition at line 149 of file tria_base.cc.

overrideprotectedvirtual 
Update the internal reference_cells vector.
Reimplemented from Triangulation< dim, spacedim >.
Definition at line 291 of file tria_base.cc.

protected 
Reset global active cell indices and global level cell indices.
Definition at line 367 of file tria_base.cc.

virtualinherited 
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 in parallel::DistributedTriangulationBase< dim, spacedim >, parallel::DistributedTriangulationBase< 1, spacedim >, parallel::DistributedTriangulationBase< dim, dim >, parallel::distributed::Triangulation< dim, spacedim >, and parallel::distributed::Triangulation< dim >.

virtualinherited 

virtualinherited 

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.
Reimplemented in PersistentTriangulation< dim, spacedim >.

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.
Reimplemented in parallel::distributed::Triangulation< dim, spacedim >, parallel::shared::Triangulation< dim, spacedim >, and PersistentTriangulation< dim, spacedim >.

virtualinherited 
Create a triangulation from the provided TriangulationDescription::Description.
construction_data  The data needed for this process. 
Reimplemented in parallel::distributed::Triangulation< dim, spacedim >, parallel::shared::Triangulation< dim, spacedim >, PersistentTriangulation< dim, spacedim >, and parallel::fullydistributed::Triangulation< dim, spacedim >.

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().
Reimplemented in PersistentTriangulation< dim, spacedim >.

inherited 
Revert or flip the direction_flags of a dim<spacedim triangulation, see GlossDirectionFlag.
This function throws an exception if dim equals spacedim.

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.

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.
times > 1
) . See the section on signals in the general documentation of this class.

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.
times > 1
) . See the section on signals in the general documentation of this class.

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.
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::distributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim >, parallel::shared::Triangulation< dim, spacedim >, parallel::fullydistributed::Triangulation< dim, spacedim >, and PersistentTriangulation< dim, spacedim >.

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::distributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim >, and parallel::fullydistributed::Triangulation< dim, spacedim >.

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 
Clear all user flags. See also GlossUserFlags.

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.

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.

inherited 
Read the information stored by save_user_flags
. See also GlossUserFlags.

inherited 
Read the information stored by save_user_flags
. See also GlossUserFlags.

inherited 
Clear all user flags on lines. See also GlossUserFlags.

inherited 
Save the user flags on lines. See also GlossUserFlags.

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.

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

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

inherited 
Clear all user flags on quads. See also GlossUserFlags.

inherited 
Save the user flags on quads. See also GlossUserFlags.

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.

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

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

inherited 
Clear all user flags on quads. See also GlossUserFlags.

inherited 
Save the user flags on hexs. See also GlossUserFlags.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

inherited 
Iterator to the first used cell on level level
.
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.

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
have zero iterations, as may be expected if there are no active cells on this level.
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.

inherited 

inherited 
Return an iterator which is the first iterator not on level. If level
is the last level, then this returns end()
.
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.

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()
.
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.

inherited 

inherited 

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.

inherited 

inherited 

inherited 

inherited 

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.

inherited 

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.

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

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

inherited 

inherited 

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.

inherited 
Return the number of levels in this triangulation.

virtualinherited 
Return true if the triangulation has hanging nodes.
The function is made virtual since the result can be interpreted in different ways, depending on whether the triangulation lives only on a single processor, or may be distributed as done in the parallel::distributed::Triangulation class (see there for a description of what the function is supposed to do in the parallel context).
Reimplemented in parallel::distributed::Triangulation< dim, spacedim >, parallel::distributed::Triangulation< dim >, and parallel::fullydistributed::Triangulation< dim, spacedim >.

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.

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().

inherited 

inherited 
Return true
if the vertex with this index
is used.

inherited 

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.

inherited 

inherited 

inherited 

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).

inherited 

inherited 
Total number of lines, used or unused.

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

inherited 
Total number of quads, used or unused.

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

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

inherited 

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

inherited 

inherited 

inherited 

inherited 

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

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.

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

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.

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 step45.

inherited 

inherited 

inherited 

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

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.

inherited 
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 156 of file subscriptor.cc.

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 301 of file subscriptor.h.

inlineinherited 
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.

inherited 
List the subscribers to deallog
.
Definition at line 204 of file subscriptor.cc.

protected 
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 301 of file tria_base.h.

protected 
The subdomain id to be used for the current processor. This is the MPI rank.
Definition at line 307 of file tria_base.h.

protected 
The total number of subdomains (or the size of the MPI communicator).
Definition at line 312 of file tria_base.h.

protected 
Definition at line 370 of file tria_base.h.

staticinherited 

staticinherited 

mutableinherited 