#include <deal.II/lac/precondition.h>
template<typename MatrixType = SparseMatrix<double>>
class PreconditionSSOR< MatrixType >
SSOR preconditioner using matrix built-in function. The MatrixType
class used is required to have a function precondition_SSOR(VectorType&, const VectorType&, double)
. This class satisfies the relaxation concept.
solver.solve (
A, x, b, precondition);
ObserverPointer< const MatrixType, PreconditionRelaxation< MatrixType > > A
void initialize(const MatrixType &A, const AdditionalData ¶meters=AdditionalData())
typename BaseClass::AdditionalData AdditionalData
Definition at line 1773 of file precondition.h.
◆ PreconditionerType
template<typename MatrixType = SparseMatrix<double>>
using PreconditionSSOR< MatrixType >::PreconditionerType = internal::PreconditionRelaxation::PreconditionSSORImpl<MatrixType> |
|
private |
◆ BaseClass
template<typename MatrixType = SparseMatrix<double>>
◆ AdditionalData
template<typename MatrixType = SparseMatrix<double>>
An alias to the base class AdditionalData.
Definition at line 1786 of file precondition.h.
◆ size_type
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
◆ EigenvalueInformation
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
◆ map_value_type
◆ map_iterator
◆ initialize()
template<typename MatrixType = SparseMatrix<double>>
Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object. The relaxation parameter should be larger than zero and smaller than 2 for numerical reasons. It defaults to 1.
◆ clear()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
Release the matrix and reset its pointer.
◆ m()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).
◆ n()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).
◆ vmult()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
template<typename VectorType >
◆ Tvmult()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
template<typename VectorType >
Apply transpose preconditioner. Since this is a symmetric preconditioner, this function is the same as vmult().
◆ step()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
template<typename VectorType >
Perform one step of the preconditioned Richardson iteration
◆ Tstep()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
template<typename VectorType >
Perform one transposed step of the preconditioned Richardson iteration.
◆ estimate_eigenvalues()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
template<typename VectorType >
Estimate eigenvalues and set relaxation parameter.
◆ get_relaxation()
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
Return the relaxation parameter. This function also allows to return the parameter in case it was internally determined by running an eigenvalue algorithm.
◆ 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_observer_pointer.cc.
◆ unsubscribe()
void EnableObserverPointer::unsubscribe |
( |
std::atomic< bool > *const |
validity, |
|
|
const std::string & |
identifier = "" |
|
) |
| const |
|
inherited |
◆ 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 322 of file enable_observer_pointer.h.
◆ list_subscribers() [1/2]
template<typename StreamType >
void EnableObserverPointer::list_subscribers |
( |
StreamType & |
stream | ) |
const |
|
inlineinherited |
◆ list_subscribers() [2/2]
void EnableObserverPointer::list_subscribers |
( |
| ) |
const |
|
inherited |
◆ 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 331 of file enable_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_observer_pointer.cc.
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
◆ data
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
Stores the additional data passed to the initialize function, obtained through a copy operation.
Definition at line 691 of file precondition.h.
◆ preconditioner
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
◆ eigenvalues_are_initialized
template<typename MatrixType = SparseMatrix<double>, typename
PreconditionerType = IdentityMatrix>
Stores whether the preconditioner has been set up and eigenvalues have been computed.
Definition at line 702 of file precondition.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 227 of file enable_observer_pointer.h.
◆ counter_map
std::map<std::string, unsigned int> EnableObserverPointer::counter_map |
|
mutableprivateinherited |
◆ validity_pointers
std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers |
|
mutableprivateinherited |
◆ 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 257 of file enable_observer_pointer.h.
◆ mutex
std::mutex EnableObserverPointer::mutex |
|
staticprivateinherited |
The documentation for this class was generated from the following file: