![]() |
deal.II version GIT relicensing-3512-g0a98d4ed9f 2025-06-14 14:10:00+00:00
|
#include <deal.II/lac/sparse_direct.h>
This class provides an interface to the parallel sparse direct solver MUMPS. MUMPS is direct method based on a multifrontal approach, which performs a direct LU factorization. The matrix coming in may have either symmetric or nonsymmetric sparsity pattern.
deal.II
.There are instantiations of this class for SparseMatrix<double>, SparseMatrix<float>, BlockSparseMatrix<double>, and BlockSparseMatrix<float>.
Definition at line 464 of file sparse_direct.h.
Classes | |
struct | AdditionalData |
Public Types | |
using | size_type = types::global_dof_index |
Public Member Functions | |
SparseDirectMUMPS (const AdditionalData &additional_data=AdditionalData(), const MPI_Comm &communicator=MPI_COMM_WORLD) | |
~SparseDirectMUMPS () | |
template<class Matrix > | |
void | initialize (const Matrix &matrix) |
void | vmult (Vector< double > &dst, const Vector< double > &src) const |
void | Tvmult (Vector< double > &dst, const Vector< double > &src) const |
int * | get_icntl () |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Querying the observer pointers an object has. | |
unsigned int | n_subscriptions () const |
template<typename StreamType > | |
void | list_subscribers (StreamType &stream) const |
void | list_subscribers () const |
Static Public Member Functions | |
static ::ExceptionBase & | ExcInitializeAlreadyCalled () |
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 = decltype(counter_map)::value_type |
using | map_iterator = decltype(counter_map)::iterator |
Private Member Functions | |
template<class Matrix > | |
void | initialize_matrix (const Matrix &matrix) |
void | copy_solution (Vector< double > &vector) const |
void | copy_rhs_to_mumps (const Vector< double > &rhs) const |
EnableObserverPointer functionality | |
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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 |
void | check_no_subscribers () const noexcept |
Private Attributes | |
std::unique_ptr< double[]> | a |
std::vector< double > | rhs |
std::unique_ptr< types::mumps_index[]> | irn |
std::unique_ptr< types::mumps_index[]> | jcn |
types::global_dof_index | n |
types::mumps_nnz | nnz |
AdditionalData | additional_data |
const MPI_Comm | mpi_communicator |
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 |
Declare type for container size.
Definition at line 470 of file sparse_direct.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 224 of file enable_observer_pointer.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 229 of file enable_observer_pointer.h.
SparseDirectMUMPS::SparseDirectMUMPS | ( | const AdditionalData & | additional_data = AdditionalData() , |
const MPI_Comm & | communicator = MPI_COMM_WORLD |
||
) |
Constructor, takes AdditionalData
to control MUMPS execution.
Definition at line 1098 of file sparse_direct.cc.
SparseDirectMUMPS::~SparseDirectMUMPS | ( | ) |
Destructor.
Definition at line 1111 of file sparse_direct.cc.
void SparseDirectMUMPS::initialize | ( | const Matrix & | matrix | ) |
This function computes the LU factorization of the system's matrix matrix
with the options given in the constructor's AdditionalData
.
A function in which the inverse of the matrix is applied to the input vector src
and the solution is written into the output vector dst
.
A function in which the inverse of the transposed matrix is applied to the input vector src
and the solution is written into the output vector dst
.
int * SparseDirectMUMPS::get_icntl | ( | ) |
A function that returns the ICNTL integer array from MUMPS. The ICNTL array contains integer control parameters for the MUMPS solver. Keep in mind that MUMPS is a fortran library and the documentation refers to indices into this array starting from one rather than from zero. To select the correct index one can use a macro like this: #define ICNTL(I) icntl[(I)-1]
. In the MUMPS documentation there is the description of each parameter of the array. Be aware that ownership of the array remains in the current class rather than with the caller of this function.
|
private |
This function hands over to MUMPS the system's matrix
.
|
private |
Copy the computed solution into the solution vector.
|
private |
Copy the right-hand side vector into the MUMPS instance.
|
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 340 of file enable_observer_pointer.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 357 of file enable_observer_pointer.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 200 of file enable_observer_pointer.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 349 of file enable_observer_pointer.h.
|
privateinherited |
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 132 of file enable_observer_pointer.cc.
|
privateinherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 152 of file enable_observer_pointer.cc.
|
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 54 of file enable_observer_pointer.cc.
|
private |
a contains the actual values of the matrix. a[k] is the value of the matrix entry (i,j) if irn[k] == i and jcn[k] == j.
Definition at line 614 of file sparse_direct.h.
|
mutableprivate |
The right-hand side vector. This is the right hand side of the system.
Definition at line 619 of file sparse_direct.h.
|
private |
irn contains the row indices of the non-zero entries of the matrix.
Definition at line 624 of file sparse_direct.h.
|
private |
jcn contains the column indices of the non-zero entries of the matrix.
Definition at line 629 of file sparse_direct.h.
|
private |
The number of rows of the matrix. The matrix is square.
Definition at line 634 of file sparse_direct.h.
|
private |
The number of non-zero entries in the matrix.
Definition at line 639 of file sparse_direct.h.
|
private |
Struct that holds the additional data for the MUMPS solver.
Definition at line 663 of file sparse_direct.h.
|
private |
MPI_Comm object for the MUMPS solver.
Definition at line 668 of file sparse_direct.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 213 of file enable_observer_pointer.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 219 of file enable_observer_pointer.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.
Definition at line 235 of file enable_observer_pointer.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 243 of file enable_observer_pointer.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 250 of file enable_observer_pointer.h.