deal.II version 9.7.0
\(\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\}}\)
Loading...
Searching...
No Matches
RepartitioningPolicyTools::DefaultPolicy< dim, spacedim > Class Template Reference

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

Detailed Description

template<int dim, int spacedim = dim>
class RepartitioningPolicyTools::DefaultPolicy< dim, spacedim >

A dummy policy that simply returns an empty vector, which is interpreted in MGTransferGlobalCoarseningTools::create_geometric_coarsening_sequence() in a way that the triangulation is not repartitioned.

Definition at line 70 of file repartitioning_policy_tools.h.

Inheritance diagram for RepartitioningPolicyTools::DefaultPolicy< dim, spacedim >:
Inheritance graph
[legend]

Public Member Functions

 DefaultPolicy (const bool tighten=false)
virtual LinearAlgebra::distributed::Vector< double > partition (const Triangulation< dim, spacedim > &tria_coarse_in) const override
void serialize (Archive &ar, const unsigned int version)
Querying the observer pointers an object has.
unsigned int n_subscriptions () const
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)

Private Types

using map_value_type
using map_iterator

Private Member Functions

EnableObserverPointer functionality

Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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
void check_no_subscribers () const noexcept

Private Attributes

const bool tighten
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

Member Typedef Documentation

◆ map_value_type

using EnableObserverPointer::map_value_type
privateinherited

The data type used in counter_map.

Definition at line 224 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator
privateinherited

The iterator type used in counter_map.

Definition at line 229 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ DefaultPolicy()

template<int dim, int spacedim>
RepartitioningPolicyTools::DefaultPolicy< dim, spacedim >::DefaultPolicy ( const bool tighten = false)

Constructor.

Parameters
tightenallows to renumber of subdomains so that empty ranks are positioned at the end.

Definition at line 49 of file repartitioning_policy_tools.cc.

Member Function Documentation

◆ partition()

template<int dim, int spacedim>
LinearAlgebra::distributed::Vector< double > RepartitioningPolicyTools::DefaultPolicy< dim, spacedim >::partition ( const Triangulation< dim, spacedim > & tria_coarse_in) const
overridevirtual

Return a vector of the new owners of the active locally owned and ghost cells.

Implements RepartitioningPolicyTools::Base< dim, dim >.

Definition at line 55 of file repartitioning_policy_tools.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::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 129 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

void EnableObserverPointer::list_subscribers ( StreamType & stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 136 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 142 of file enable_observer_pointer.cc.

◆ ExcInUse()

::ExceptionBase & EnableObserverPointer::ExcInUse ( int arg1,
std::string arg2,
std::string arg3 )
staticinherited

Exception: Object may not be deleted, since it is used.

Note
The message that will be printed by this exception reads:
<< "Object of class " << arg2 << " is still used by " << arg1 << " other objects." << "\n\n" << "(Additional information: " << arg3 << ")\n\n" << "See the entry in the Frequently Asked Questions of " << "deal.II (linked to from http://www.dealii.org/) for " << "a lot more information on what this error means and " << "how to fix programs in which it happens."

◆ ExcNoSubscriber()

::ExceptionBase & EnableObserverPointer::ExcNoSubscriber ( std::string arg1,
std::string arg2 )
staticinherited

A subscriber with the identification string given to EnableObserverPointer::unsubscribe() did not subscribe to the object.

Note
The message that will be printed by this exception reads:
<< "No subscriber with identifier <" << arg2 << "> subscribes to this object of class " << arg1 << ". Consequently, it cannot be unsubscribed."

◆ serialize()

void EnableObserverPointer::serialize ( Archive & ar,
const unsigned int version )
inlineinherited

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 195 of file enable_observer_pointer.h.

◆ subscribe()

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

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

Definition at line 266 of file enable_observer_pointer.cc.

◆ unsubscribe()

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

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 276 of file enable_observer_pointer.cc.

◆ check_no_subscribers()

void EnableObserverPointer::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 293 of file enable_observer_pointer.cc.

Member Data Documentation

◆ tighten

template<int dim, int spacedim = dim>
const bool RepartitioningPolicyTools::DefaultPolicy< dim, spacedim >::tighten
private

Definition at line 86 of file repartitioning_policy_tools.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::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 213 of file enable_observer_pointer.h.

◆ counter_map

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

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

Definition at line 219 of file enable_observer_pointer.h.

◆ validity_pointers

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

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

Definition at line 235 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::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 243 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex
staticprivateinherited

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 250 of file enable_observer_pointer.h.

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