 |
Reference documentation for deal.II version 8.5.1
|
|
Reference documentation for deal.II version 8.5.1
|
#include <deal.II/base/subscriptor.h>
Inherited by Algorithms::OperatorBase, Algorithms::OutputOperator< VectorType >, Algorithms::TimestepControl, AnyData, ArpackSolver, BlockDiagonalMatrix< MatrixType >, BlockIndices, BlockInfo, BlockMatrixArray< number, BlockVectorType >, BlockMatrixBase< MatrixType >, BlockMatrixBase< PETScWrappers::SparseMatrix >, BlockMatrixBase< SparseMatrix >, BlockMatrixBase< SparseMatrix< number > >, BlockSparseMatrixEZ< Number >, BlockSparsityPatternBase< SparsityPatternType >, BlockSparsityPatternBase< DynamicSparsityPattern >, BlockSparsityPatternBase< SparsityPattern >, BlockVectorBase< VectorType >, BlockVectorBase< Vector >, BlockVectorBase< Vector< Number > >, CellDataStorage< CellIteratorType, DataType >, ChunkSparseMatrix< number > [virtual], ChunkSparsityPattern, ConstraintMatrix, DataPostprocessor< dim >, DataPostprocessor< DoFHandlerType::space_dimension >, DiagonalMatrix< VectorType >, DoFHandler< dim, spacedim >, hp::DoFHandler< dim >, DoFHandler< dim >, DynamicSparsityPattern, hp::FECollection< dim >, hp::FECollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension >, hp::FECollection< dim, ::FESubfaceValues< dim, spacedim > ::space_dimension >, hp::FECollection< dim, ::FEValues< dim, spacedim > ::space_dimension >, hp::FECollection< dim, dim >, hp::FECollection< dim, FEValuesType::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, Number >, Function< 2 >, Function< chartdim >, Function< dim >, Function< dim, VectorType::value_type >, Function< spacedim >, hp::DoFHandler< dim, spacedim >, hp::FECollection< dim, spacedim >, hp::MappingCollection< dim, spacedim >, hp::QCollection< dim >, InterGridMap< MeshType >, InverseMatrixRichardson< VectorType >, IterativeInverse< VectorType >, LinearAlgebra::distributed::Vector< Number >, LinearAlgebra::ReadWriteVector< Number >, LogStream, Manifold< dim, spacedim >, Manifold< dim, dim >, Mapping< dim, spacedim >, Mapping< dim >, hp::MappingCollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension >, hp::MappingCollection< dim, ::FESubfaceValues< dim, spacedim > ::space_dimension >, hp::MappingCollection< dim, ::FEValues< dim, spacedim > ::space_dimension >, hp::MappingCollection< dim, FEValuesType::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< MatrixType >, MGLevelObject< PointerMatrix< MatrixType, BlockVector< number > > >, MGLevelObject< PointerMatrix< MatrixType, VectorType > >, MGLevelObject< PointerMatrix< RelaxationType, BlockVector< number > > >, MGLevelObject< PreconditionerType >, MGLevelObject< RelaxationType >, MGLevelObject< SparseMatrix< number > >, MGLevelObject< SparsityPattern >, MGLevelObject< std_cxx11::shared_ptr< PointerMatrixBase< VectorType > > >, MGLevelObject< VectorType >, MGMatrixBase< VectorType >, MGMatrixBase< Vector< number > >, MGMatrixBlockVector< MatrixType >, MGSmootherBase< VectorType >, MGSmootherBase< BlockVector< number > >, MGTransferBase< VectorType >, MGTransferBase< BlockVector< number > >, MGTransferBase< LinearAlgebra::distributed::Vector< Number > >, MGTransferBase< Vector< number > >, Multigrid< VectorType >, ParameterHandler, PArpackSolver< VectorType >, PArpackSolver< VectorType >::Shift< MatrixType >, PETScWrappers::MatrixBase, PETScWrappers::VectorBase, Polynomials::PiecewisePolynomial< double >, PointerMatrixBase< VectorType >, PointerMatrixBase< typename BlockVectorType::BlockType >, PointerMatrixBase< Vector< number > >, PointerMatrixBase< Vector< 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< dim-1 >, hp::QCollection< q_dim >, Quadrature< dim >, Quadrature< 1 >, Quadrature< dim-1 >, RelaxationBlock< MatrixType, InverseNumberType, VectorType >::AdditionalData, RelaxationBlockJacobi< MatrixType, InverseNumberType, VectorType > [virtual], RelaxationBlockSOR< MatrixType, InverseNumberType, VectorType > [virtual], RelaxationBlockSSOR< MatrixType, InverseNumberType, VectorType > [virtual], ScaledMatrix< VectorType >, SchurMatrix< MA_inverse, MB, MDt, MC >, 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, T >, TableBase< 3, T >, TableBase< 4, T >, TableBase< 5, T >, TableBase< 6, T >, TableBase< 7, T >, TensorFunction< rank, dim, Number >, TensorFunction< 1, dim, Number >, TimeStepBase, Triangulation< dim, spacedim >, Triangulation< dim >, Triangulation< dim, dim >, Triangulation< DoFHandler< dim > ::dimension, DoFHandler< dim > ::space_dimension >, Triangulation< DoFHandlerType::dimension, DoFHandlerType::space_dimension >, TrilinosWrappers::PreconditionBase, TrilinosWrappers::SparseMatrix, TrilinosWrappers::SparsityPattern, TrilinosWrappers::VectorBase, Vector< Number >, LinearAlgebra::distributed::Vector< double >, Vector< double >, Vector< number >, Vector< typename VectorType::value_type >, Vector< value_type >, VectorMemory< VectorType >, VectorMemory< BlockVector< double > >, VectorMemory< BlockVector< number > >, VectorMemory< Vector >, and VectorMemory< Vector< number > >.
Public Member Functions | |
| Subscriptor () | |
| Subscriptor (const Subscriptor &) | |
| Subscriptor (Subscriptor &&) | |
| virtual | ~Subscriptor () |
| Subscriptor & | operator= (const Subscriptor &) |
| Subscriptor & | operator= (Subscriptor &&) |
| void | subscribe (const char *identifier=0) const |
| void | unsubscribe (const char *identifier=0) const |
| unsigned int | n_subscriptions () 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, char *arg2, std::string &arg3) |
| static ::ExceptionBase & | ExcNoSubscriber (char *arg1, char *arg2) |
Private Types | |
| typedef std::map< const char *, unsigned int >::value_type | map_value_type |
| typedef std::map< const char *, unsigned int >::iterator | map_iterator |
Private Member Functions | |
| void | check_no_subscribers () const |
Private Attributes | |
| DEAL_VOLATILE unsigned int | counter |
| std::map< const char *, unsigned int > | counter_map |
| const std::type_info * | object_info |
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. For reasons of efficiency, these strings are handled as const char*. 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.
volatile declarations, this additional feature is switched off if multithreading is used.Definition at line 56 of file subscriptor.h.
|
private |
The data type used in counter_map.
Definition at line 179 of file subscriptor.h.
|
private |
The iterator type used in counter_map.
Definition at line 185 of file subscriptor.h.
| Subscriptor::Subscriptor | ( | ) |
Constructor setting the counter to zero.
Definition at line 47 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 58 of file subscriptor.cc.
| Subscriptor::Subscriptor | ( | Subscriptor && | subscriptor | ) |
Move constructor.
An object inheriting from Subscriptor can only be moved if no other objects are subscribing to it.
Definition at line 67 of file subscriptor.cc.
|
virtual |
Destructor, asserting that the counter is zero.
Definition at line 78 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 154 of file subscriptor.cc.
| Subscriptor & Subscriptor::operator= | ( | Subscriptor && | s | ) |
Move assignment operator.
Asserts that the counter for the moved object is zero.
Definition at line 163 of file subscriptor.cc.
| void Subscriptor::subscribe | ( | const char * | identifier = 0 | ) | const |
Subscribes a user of the object. The subscriber may be identified by text supplied as identifier.
Definition at line 173 of file subscriptor.cc.
| void Subscriptor::unsubscribe | ( | const char * | identifier = 0 | ) | 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 200 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 227 of file subscriptor.cc.
| void Subscriptor::list_subscribers | ( | ) | const |
List the subscribers to deallog.
Definition at line 234 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 232 of file subscriptor.h.
|
private |
Check that there are no objects subscribing to this object and throw an error if there are, in order to guarantee that it is safe to either move or destroy this object.
Definition at line 90 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.
In multithreaded mode, this counter may be modified by different threads. We thus have to mark it volatile. However, this is counter- productive in non-MT mode since it may pessimize code. So use the macro defined in deal.II/base/config.h to selectively add volatility.
Definition at line 203 of file subscriptor.h.
|
mutableprivate |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 209 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 217 of file subscriptor.h.
1.8.14