deal.II version GIT relicensing-1972-g22a7b89abe 2024-10-11 21:20:00+00:00
|
#include <deal.II/base/subscriptor.h>
Inherited by AffineConstraints< Number >, AffineConstraints< double >, AffineConstraints< value_type >, AffineConstraints< typename MatrixType::value_type >, AffineConstraints< typename VectorType::value_type >, BlockMatrixBase< SparseMatrix< number > >, BlockMatrixBase< SparseMatrix< Number, ::MemorySpace::Host > >, BlockMatrixBase< SparseMatrix >, BlockMatrixBase< SparseMatrix< double > >, BlockVectorBase< Vector< Number > >, BlockVectorBase< TpetraWrappers::Vector< Number, ::MemorySpace::Host > >, BlockVectorBase< Vector< double > >, BlockVectorBase< Vector >, BlockVectorBase< MPI::Vector >, BlockVectorBase< Vector< number > >, DataPostprocessor< spacedim >, DiagonalMatrix< LinearAlgebra::distributed::Vector< double > >, DoFHandler< dim, spacedim >, DoFHandler< dim, dim >, DoFHandler< patch_dim, spacedim >, DoFHandler< 1, spacedim >, FETools::FEFactoryBase< FE::dimension, FE::space_dimension >, FEValuesBase< dim, dim >, FEValuesBase< dim1, dim1 >, FiniteElement< dim, spacedim >, FiniteElement< dim, dim >, FiniteElement< 1, spacedim >, FiniteElement< 2, 2 >, FiniteElement< PolynomialType::dimension+1, PolynomialType::dimension+1 >, Function< dim, double >, Function< dim, VectorType::value_type >, Function< 2 >, Function< 1 >, Function< dim+1 >, GridTools::Cache< dim, dim >, LinearAlgebra::TpetraWrappers::SparseMatrix< Number, MemorySpace >, LinearAlgebra::TpetraWrappers::Vector< Number, ::MemorySpace::Host >, LinearAlgebra::distributed::Vector< double >, MGCoarseGridBase< Vector< double > >, MGLevelObject< RelaxationType >, MGLevelObject< LinearAlgebra::distributed::Vector< Number > >, MGLevelObject< MatrixType >, MGLevelObject< LinearOperator< BlockVector< number > > >, MGLevelObject< PreconditionerType >, MGLevelObject< LinearOperator< VectorType > >, MGLevelObject< MGTwoLevelTransfer< dim, LinearAlgebra::distributed::Vector > >, MGLevelObject< ObserverPointer< MGTwoLevelTransferBase< LinearAlgebra::distributed::Vector > > >, MGLevelObject< std::shared_ptr< const Utilities::MPI::Partitioner > >, MGLevelObject< VectorType >, MGLevelObject< LinearOperator< Vector< double > > >, MGLevelObject< SparsityPattern >, MGLevelObject< SparseMatrix< number > >, MGMatrixBase< Vector< number > >, MGMatrixBase< Vector< double > >, MGSmootherBase< BlockVector< number > >, MGSmootherBase< Vector< double > >, MGTransferBase< LinearAlgebra::distributed::Vector< Number > >, MGTransferBase< BlockVector< number > >, MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >, MGTransferBase< Vector< number > >, MGTwoLevelTransferBase< LinearAlgebra::distributed::Vector >, Manifold< dim, spacedim >, Manifold< dim, dim >, Mapping< dim, spacedim >, Mapping< dim, dim >, Mapping< patch_dim, spacedim >, MatrixBlock< FullMatrix< double > >, MatrixBlock< FullMatrix< number > >, MatrixFree< dim, Number, VectorizedArrayType >, MatrixFree< dim, double, VectorizedArray< double > >, MatrixFree< dim, value_type, VectorizedArray< typename VectorType::value_type > >, MatrixFree< dim, Number >, MatrixFree< dim, Number, VectorizedArray< Number > >, MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double >, VectorizedArray< typename VectorType::value_type > >, NonMatching::MappingInfo< dim, spacedim, double >, NonMatching::MappingInfo< dim, dim, double >, NonMatching::MappingInfo< dim, dim, Number >, Polynomials::Polynomial< double >, PreconditionBlock< MatrixType, typename MatrixType::value_type > [virtual]
, PreconditionBlock< MatrixType, inverse_type > [virtual]
, PreconditionBlockJacobi< MatrixType, inverse_type > [virtual]
, PreconditionBlockSOR< MatrixType, typename MatrixType::value_type > [virtual]
, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionJacobiImpl< SparseMatrix< double > > >, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionPSORImpl< SparseMatrix< double > > >, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionSORImpl< SparseMatrix< double > > >, PreconditionRelaxation< SparseMatrix< double >, internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >, Quadrature< 1 >, Quadrature< dim - 1 >, Quadrature< 0 >, Quadrature< structdim >, SolverBase< Vector< double > >, SolverBase< VectorType >, SparseMatrix< double > [virtual]
, TableBase< 2, number >, TableBase< 2, typename MatrixType::value_type >, TableBase< 2, NumberType >, TableBase< 1, T >, TableBase< 2, T >, TableBase< 3, T >, TableBase< 4, T >, TableBase< 5, T >, TableBase< 6, T >, TableBase< 7, T >, TableBase< 2, Number >, TableBase< 2, double >, TableBase< 2, inverse_type >, TableBase< 2, InverseNumberType >, TensorFunction< rank, dim, double >, TensorFunction< 1, dim, double >, Triangulation< dim, spacedim >, Triangulation< dim, dim >, Triangulation< dimension, space_dimension >, Triangulation< 1, spacedim >, Vector< typename VectorType::value_type >, Vector< number >, VectorMemory< Vector< double > >, VectorMemory< ::Vector< double > >, VectorMemory< BlockVector< number > >, VectorMemory< VectorType >, VectorMemory< Vector< number > >, hp::Collection< FiniteElement< dim, spacedim > >, hp::Collection< Mapping< dim, spacedim > >, hp::Collection< Quadrature< dim > >, hp::Collection< FiniteElement< dim, dim > >, hp::Collection< Mapping< dim, dim > >, hp::FEValuesBase< dim, dim - 1, ::FEFaceValues< dim, dim > >, hp::FEValuesBase< dim, dim, ::FEValues< dim, dim > >, AffineConstraints< number >, Algorithms::OperatorBase, Algorithms::OutputOperator< VectorType >, Algorithms::TimestepControl, AnyData, ArpackSolver, BlockIndices, BlockInfo, BlockMatrixBase< MatrixType >, BlockSparseMatrixEZ< Number >, BlockVectorBase< VectorType >, CellDataStorage< CellIteratorType, DataType >, ChunkSparseMatrix< number > [virtual]
, ChunkSparsityPattern, DataPostprocessor< dim >, DiagonalMatrix< VectorType >, DoFHandler< dim, spacedim >, FERemoteEvaluationCommunicator< dim >, 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::PreconditionBase< Number, MemorySpace >, LinearAlgebra::TpetraWrappers::SparseMatrix< Number, MemorySpace >, LinearAlgebra::TpetraWrappers::Vector< Number, MemorySpace >, LinearAlgebra::distributed::Vector< Number, MemorySpace >, LogStream, MGCoarseGridBase< VectorType >, MGConstrainedDoFs, MGLevelObject< Object >, MGMatrixBase< VectorType >, MGMatrixBlockVector< MatrixType >, MGSmootherBase< VectorType >, MGTransferBase< VectorType >, MGTwoLevelTransferBase< 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::MappingInfo< dim, spacedim, Number >, NonMatching::MeshClassifier< dim >, PArpackSolver< VectorType >, PETScWrappers::MatrixBase, PETScWrappers::PreconditionBase, PETScWrappers::VectorBase, ParameterAcceptor, ParameterHandler, Particles::ParticleHandler< dim, spacedim >, Polynomials::PiecewisePolynomial< number >, Polynomials::Polynomial< number >, Portable::MatrixFree< dim, 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, TransferType >, 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::SolverDirect, TrilinosWrappers::SparseMatrix, 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 () |
Subscriptor & | operator= (const Subscriptor &) |
Subscriptor & | operator= (Subscriptor &&) noexcept |
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 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 ::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 = decltype(counter_map)::value_type |
using | map_iterator = decltype(counter_map)::iterator |
Private Member Functions | |
void | check_no_subscribers () const noexcept |
Private Attributes | |
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 |
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 assumed 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 ObserverPointer) 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 ObserverPointer 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.
|
private |
The data type used in counter_map.
Definition at line 230 of file subscriptor.h.
|
private |
The iterator type used in counter_map.
Definition at line 235 of file subscriptor.h.
|
inline |
Constructor setting the counter to zero.
Definition at line 277 of file subscriptor.h.
|
inline |
Copy-constructor.
The counter of the copy is zero, since references point to the original object.
Definition at line 284 of file subscriptor.h.
|
noexcept |
Move constructor.
An object inheriting from Subscriptor can only be moved if no other objects are subscribing to it.
Definition at line 32 of file subscriptor.cc.
|
virtual |
Destructor, asserting that the counter is zero.
Definition at line 43 of file subscriptor.cc.
|
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 292 of file subscriptor.h.
|
noexcept |
Move assignment operator. Only invalidates the object moved from.
Definition at line 118 of file subscriptor.cc.
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 130 of file subscriptor.cc.
void Subscriptor::unsubscribe | ( | std::atomic< bool > *const | validity, |
const std::string & | identifier = "" |
||
) | const |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 150 of file subscriptor.cc.
|
inline |
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.
|
inline |
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.
void Subscriptor::list_subscribers | ( | ) | const |
List the subscribers to deallog
.
Definition at line 198 of file subscriptor.cc.
|
inline |
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 310 of file subscriptor.h.
|
privatenoexcept |
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.
Definition at line 52 of file subscriptor.cc.
|
mutableprivate |
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 219 of file subscriptor.h.
|
mutableprivate |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 225 of file subscriptor.h.
|
mutableprivate |
In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.
Definition at line 241 of file subscriptor.h.
|
mutableprivate |
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 249 of file subscriptor.h.
|
staticprivate |
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 272 of file subscriptor.h.