Reference documentation for deal.II version GIT relicensing-453-g9b4d7b6a5a 2024-04-20 16:00:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim > Class Template Reference

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

Inheritance diagram for parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >:
Inheritance graph

Public Member Functions

 TemporarilyMatchRefineFlags (::Triangulation< dim, spacedim > &tria)
 ~TemporarilyMatchRefineFlags ()
template<class Archive >
void serialize (Archive &ar, 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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

Private Types

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

Private Attributes

const SmartPointer< ::parallel::distributed::Triangulation< dim, spacedim > > distributed_tria
std::vector< boolsaved_refine_flags
std::vector< boolsaved_coarsen_flags
std::atomic< unsigned intcounter
std::map< std::string, unsigned intcounter_map
std::vector< std::atomic< bool > * > validity_pointers
const std::type_info * object_info

Static Private Attributes

static std::mutex mutex

Detailed Description

template<int dim, int spacedim = dim>
class parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >

This class temporarily modifies the refine and coarsen flags of all active cells to match the p4est oracle.

The modification only happens on parallel::distributed::Triangulation objects, and persists for the lifetime of an instantiation of this class.

The TemporarilyMatchRefineFlags class should only be used in combination with the Triangulation::Signals::post_p4est_refinement signal. At this stage, the p4est oracle already has been refined, but the triangulation is still unchanged. After the modification, all refine and coarsen flags describe how the triangulation will actually be refined.

The use of this class is demonstrated in step-75.

Definition at line 1121 of file tria.h.

Member Typedef Documentation

◆ map_value_type

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

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

◆ map_iterator

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

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

Constructor & Destructor Documentation

◆ TemporarilyMatchRefineFlags()

template<int dim, int spacedim>
parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >::TemporarilyMatchRefineFlags ( ::Triangulation< dim, spacedim > &  tria)


Stores the refine and coarsen flags of all active cells if the provided Triangulation is of type parallel::distributed::Triangulation.

Adjusts them to be consistent with the p4est oracle.

Definition at line 4274 of file

◆ ~TemporarilyMatchRefineFlags()


Returns the refine and coarsen flags of all active cells on the parallel::distributed::Triangulation into their previous state.

Definition at line 4333 of file

Member Function Documentation

◆ subscribe()

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

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

Definition at line 135 of file

◆ unsubscribe()

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

Unsubscribes a user from the object.

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

Definition at line 155 of file

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const

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

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

List the subscribers to deallog.

Definition at line 203 of file

◆ serialize()

template<class Archive >
void Subscriptor::serialize ( Archive &  ar,
const unsigned int  version 

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

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

◆ check_no_subscribers()

void Subscriptor::check_no_subscribers ( ) const

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.

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 52 of file

Member Data Documentation

◆ distributed_tria

template<int dim, int spacedim = dim>
const SmartPointer< ::parallel::distributed::Triangulation<dim, spacedim> > parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >::distributed_tria

The modified parallel::distributed::Triangulation.

Definition at line 1149 of file tria.h.

◆ saved_refine_flags

template<int dim, int spacedim = dim>
std::vector<bool> parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >::saved_refine_flags

A vector that temporarily stores the refine flags before they have been modified on the parallel::distributed::Triangulation.

Definition at line 1155 of file tria.h.

◆ saved_coarsen_flags

template<int dim, int spacedim = dim>
std::vector<bool> parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >::saved_coarsen_flags

A vector that temporarily stores the coarsen flags before they have been modified on the parallel::distributed::Triangulation.

Definition at line 1161 of file tria.h.

◆ counter

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

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

◆ counter_map

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

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

Definition at line 224 of file subscriptor.h.

◆ validity_pointers

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

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

Definition at line 240 of file subscriptor.h.

◆ object_info

const std::type_info* Subscriptor::object_info

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

◆ mutex

std::mutex Subscriptor::mutex

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 271 of file subscriptor.h.

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