![]() |
Reference documentation for deal.II version Git 74ec1a6c4b 2021-01-19 10:11:04 -0500
|
#include <deal.II/lac/precondition.h>
Classes | |
class | AdditionalData |
Public Types | |
using | size_type = typename MatrixType::size_type |
Public Member Functions | |
void | initialize (const MatrixType &A, const std::vector< size_type > &permutation, const std::vector< size_type > &inverse_permutation, const typename PreconditionRelaxation< MatrixType >::AdditionalData ¶meters=typename PreconditionRelaxation< MatrixType >::AdditionalData()) |
void | initialize (const MatrixType &A, const AdditionalData &additional_data) |
template<class VectorType > | |
void | vmult (VectorType &, const VectorType &) const |
template<class VectorType > | |
void | Tvmult (VectorType &, const VectorType &) const |
void | initialize (const MatrixType &A, const AdditionalData ¶meters=AdditionalData()) |
void | clear () |
size_type | m () const |
size_type | n () const |
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 SmartPointer 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) |
Protected Attributes | |
SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > > | A |
double | relaxation |
Private Attributes | |
const std::vector< size_type > * | permutation |
const std::vector< size_type > * | inverse_permutation |
Permuted SOR preconditioner using matrix built-in function. The MatrixType
class used is required to have functions PSOR(VectorType&, const VectorType&, double)
and TPSOR(VectorType&, const VectorType&, double)
.
Definition at line 749 of file precondition.h.
using PreconditionPSOR< MatrixType >::size_type = typename MatrixType::size_type |
Declare type for container size.
Definition at line 755 of file precondition.h.
void PreconditionPSOR< MatrixType >::initialize | ( | const MatrixType & | A, |
const std::vector< size_type > & | permutation, | ||
const std::vector< size_type > & | inverse_permutation, | ||
const typename PreconditionRelaxation< MatrixType >::AdditionalData & | parameters = typename PreconditionRelaxation< MatrixType >::AdditionalData() |
||
) |
Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object.
The permutation vector is stored as a pointer. Therefore, it has to be assured that the lifetime of the vector exceeds the lifetime of the preconditioner.
The relaxation parameter should be larger than zero and smaller than 2 for numerical reasons. It defaults to 1.
void PreconditionPSOR< MatrixType >::initialize | ( | const MatrixType & | A, |
const AdditionalData & | additional_data | ||
) |
Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object.
For more detail about possible parameters, see the class documentation and the documentation of the PreconditionPSOR::AdditionalData class.
After this function is called the preconditioner is ready to be used (using the vmult
function of derived classes).
void PreconditionPSOR< MatrixType >::vmult | ( | VectorType & | , |
const VectorType & | |||
) | const |
Apply preconditioner.
void PreconditionPSOR< MatrixType >::Tvmult | ( | VectorType & | , |
const VectorType & | |||
) | const |
Apply transpose preconditioner.
|
inherited |
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.
|
inherited |
Release the matrix and reset its pointer.
|
inherited |
Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).
|
inherited |
Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).
|
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 136 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 156 of file subscriptor.cc.
|
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 301 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 204 of file subscriptor.cc.
|
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 310 of file subscriptor.h.
|
private |
Storage for the permutation vector.
Definition at line 844 of file precondition.h.
|
private |
Storage for the inverse permutation vector.
Definition at line 848 of file precondition.h.
|
protectedinherited |
Pointer to the matrix object.
Definition at line 460 of file precondition.h.
|
protectedinherited |
Relaxation parameter.
Definition at line 465 of file precondition.h.