deal.II version GIT relicensing-1982-gbb401394a0 2024-10-13 08:40:01+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\}}\)
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
MGTwoLevelTransferNonNested< dim, VectorType > Class Template Referenceabstract

#include <deal.II/multigrid/mg_transfer_global_coarsening.h>

Inheritance diagram for MGTwoLevelTransferNonNested< dim, VectorType >:
Inheritance graph
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 MGTwoLevelTransferNonNested (const AdditionalData &data=AdditionalData())
 
void reinit (const DoFHandler< dim > &dof_handler_fine, const DoFHandler< dim > &dof_handler_coarse, const Mapping< dim > &mapping_fine, const Mapping< dim > &mapping_coarse, const AffineConstraints< Number > &constraint_fine=AffineConstraints< Number >(), const AffineConstraints< Number > &constraint_coarse=AffineConstraints< Number >())
 
void interpolate (VectorType &dst, const VectorType &src) const override
 
std::pair< bool, boolenable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine) override
 
std::size_t memory_consumption () const override
 
boost::signals2::connection connect_prolongation_cell_loop (const std::function< void(const bool)> &slot)
 
boost::signals2::connection connect_restriction_cell_loop (const std::function< void(const bool)> &slot)
 
boost::signals2::connection connect_prolongation (const std::function< void(const bool)> &slot)
 
boost::signals2::connection connect_restriction (const std::function< void(const bool)> &slot)
 
void prolongate_and_add (VectorType &dst, const VectorType &src) const
 
void restrict_and_add (VectorType &dst, const VectorType &src) const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
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
 
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)
 

Public Attributes

std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_coarse
 
std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_fine
 

Protected Member Functions

void prolongate_and_add_internal (VectorType &dst, const VectorType &src) const override
 
void restrict_and_add_internal (VectorType &dst, const VectorType &src) const override
 
virtual void prolongate_and_add_internal (LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const =0
 
virtual void restrict_and_add_internal (LinearAlgebra::distributed::Vector< Number > &dst, const LinearAlgebra::distributed::Vector< Number > &src) const =0
 
void update_ghost_values (const VectorType &vec) const
 
void compress (VectorType &vec, const VectorOperation::values op) const
 
void zero_out_ghost_values (const VectorType &vec) const
 
template<int dim, std::size_t width, typename IndexType >
std::pair< bool, boolinternal_enable_inplace_operations_if_possible (const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_coarse, const std::shared_ptr< const Utilities::MPI::Partitioner > &partitioner_fine, bool &vec_fine_needs_ghost_update, internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &constraint_info_coarse, std::vector< unsigned int > &dof_indices_fine)
 

Protected Attributes

AdditionalData additional_data
 
bool fine_element_is_continuous
 
LinearAlgebra::distributed::Vector< Numbervec_coarse
 
LinearAlgebra::distributed::Vector< Numbervec_fine
 
bool vec_fine_needs_ghost_update
 
std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_coarse_embedded
 
std::shared_ptr< const Utilities::MPI::Partitionerpartitioner_fine_embedded
 
AlignedVector< Numberbuffer_coarse_embedded
 
AlignedVector< Numberbuffer_fine_embedded
 

Private Types

using Number = typename VectorType::value_type
 
using VectorizedArrayType = VectorizedArray< Number, 1 >
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 

Private Member Functions

template<int n_components>
void prolongate_and_add_internal_comp (VectorType &dst, const VectorType &src) const
 
template<int n_components>
void restrict_and_add_internal_comp (VectorType &dst, const VectorType &src) const
 
void check_no_subscribers () const noexcept
 

Private Attributes

mg::SignalsNonNested signals_non_nested
 
ObserverPointer< const DoFHandler< dim > > dof_handler_fine
 
unsigned int mg_level_fine
 
Utilities::MPI::RemotePointEvaluation< dim > rpe
 
std::vector< Numberrpe_input_output
 
std::vector< Numberrpe_buffer
 
std::shared_ptr< NonMatching::MappingInfo< dim, dim, Number > > mapping_info
 
internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArrayType, unsigned intconstraint_info
 
std::unique_ptr< FiniteElement< dim > > fe_coarse
 
std::vector< unsigned intlevel_dof_indices_fine
 
std::vector< unsigned intlevel_dof_indices_fine_ptrs
 
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
 

Friends

class MGTransferMF< dim, Number >
 

Detailed Description

template<int dim, typename VectorType>
class MGTwoLevelTransferNonNested< dim, VectorType >

Class for transfer between two non-nested multigrid levels.

Definition at line 732 of file mg_transfer_global_coarsening.h.

Member Typedef Documentation

◆ Number

template<int dim, typename VectorType >
using MGTwoLevelTransferNonNested< dim, VectorType >::Number = typename VectorType::value_type
private

Definition at line 742 of file mg_transfer_global_coarsening.h.

◆ VectorizedArrayType

template<int dim, typename VectorType >
using MGTwoLevelTransferNonNested< dim, VectorType >::VectorizedArrayType = VectorizedArray<Number, 1>
private

Definition at line 743 of file mg_transfer_global_coarsening.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 231 of file enable_ref_counting_by_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 236 of file enable_ref_counting_by_observer_pointer.h.

Constructor & Destructor Documentation

◆ MGTwoLevelTransferNonNested()

template<int dim, typename VectorType >
MGTwoLevelTransferNonNested< dim, VectorType >::MGTwoLevelTransferNonNested ( const AdditionalData data = AdditionalData())

Constructor.

Member Function Documentation

◆ reinit()

template<int dim, typename VectorType >
void MGTwoLevelTransferNonNested< dim, VectorType >::reinit ( const DoFHandler< dim > &  dof_handler_fine,
const DoFHandler< dim > &  dof_handler_coarse,
const Mapping< dim > &  mapping_fine,
const Mapping< dim > &  mapping_coarse,
const AffineConstraints< Number > &  constraint_fine = AffineConstraintsNumber >(),
const AffineConstraints< Number > &  constraint_coarse = AffineConstraintsNumber >() 
)

Set up transfer operator between the given DoFHandler objects ( dof_handler_fine and dof_handler_coarse).

◆ interpolate()

template<int dim, typename VectorType >
void MGTwoLevelTransferNonNested< dim, VectorType >::interpolate ( VectorType &  dst,
const VectorType &  src 
) const
overridevirtual

Perform interpolation of a solution vector from the fine level to the coarse level. This function is different from restriction, where a weighted residual is transferred to a coarser level (transposition of prolongation matrix).

Implements MGTwoLevelTransferBase< VectorType >.

◆ enable_inplace_operations_if_possible()

template<int dim, typename VectorType >
std::pair< bool, bool > MGTwoLevelTransferNonNested< dim, VectorType >::enable_inplace_operations_if_possible ( const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_coarse,
const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_fine 
)
overridevirtual

Enable inplace vector operations if external and internal vectors are compatible.

Implements MGTwoLevelTransferBase< VectorType >.

◆ memory_consumption()

template<int dim, typename VectorType >
std::size_t MGTwoLevelTransferNonNested< dim, VectorType >::memory_consumption ( ) const
overridevirtual

Return the memory consumption of the allocated memory in this class.

Implements MGTwoLevelTransferBase< VectorType >.

◆ connect_prolongation_cell_loop()

template<int dim, typename VectorType >
boost::signals2::connection MGTwoLevelTransferNonNested< dim, VectorType >::connect_prolongation_cell_loop ( const std::function< void(const bool)> &  slot)

◆ connect_restriction_cell_loop()

template<int dim, typename VectorType >
boost::signals2::connection MGTwoLevelTransferNonNested< dim, VectorType >::connect_restriction_cell_loop ( const std::function< void(const bool)> &  slot)

◆ connect_prolongation()

template<int dim, typename VectorType >
boost::signals2::connection MGTwoLevelTransferNonNested< dim, VectorType >::connect_prolongation ( const std::function< void(const bool)> &  slot)

Connect a function to mg::SignalsNonNested::prolongation.

◆ connect_restriction()

template<int dim, typename VectorType >
boost::signals2::connection MGTwoLevelTransferNonNested< dim, VectorType >::connect_restriction ( const std::function< void(const bool)> &  slot)

Connect a function to mg::SignalsNonNested::restriction.

◆ prolongate_and_add_internal() [1/2]

template<int dim, typename VectorType >
void MGTwoLevelTransferNonNested< dim, VectorType >::prolongate_and_add_internal ( VectorType &  dst,
const VectorType &  src 
) const
overrideprotected

Perform prolongation.

◆ restrict_and_add_internal() [1/2]

template<int dim, typename VectorType >
void MGTwoLevelTransferNonNested< dim, VectorType >::restrict_and_add_internal ( VectorType &  dst,
const VectorType &  src 
) const
overrideprotected

Perform restriction.

◆ prolongate_and_add_internal_comp()

template<int dim, typename VectorType >
template<int n_components>
void MGTwoLevelTransferNonNested< dim, VectorType >::prolongate_and_add_internal_comp ( VectorType &  dst,
const VectorType &  src 
) const
private

Perform prolongation for correct number of components.

◆ restrict_and_add_internal_comp()

template<int dim, typename VectorType >
template<int n_components>
void MGTwoLevelTransferNonNested< dim, VectorType >::restrict_and_add_internal_comp ( VectorType &  dst,
const VectorType &  src 
) const
private

Perform restriction for correct number of components.

◆ prolongate_and_add()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::prolongate_and_add ( VectorType &  dst,
const VectorType &  src 
) const
inherited

Perform prolongation on a solution vector.

◆ restrict_and_add()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::restrict_and_add ( VectorType &  dst,
const VectorType &  src 
) const
inherited

Perform restriction on a residual vector.

◆ prolongate_and_add_internal() [2/2]

template<typename VectorType >
virtual void MGTwoLevelTransferBase< VectorType >::prolongate_and_add_internal ( LinearAlgebra::distributed::Vector< Number > &  dst,
const LinearAlgebra::distributed::Vector< Number > &  src 
) const
protectedpure virtualinherited

Perform prolongation on vectors with correct ghosting.

◆ restrict_and_add_internal() [2/2]

template<typename VectorType >
virtual void MGTwoLevelTransferBase< VectorType >::restrict_and_add_internal ( LinearAlgebra::distributed::Vector< Number > &  dst,
const LinearAlgebra::distributed::Vector< Number > &  src 
) const
protectedpure virtualinherited

Perform restriction on vectors with correct ghosting.

◆ update_ghost_values()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::update_ghost_values ( const VectorType &  vec) const
protectedinherited

A wrapper around update_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ compress()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::compress ( VectorType &  vec,
const VectorOperation::values  op 
) const
protectedinherited

A wrapper around compress() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ zero_out_ghost_values()

template<typename VectorType >
void MGTwoLevelTransferBase< VectorType >::zero_out_ghost_values ( const VectorType &  vec) const
protectedinherited

A wrapper around zero_out_ghost_values() optimized in case the present vector has the same parallel layout of one of the external partitioners.

◆ internal_enable_inplace_operations_if_possible()

template<typename VectorType >
template<int dim, std::size_t width, typename IndexType >
std::pair< bool, bool > MGTwoLevelTransferBase< VectorType >::internal_enable_inplace_operations_if_possible ( const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_coarse,
const std::shared_ptr< const Utilities::MPI::Partitioner > &  partitioner_fine,
bool vec_fine_needs_ghost_update,
internal::MatrixFreeFunctions::ConstraintInfo< dim, VectorizedArray< Number, width >, IndexType > &  constraint_info_coarse,
std::vector< unsigned int > &  dof_indices_fine 
)
protectedinherited

Enable inplace vector operations if external and internal vectors are compatible.

◆ subscribe()

void EnableObserverPointer::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 131 of file enable_ref_counting_by_observer.cc.

◆ unsubscribe()

void EnableObserverPointer::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 151 of file enable_ref_counting_by_observer.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 315 of file enable_ref_counting_by_observer_pointer.h.

◆ list_subscribers() [1/2]

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

List the subscribers to the input stream.

Definition at line 332 of file enable_ref_counting_by_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 199 of file enable_ref_counting_by_observer.cc.

◆ serialize()

template<class Archive >
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 324 of file enable_ref_counting_by_observer_pointer.h.

◆ 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 53 of file enable_ref_counting_by_observer.cc.

Friends And Related Symbol Documentation

◆ MGTransferMF< dim, Number >

template<int dim, typename VectorType >
friend class MGTransferMF< dim, Number >
friend

Definition at line 952 of file mg_transfer_global_coarsening.h.

Member Data Documentation

◆ signals_non_nested

template<int dim, typename VectorType >
mg::SignalsNonNested MGTwoLevelTransferNonNested< dim, VectorType >::signals_non_nested
private

Definition at line 745 of file mg_transfer_global_coarsening.h.

◆ additional_data

template<int dim, typename VectorType >
AdditionalData MGTwoLevelTransferNonNested< dim, VectorType >::additional_data
protected

Definition at line 866 of file mg_transfer_global_coarsening.h.

◆ dof_handler_fine

template<int dim, typename VectorType >
ObserverPointer<const DoFHandler<dim> > MGTwoLevelTransferNonNested< dim, VectorType >::dof_handler_fine
private

Pointer to the DoFHandler object used during initialization.

Definition at line 900 of file mg_transfer_global_coarsening.h.

◆ mg_level_fine

template<int dim, typename VectorType >
unsigned int MGTwoLevelTransferNonNested< dim, VectorType >::mg_level_fine
private

Multigrid level used during initialization.

Definition at line 905 of file mg_transfer_global_coarsening.h.

◆ rpe

template<int dim, typename VectorType >
Utilities::MPI::RemotePointEvaluation<dim> MGTwoLevelTransferNonNested< dim, VectorType >::rpe
private

Object to evaluate shape functions on one mesh on visited support points of the other mesh.

Definition at line 911 of file mg_transfer_global_coarsening.h.

◆ rpe_input_output

template<int dim, typename VectorType >
std::vector<Number> MGTwoLevelTransferNonNested< dim, VectorType >::rpe_input_output
mutableprivate

Vectors for input/output for rpe.

Definition at line 916 of file mg_transfer_global_coarsening.h.

◆ rpe_buffer

template<int dim, typename VectorType >
std::vector<Number> MGTwoLevelTransferNonNested< dim, VectorType >::rpe_buffer
mutableprivate

Buffers to be reused by rpe.

Definition at line 921 of file mg_transfer_global_coarsening.h.

◆ mapping_info

template<int dim, typename VectorType >
std::shared_ptr<NonMatching::MappingInfo<dim, dim, Number> > MGTwoLevelTransferNonNested< dim, VectorType >::mapping_info
private

MappingInfo object needed as Mapping argument by FEPointEvaluation.

Definition at line 926 of file mg_transfer_global_coarsening.h.

◆ constraint_info

template<int dim, typename VectorType >
internal::MatrixFreeFunctions:: ConstraintInfo<dim, VectorizedArrayType, unsigned int> MGTwoLevelTransferNonNested< dim, VectorType >::constraint_info
private

Helper class for reading from and writing to global vectors and for applying constraints.

Definition at line 934 of file mg_transfer_global_coarsening.h.

◆ fe_coarse

template<int dim, typename VectorType >
std::unique_ptr<FiniteElement<dim> > MGTwoLevelTransferNonNested< dim, VectorType >::fe_coarse
private

Finite element of the coarse DoFHandler passed to reinit().

Definition at line 939 of file mg_transfer_global_coarsening.h.

◆ level_dof_indices_fine

template<int dim, typename VectorType >
std::vector<unsigned int> MGTwoLevelTransferNonNested< dim, VectorType >::level_dof_indices_fine
private

DoF indices of the fine cells, expressed in indices local to the MPI rank.

Definition at line 945 of file mg_transfer_global_coarsening.h.

◆ level_dof_indices_fine_ptrs

template<int dim, typename VectorType >
std::vector<unsigned int> MGTwoLevelTransferNonNested< dim, VectorType >::level_dof_indices_fine_ptrs
private

CRS like structure which points to DoFs associated with the same support point. The vector stays empty if only one DoF corresponds to one support point.

Definition at line 952 of file mg_transfer_global_coarsening.h.

◆ fine_element_is_continuous

template<typename VectorType >
bool MGTwoLevelTransferBase< VectorType >::fine_element_is_continuous
protectedinherited

Flag if the finite elements on the fine cells are continuous. If yes, the multiplicity of DoF sharing a vertex/line as well as constraints have to be taken into account via weights.

Definition at line 341 of file mg_transfer_global_coarsening.h.

◆ partitioner_coarse

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_coarse
inherited

Partitioner needed by the intermediate vector.

Definition at line 347 of file mg_transfer_global_coarsening.h.

◆ partitioner_fine

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_fine
inherited

Partitioner needed by the intermediate vector.

Definition at line 352 of file mg_transfer_global_coarsening.h.

◆ vec_coarse

template<typename VectorType >
LinearAlgebra::distributed::Vector<Number> MGTwoLevelTransferBase< VectorType >::vec_coarse
mutableprotectedinherited

Internal vector on which the actual prolongation/restriction is performed.

Definition at line 358 of file mg_transfer_global_coarsening.h.

◆ vec_fine

template<typename VectorType >
LinearAlgebra::distributed::Vector<Number> MGTwoLevelTransferBase< VectorType >::vec_fine
mutableprotectedinherited

Internal vector needed for collecting all degrees of freedom of the fine cells. It is only initialized if the fine-level DoF indices touch DoFs other than the locally active ones (which we always assume can be accessed by the given vectors in the prolongate/restrict functions), otherwise it is left at size zero.

Definition at line 367 of file mg_transfer_global_coarsening.h.

◆ vec_fine_needs_ghost_update

template<typename VectorType >
bool MGTwoLevelTransferBase< VectorType >::vec_fine_needs_ghost_update
protectedinherited

Bool indicating whether fine vector has relevant ghost values.

Definition at line 372 of file mg_transfer_global_coarsening.h.

◆ partitioner_coarse_embedded

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_coarse_embedded
protectedinherited

Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 379 of file mg_transfer_global_coarsening.h.

◆ partitioner_fine_embedded

template<typename VectorType >
std::shared_ptr<const Utilities::MPI::Partitioner> MGTwoLevelTransferBase< VectorType >::partitioner_fine_embedded
protectedinherited

Embedded partitioner for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 385 of file mg_transfer_global_coarsening.h.

◆ buffer_coarse_embedded

template<typename VectorType >
AlignedVector<Number> MGTwoLevelTransferBase< VectorType >::buffer_coarse_embedded
mutableprotectedinherited

Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 391 of file mg_transfer_global_coarsening.h.

◆ buffer_fine_embedded

template<typename VectorType >
AlignedVector<Number> MGTwoLevelTransferBase< VectorType >::buffer_fine_embedded
mutableprotectedinherited

Buffer for efficient communication if locally relevant DoFs are a subset of an external Partitioner object.

Definition at line 397 of file mg_transfer_global_coarsening.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 220 of file enable_ref_counting_by_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 226 of file enable_ref_counting_by_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 242 of file enable_ref_counting_by_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 250 of file enable_ref_counting_by_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 273 of file enable_ref_counting_by_observer_pointer.h.


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