 |
Reference documentation for deal.II version 9.1.0-pre
|
|
Reference documentation for deal.II version 9.1.0-pre
|
#include <deal.II/base/subscriptor.h>
Inherited by AffineConstraints< number >, AffineConstraints< double >, AffineConstraints< typename MatrixType::value_type >, AffineConstraints< typename VectorType::value_type >, Algorithms::OperatorBase, Algorithms::OutputOperator< VectorType >, Algorithms::TimestepControl, AnyData, ArpackSolver, BlockIndices, BlockInfo, BlockMatrixArray< number, BlockVectorType >, BlockMatrixBase< MatrixType >, BlockMatrixBase< SparseMatrix >, BlockMatrixBase< SparseMatrix< number > >, BlockSparseMatrixEZ< Number >, BlockSparsityPatternBase< SparsityPatternType >, BlockSparsityPatternBase< DynamicSparsityPattern >, BlockSparsityPatternBase< SparsityPattern >, BlockVectorBase< VectorType >, BlockVectorBase< MPI::Vector >, BlockVectorBase< Vector >, BlockVectorBase< Vector< Number > >, GridTools::Cache< dim, DoFHandlerType::space_dimension >, CellDataStorage< CellIteratorType, DataType >, ChunkSparseMatrix< number > [virtual], ChunkSparsityPattern, CUDAWrappers::MatrixFree< dim, Number >, CUDAWrappers::SparseMatrix< Number > [virtual], DataPostprocessor< dim >, DataPostprocessor< DoFHandlerType::space_dimension >, DiagonalMatrix< VectorType >, DoFHandler< dim, spacedim >, hp::DoFHandler< dim >, DoFHandler< dim >, DynamicSparsityPattern, hp::FECollection< dim >, hp::FECollection< dim, dim >, hp::FECollection< dim, FEValuesType::space_dimension >, hp::FECollection< dim,::FEFaceValues< dim, spacedim >::space_dimension >, hp::FECollection< dim,::FESubfaceValues< dim, spacedim >::space_dimension >, hp::FECollection< dim,::FEValues< dim, spacedim >::space_dimension >, FETools::FEFactoryBase< FE::dimension, FE::space_dimension >, FESeries::Fourier< dim >, FESeries::Legendre< dim >, FETools::FEFactoryBase< dim, spacedim >, FEValuesBase< dim, spacedim >, FilteredMatrix< VectorType >, FiniteElement< dim, spacedim >, FiniteElement< 1, spacedim >, FiniteElement< 2, 2 >, FiniteElement< dim >, FiniteElement< dim, dim >, Function< dim, RangeNumberType >, Function< 2 >, Function< chartdim >, Function< dim >, Function< dim, VectorType::value_type >, Function< spacedim >, GridTools::Cache< dim, spacedim >, hp::DoFHandler< dim, spacedim >, hp::FECollection< dim, spacedim >, hp::MappingCollection< dim, spacedim >, hp::QCollection< dim >, InterGridMap< MeshType >, LinearAlgebra::distributed::Vector< Number >, LinearAlgebra::EpetraWrappers::Vector, LinearAlgebra::ReadWriteVector< Number >, LogStream, Manifold< dim, spacedim >, Manifold< dim, dim >, Mapping< dim, spacedim >, Mapping< dim >, hp::MappingCollection< dim, FEValuesType::space_dimension >, hp::MappingCollection< dim,::FEFaceValues< dim, spacedim >::space_dimension >, hp::MappingCollection< dim,::FESubfaceValues< dim, spacedim >::space_dimension >, hp::MappingCollection< dim,::FEValues< dim, spacedim >::space_dimension >, MatrixBlock< MatrixType >, MatrixBlock< FullMatrix< number > >, MatrixFree< dim, Number >, MatrixFreeOperators::Base< dim, VectorType >, MatrixFreeOperators::MGInterfaceOperator< OperatorType >, MeanValueFilter, MeshWorker::LocalIntegrator< dim, spacedim, number >, MeshWorker::VectorSelector, mg::SparseMatrixCollection< number >, MGCoarseGridBase< VectorType >, MGConstrainedDoFs, MGLevelObject< Object >, MGLevelObject< LinearAlgebra::distributed::Vector< Number > >, MGLevelObject< LinearOperator< BlockVector< number > > >, MGLevelObject< LinearOperator< VectorType > >, MGLevelObject< MatrixType >, MGLevelObject< PreconditionerType >, MGLevelObject< RelaxationType >, MGLevelObject< SparseMatrix< number > >, MGLevelObject< SparsityPattern >, MGLevelObject< VectorType >, MGMatrixBase< VectorType >, MGMatrixBase< Vector< number > >, MGMatrixBlockVector< MatrixType >, MGSmootherBase< VectorType >, MGSmootherBase< BlockVector< number > >, MGTransferBase< VectorType >, MGTransferBase< BlockVector< number > >, MGTransferBase< LinearAlgebra::distributed::BlockVector< Number > >, MGTransferBase< LinearAlgebra::distributed::Vector< Number > >, MGTransferBase< Vector< number > >, Multigrid< VectorType >, ParameterAcceptor, ParameterHandler, PArpackSolver< VectorType >, PArpackSolver< VectorType >::Shift< MatrixType >, Particles::ParticleHandler< dim, spacedim >, PETScWrappers::MatrixBase, PETScWrappers::VectorBase, Polynomials::PiecewisePolynomial< double >, PointerMatrixBase< VectorType >, PointerMatrixBase< typename BlockVectorType::BlockType >, PointerMatrixBase< Vector< number > >, Polynomials::Polynomial< double >, 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 >, PreconditionRichardson, PreconditionSelector< MatrixType, VectorType >, PreconditionUseMatrix< MatrixType, VectorType >, hp::QCollection< q_dim >, Quadrature< dim >, Quadrature< 1 >, Quadrature< dim-1 >, Quadrature< structdim >, RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData, RelaxationBlockJacobi< MatrixType, InverseNumberType, VectorType > [virtual], RelaxationBlockSOR< MatrixType, InverseNumberType, VectorType > [virtual], RelaxationBlockSSOR< MatrixType, InverseNumberType, VectorType > [virtual], Solver< VectorType >, SolverControl, SolverSelector< VectorType >, SparseDirectUMFPACK, SparseLUDecomposition< number > [virtual], SparseMatrix< number > [virtual], SparseMatrixEZ< number >, SparsityPattern, TableBase< N, T >, TableBase< 1, T >, TableBase< 2, number >, TableBase< 2, NumberType >, TableBase< 2, T >, TableBase< 3, T >, TableBase< 4, T >, TableBase< 5, T >, TableBase< 6, T >, TableBase< 7, T >, TensorFunction< rank, dim, Number >, TensorFunction< 1, dim, RangeNumberType >, TimeStepBase, Triangulation< dim, spacedim >, Triangulation< dim, dim >, Triangulation< DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, Triangulation< DoFHandlerType::dimension, DoFHandlerType::space_dimension >, TrilinosWrappers::MPI::Vector, TrilinosWrappers::PreconditionBase, TrilinosWrappers::SparseMatrix, TrilinosWrappers::SparsityPattern, Vector< Number >, LinearAlgebra::distributed::Vector< double >, Vector< double >, Vector< number >, Vector< typename VectorType::value_type >, VectorMemory< VectorType >, VectorMemory< BlockVector< number > >, and VectorMemory< Vector< number > >.
Public Member Functions | |
| Subscriptor () | |
| Subscriptor (const Subscriptor &) | |
| Subscriptor (Subscriptor &&) noexcept | |
| virtual | ~Subscriptor () |
| Subscriptor & | operator= (const Subscriptor &) |
| Subscriptor & | operator= (Subscriptor &&) noexcept |
| void | subscribe (const char *identifier=nullptr) const |
| void | unsubscribe (const char *identifier=nullptr) 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 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 = std::map< const char *, unsigned int >::value_type |
| using | map_iterator = std::map< const char *, unsigned int >::iterator |
Private Member Functions | |
| void | check_no_subscribers () const noexcept |
Private Attributes | |
| std::atomic< unsigned int > | counter |
| std::map< const char *, unsigned int > | counter_map |
| 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, when an object, given to a constructor by reference, is stored. Then, the original object may not be deleted before the dependent object is deleted. You can assert this constraint by letting the object passed be derived from this class and let the user subscribe() to this object. The destructor the used object inherits from the Subscriptor class then will lead to an error when destruction is attempted while there are still subscriptions.
The utility of this class is even enhanced by providing identifying strings to the functions subscribe() and unsubscribe(). In case of a hanging subscription during destruction, this string will be listed in the exception's message. 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.
Definition at line 62 of file subscriptor.h.
|
private |
The data type used in counter_map.
Definition at line 198 of file subscriptor.h.
|
private |
The iterator type used in counter_map.
Definition at line 203 of file subscriptor.h.
| Subscriptor::Subscriptor | ( | ) |
Constructor setting the counter to zero.
Definition at line 35 of file subscriptor.cc.
| Subscriptor::Subscriptor | ( | const Subscriptor & | ) |
Copy-constructor.
The counter of the copy is zero, since references point to the original object.
Definition at line 45 of file subscriptor.cc.
|
noexcept |
Move constructor.
An object inheriting from Subscriptor can only be moved if no other objects are subscribing to it.
Definition at line 52 of file subscriptor.cc.
|
virtual |
Destructor, asserting that the counter is zero.
Definition at line 61 of file subscriptor.cc.
| Subscriptor & Subscriptor::operator= | ( | const Subscriptor & | s | ) |
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 136 of file subscriptor.cc.
|
noexcept |
Move assignment operator.
Asserts that the counter for the moved object is zero.
Definition at line 146 of file subscriptor.cc.
| void Subscriptor::subscribe | ( | const char * | identifier = nullptr | ) | const |
Subscribes a user of the object. The subscriber may be identified by text supplied as identifier.
Definition at line 157 of file subscriptor.cc.
| void Subscriptor::unsubscribe | ( | const char * | identifier = nullptr | ) | const |
Unsubscribes a user from the object.
identifier must be the same pointer as the one supplied to subscribe(), not just the same text. Definition at line 179 of file subscriptor.cc.
| 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 205 of file subscriptor.cc.
|
inline |
List the subscribers to the input stream.
Definition at line 276 of file subscriptor.h.
| void Subscriptor::list_subscribers | ( | ) | const |
List the subscribers to deallog.
Definition at line 213 of file subscriptor.cc.
|
inline |
Read or write the data of this object to or from a stream for the purpose of serialization.
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 268 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 69 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 221 of file subscriptor.h.
|
mutableprivate |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 227 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 235 of file subscriptor.h.
|
staticprivate |
A mutex used to ensure data consistency when printing out the list of subscribers.
Definition at line 259 of file subscriptor.h.
1.8.11