Reference documentation for deal.II version GIT c99bf6dfd7 2022-05-28 07:20: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\}}\)
Public Member Functions | List of all members
Subscriptor Class Reference

#include <deal.II/base/subscriptor.h>

Inherited by AffineConstraints< double >, BlockMatrixBase< SparseMatrix >, BlockMatrixBase< SparseMatrix< number > >, BlockSparsityPatternBase< SparsityPattern >, BlockSparsityPatternBase< DynamicSparsityPattern >, BlockVectorBase< MPI::Vector >, BlockVectorBase< Vector >, BlockVectorBase< Vector< Number > >, DoFHandler< dim, spacedim >, DoFHandler< 1, spacedim >, DoFHandler< patch_dim, spacedim >, FETools::FEFactoryBase< FE::dimension, FE::space_dimension >, FEValuesBase< dim, dim >, FiniteElement< 2, 2 >, FiniteElement< PolynomialType::dimension+1, PolynomialType::dimension+1 >, FiniteElement< dim, spacedim >, FiniteElement< 1, spacedim >, FiniteElement< dim, dim >, Function< 1 >, Function< 2 >, Function< dim, VectorType::value_type >, Function< dim, double >, GridTools::Cache< dim, dim >, MGCoarseGridBase< Vector< double > >, MGLevelObject< LinearOperator< BlockVector< number > > >, MGLevelObject< LinearOperator< VectorType > >, MGLevelObject< LinearAlgebra::distributed::Vector< Number > >, MGLevelObject< SparseMatrix< number > >, MGLevelObject< VectorType >, MGLevelObject< SparsityPattern >, MGLevelObject< LinearOperator< Vector< double > > >, MGLevelObject< RelaxationType >, MGLevelObject< PreconditionerType >, MGLevelObject< std::shared_ptr< const Utilities::MPI::Partitioner > >, MGLevelObject< MGTwoLevelTransfer< dim, VectorType > >, MGMatrixBase< Vector< double > >, MGMatrixBase< Vector< number > >, MGTransferBase< LinearAlgebra::distributed::Vector< Number > >, MGTransferBase< BlockVector< number > >, MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >, MGTransferBase< Vector< number > >, Manifold< dim, dim >, Mapping< dim, spacedim >, Mapping< dim, dim >, MatrixBlock< FullMatrix< number > >, MatrixFree< dim, Number, VectorizedArrayType >, MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double >, VectorizedArray< typename VectorType::value_type > >, Polynomials::Polynomial< double >, PreconditionBlock< MatrixType, inverse_type > [virtual], PreconditionBlock< MatrixType, typename MatrixType::value_type > [virtual], PreconditionBlockJacobi< MatrixType, inverse_type > [virtual], PreconditionBlockSOR< MatrixType, typename MatrixType::value_type > [virtual], PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionSORImpl< SparseMatrix< double > > >, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionJacobiImpl< SparseMatrix< double > > >, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionPSORImpl< SparseMatrix< double > > >, Quadrature< 0 >, Quadrature< dim - 1 >, Quadrature< 1 >, Quadrature< structdim >, SolverBase< Vector< double > >, SolverBase< VectorType >, SparseMatrix< double > [virtual], TableBase< 7, T >, TableBase< 6, T >, TableBase< 5, T >, TableBase< 4, T >, TableBase< 3, T >, TableBase< 2, T >, TableBase< 1, T >, TensorFunction< 1, dim, double >, TensorFunction< rank, dim, double >, Triangulation< dim, spacedim >, Triangulation< 1, spacedim >, Triangulation< dim, dim >, Vector< double >, Vector< typename VectorType::value_type >, VectorMemory< ::Vector< double > >, VectorMemory< Vector< double > >, VectorMemory< VectorType >, hp::Collection< Mapping< dim, dim > >, hp::Collection< FiniteElement< dim, spacedim > >, hp::Collection< Quadrature< dim > >, hp::Collection< FiniteElement< dim, dim > >, hp::FEValuesBase< dim, dim, ::FEValues< dim, dim > >, hp::FEValuesBase< dim, dim - 1, ::FEFaceValues< dim, dim > >, AffineConstraints< number >, Algorithms::OperatorBase, Algorithms::OutputOperator< VectorType >, Algorithms::TimestepControl, AnyData, ArpackSolver, BlockIndices, BlockInfo, BlockMatrixBase< MatrixType >, BlockSparseMatrixEZ< Number >, BlockSparsityPatternBase< SparsityPatternType >, BlockVectorBase< VectorType >, CUDAWrappers::MatrixFree< dim, Number >, CUDAWrappers::SparseMatrix< Number > [virtual], CellDataStorage< CellIteratorType, DataType >, ChunkSparseMatrix< number > [virtual], ChunkSparsityPattern, DataPostprocessor< dim >, DiagonalMatrix< VectorType >, DoFHandler< dim, spacedim >, DynamicSparsityPattern, FESeries::Fourier< dim, spacedim >, FESeries::Legendre< dim, spacedim >, FETools::FEFactoryBase< dim, spacedim >, FEValuesBase< dim, spacedim >, FiniteElement< dim, spacedim >, Function< dim, RangeNumberType >, GeneralDataStorage, GridTools::Cache< dim, spacedim >, InterGridMap< MeshType >, LinearAlgebra::EpetraWrappers::Vector, LinearAlgebra::ReadWriteVector< Number >, LinearAlgebra::TpetraWrappers::Vector< Number >, LinearAlgebra::distributed::Vector< Number, MemorySpace >, LogStream, MGCoarseGridBase< VectorType >, MGConstrainedDoFs, MGLevelObject< Object >, MGMatrixBase< VectorType >, MGMatrixBlockVector< MatrixType >, MGSmootherBase< VectorType >, MGTransferBase< VectorType >, Manifold< dim, spacedim >, Mapping< dim, spacedim >, MatrixBlock< MatrixType >, MatrixFree< dim, Number, VectorizedArrayType >, MatrixFreeOperators::Base< dim, VectorType, VectorizedArrayType >, MatrixFreeOperators::MGInterfaceOperator< OperatorType >, MeshWorker::LocalIntegrator< dim, spacedim, number >, MeshWorker::VectorSelector, Multigrid< VectorType >, NonMatching::MeshClassifier< dim >, PArpackSolver< VectorType >, PETScWrappers::MatrixBase, PETScWrappers::PreconditionBase, PETScWrappers::VectorBase, ParameterAcceptor, ParameterHandler, Particles::ParticleHandler< dim, spacedim >, Polynomials::PiecewisePolynomial< number >, Polynomials::Polynomial< number >, PreconditionBlock< MatrixType, inverse_type > [virtual], PreconditionBlockJacobi< MatrixType, inverse_type > [virtual], PreconditionBlockSOR< MatrixType, inverse_type > [virtual], PreconditionBlockSSOR< MatrixType, inverse_type > [virtual], PreconditionChebyshev< MatrixType, VectorType, PreconditionerType >, PreconditionIdentity, PreconditionLU< number >, PreconditionMG< dim, VectorType, TRANSFER >, PreconditionRelaxation< MatrixType, PreconditionerType >, PreconditionRichardson, PreconditionSelector< MatrixType, VectorType >, PreconditionUseMatrix< MatrixType, VectorType >, Quadrature< dim >, RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData, RelaxationBlockJacobi< MatrixType, InverseNumberType, VectorType > [virtual], RelaxationBlockSOR< MatrixType, InverseNumberType, VectorType > [virtual], RelaxationBlockSSOR< MatrixType, InverseNumberType, VectorType > [virtual], RepartitioningPolicyTools::Base< dim, spacedim >, SolverBase< VectorType >, SolverControl, SolverSelector< VectorType >, SparseDirectUMFPACK, SparseLUDecomposition< number > [virtual], SparseMatrix< number > [virtual], SparseMatrixEZ< number >, SparsityPatternBase, TableBase< N, T >, TensorFunction< rank, dim, Number >, TimeStepBase, Triangulation< dim, spacedim >, TrilinosWrappers::MPI::Vector, TrilinosWrappers::PreconditionBase, TrilinosWrappers::SparseMatrix, TrilinosWrappers::SparsityPattern, Vector< Number >, VectorMemory< VectorType >, hp::Collection< T >, hp::FEValuesBase< dim, q_dim, FEValuesType >, internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim >, mg::SparseMatrixCollection< number >, and parallel::distributed::TemporarilyMatchRefineFlags< dim, spacedim >.

