deal.II version GIT relicensing-3512-g0a98d4ed9f 2025-06-14 14:10:00+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
SparseDirectMUMPS Class Reference

#include <deal.II/lac/sparse_direct.h>

Detailed Description

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.

Note
This class is useable if and only if a working installation of MUMPS exists on your system and was detected during configuration of deal.II.

Instantiations

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.

Inheritance diagram for SparseDirectMUMPS:
Inheritance graph
[legend]

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
 
intget_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 ::ExceptionBaseExcInitializeAlreadyCalled ()
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (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 intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 

Static Private Attributes

static std::mutex mutex
 

Member Typedef Documentation

◆ size_type

Declare type for container size.

Definition at line 470 of file sparse_direct.h.

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 224 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 229 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ SparseDirectMUMPS()

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::~SparseDirectMUMPS ( )

Destructor.

Definition at line 1111 of file sparse_direct.cc.

Member Function Documentation

◆ initialize()

template<class Matrix >
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.

◆ vmult()

void SparseDirectMUMPS::vmult ( Vector< double > &  dst,
const Vector< double > &  src 
) const

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.

◆ Tvmult()

void SparseDirectMUMPS::Tvmult ( Vector< double > &  dst,
const Vector< double > &  src 
) const

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.

◆ get_icntl()

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.

◆ initialize_matrix()

template<class Matrix >
void SparseDirectMUMPS::initialize_matrix ( const Matrix &  matrix)
private

This function hands over to MUMPS the system's matrix.

◆ copy_solution()

void SparseDirectMUMPS::copy_solution ( Vector< double > &  vector) const
private

Copy the computed solution into the solution vector.

◆ copy_rhs_to_mumps()

void SparseDirectMUMPS::copy_rhs_to_mumps ( const Vector< double > &  rhs) const
private

Copy the right-hand side vector into the MUMPS instance.

◆ 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 340 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void EnableObserverPointer::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 357 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 200 of file enable_observer_pointer.cc.

◆ 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 349 of file enable_observer_pointer.h.

◆ subscribe()

void EnableObserverPointer::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
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.

◆ unsubscribe()

void EnableObserverPointer::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
privateinherited

Unsubscribes a user from the object.

Note
The 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.

◆ 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 54 of file enable_observer_pointer.cc.

Member Data Documentation

◆ a

std::unique_ptr<double[]> SparseDirectMUMPS::a
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.

◆ rhs

std::vector<double> SparseDirectMUMPS::rhs
mutableprivate

The right-hand side vector. This is the right hand side of the system.

Definition at line 619 of file sparse_direct.h.

◆ irn

std::unique_ptr<types::mumps_index[]> SparseDirectMUMPS::irn
private

irn contains the row indices of the non-zero entries of the matrix.

Definition at line 624 of file sparse_direct.h.

◆ jcn

std::unique_ptr<types::mumps_index[]> SparseDirectMUMPS::jcn
private

jcn contains the column indices of the non-zero entries of the matrix.

Definition at line 629 of file sparse_direct.h.

◆ n

types::global_dof_index SparseDirectMUMPS::n
private

The number of rows of the matrix. The matrix is square.

Definition at line 634 of file sparse_direct.h.

◆ nnz

types::mumps_nnz SparseDirectMUMPS::nnz
private

The number of non-zero entries in the matrix.

Definition at line 639 of file sparse_direct.h.

◆ additional_data

AdditionalData SparseDirectMUMPS::additional_data
private

Struct that holds the additional data for the MUMPS solver.

Definition at line 663 of file sparse_direct.h.

◆ mpi_communicator

const MPI_Comm SparseDirectMUMPS::mpi_communicator
private

MPI_Comm object for the MUMPS solver.

Definition at line 668 of file sparse_direct.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 213 of file enable_observer_pointer.h.

◆ counter_map

std::map<std::string, unsigned int> EnableObserverPointer::counter_map
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.

◆ validity_pointers

std::vector<std::atomic<bool> *> EnableObserverPointer::validity_pointers
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.

◆ 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 243 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex
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.


The documentation for this class was generated from the following files: