![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/lac/petsc_precondition.h>
Classes | |
struct | AdditionalData |
Public Member Functions | |
PreconditionSSOR () | |
PreconditionSSOR (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData()) | |
void | initialize (const MatrixBase &matrix, const AdditionalData &additional_data=AdditionalData()) |
void | clear () |
void | vmult (VectorBase &dst, const VectorBase &src) const |
void | Tvmult (VectorBase &dst, const VectorBase &src) const |
void | setup () |
const PC & | get_pc () const |
MPI_Comm | get_mpi_communicator () 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 Member Functions | |
void | create_pc_with_mat (const MatrixBase &) |
void | create_pc_with_comm (const MPI_Comm) |
Protected Attributes | |
AdditionalData | additional_data |
PC | pc |
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 |
A class that implements the interface to use the PETSc SSOR preconditioner.
Definition at line 358 of file petsc_precondition.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
PreconditionSSOR< MatrixType >::PreconditionSSOR | ( | ) |
Empty Constructor. You need to call initialize() before using this object.
Definition at line 291 of file petsc_precondition.cc.
PreconditionSSOR< MatrixType >::PreconditionSSOR | ( | const MatrixBase & | matrix, |
const AdditionalData & | additional_data = AdditionalData() ) |
Constructor. Take the matrix which is used to form the preconditioner, and additional flags if there are any.
Definition at line 303 of file petsc_precondition.cc.
void PreconditionSSOR< MatrixType >::initialize | ( | const MatrixBase & | matrix, |
const AdditionalData & | additional_data = AdditionalData() ) |
Initialize the preconditioner object and calculate all data that is necessary for applying it in a solver. This function is automatically called when calling the constructor with the same arguments and is only used if you create the preconditioner without arguments.
Definition at line 312 of file petsc_precondition.cc.
|
inherited |
Destroys the preconditioner, leaving an object like just after having called the default constructor.
Definition at line 56 of file petsc_precondition.cc.
|
inherited |
Apply the preconditioner once to the given src vector.
Definition at line 66 of file petsc_precondition.cc.
|
inherited |
Apply the transpose preconditioner once to the given src vector.
Definition at line 75 of file petsc_precondition.cc.
|
inherited |
Explicitly call setup. This is usually not needed since PETSc will automatically call the setup function when needed.
Definition at line 84 of file petsc_precondition.cc.
|
inherited |
Give access to the underlying PETSc object.
Definition at line 125 of file petsc_precondition.cc.
|
inherited |
Return the underlying MPI communicator.
Definition at line 93 of file petsc_precondition.cc.
|
protectedinherited |
Internal function to create the PETSc preconditioner object. Fails if called twice.
Definition at line 99 of file petsc_precondition.cc.
|
protectedinherited |
Internal function to create the PETSc preconditioner object.
Definition at line 117 of file petsc_precondition.cc.
|
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 135 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 155 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 300 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 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 309 of file subscriptor.h.
|
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.
Definition at line 52 of file subscriptor.cc.
|
protected |
Store a copy of the flags for this particular preconditioner.
Definition at line 405 of file petsc_precondition.h.
|
protectedinherited |
The PETSc preconditioner object
Definition at line 120 of file petsc_precondition.h.
|
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 218 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.
|
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 248 of file subscriptor.h.
|
staticprivateinherited |
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 271 of file subscriptor.h.