Public Member Functions

 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
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 std::mutex mutex
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

Detailed Description

Handling of subscriptions.

This class, as a base class, allows to keep track of other objects using a specific object. It is used to avoid that pointers that point to an object of a class derived from Subscriptor are referenced after that object has been invalidated. Here, invalidation is assumend to happen when the object is moved from or destroyed. The mechanism works as follows: The member function subscribe() accepts a pointer to a boolean that is modified on invalidation. The object that owns this pointer (usually an object of class type SmartPointer) is then expected to check the state of the boolean before trying to access this class.

The utility of this class is even enhanced by providing identifying strings to the functions subscribe() and unsubscribe(). These strings are represented as const char pointers since the underlying buffer comes from (and is managed by) the run-time type information system: more exactly, these pointers are the result the function call typeid(x).name() where x is some object. Therefore, the pointers provided to subscribe() and to unsubscribe() must be the same. Strings with equal contents will not be recognized to be the same. The handling in SmartPointer will take care of this. The current subscribers to this class can be obtained by calling list_subscribers().

Definition at line 60 of file subscriptor.h.

Constructor & Destructor Documentation

◆ Subscriptor() [1/3]

Subscriptor::Subscriptor ( )
inline

Constructor setting the counter to zero.

Definition at line 276 of file subscriptor.h.

◆ Subscriptor() [2/3]

Subscriptor::Subscriptor ( const Subscriptor )
inline

Copy-constructor.

The counter of the copy is zero, since references point to the original object.

Definition at line 283 of file subscriptor.h.

◆ Subscriptor() [3/3]

Subscriptor::Subscriptor ( Subscriptor &&  subscriptor)
noexcept

Move constructor.

An object inheriting from Subscriptor can only be moved if no other objects are subscribing to it.

Definition at line 33 of file subscriptor.cc.

◆ ~Subscriptor()

Subscriptor::~Subscriptor ( )
virtual

Destructor, asserting that the counter is zero.

Definition at line 44 of file subscriptor.cc.

Member Function Documentation

◆ operator=() [1/2]

Subscriptor & Subscriptor::operator= ( const Subscriptor s)
inline

Assignment operator.

This has to be handled with care, too, because the counter has to remain the same. It therefore does nothing more than returning *this.

Definition at line 291 of file subscriptor.h.

◆ operator=() [2/2]

Subscriptor & Subscriptor::operator= ( Subscriptor &&  s)
noexcept

Move assignment operator. Only invalidates the object moved from.

Definition at line 124 of file subscriptor.cc.


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