Reference documentation for deal.II version GIT 9c182271f7 2023-03-28 14:30:01+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\}}\)
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Member Functions | Private Attributes | List of all members
PETScWrappers::SparseDirectMUMPS Class Reference

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

Inheritance diagram for PETScWrappers::SparseDirectMUMPS:


struct  AdditionalData
struct  SolverDataMUMPS

Public Member Functions

 SparseDirectMUMPS (SolverControl &cn, const AdditionalData &data=AdditionalData())
 SparseDirectMUMPS (SolverControl &cn, const MPI_Comm &mpi_communicator, const AdditionalData &data=AdditionalData())
void solve (const MatrixBase &A, VectorBase &x, const VectorBase &b)
void set_symmetric_mode (const bool flag)
void solve (const MatrixBase &A, VectorBase &x, const VectorBase &b, const PreconditionBase &preconditioner)
virtual void reset ()
void set_prefix (const std::string &prefix)
SolverControlcontrol () const
void initialize (const PreconditionBase &preconditioner)

Protected Member Functions

virtual void set_solver_type (KSP &ksp) const override

Protected Attributes

const AdditionalData additional_data
std::string prefix_name

Static Private Member Functions

static PetscErrorCode convergence_test (KSP ksp, const PetscInt iteration, const PetscReal residual_norm, KSPConvergedReason *reason, void *solver_control)

Private Attributes

std::unique_ptr< SolverDataMUMPSsolver_data
bool symmetric_mode

Detailed Description

An implementation of the solver interface using the sparse direct MUMPS solver through PETSc. This class has the usual interface of all other solver classes but it is of course different in that it doesn't implement an iterative solver. As a consequence, things like the SolverControl object have no particular meaning here.

MUMPS allows to make use of symmetry in this matrix. In this class this is made possible by the set_symmetric_mode() function. If your matrix is symmetric, you can use this class as follows:

PETScWrappers::SparseDirectMUMPS solver(cn, mpi_communicator);
solver.solve(system_matrix, solution, system_rhs);
The class internally calls KSPSetFromOptions thus you are able to use all the PETSc parameters for MATSOLVERMUMPS package. See

Definition at line 899 of file petsc_solver.h.

Constructor & Destructor Documentation

◆ SparseDirectMUMPS() [1/2]

PETScWrappers::SparseDirectMUMPS::SparseDirectMUMPS ( SolverControl cn,
const AdditionalData data = AdditionalData() 


Definition at line 654 of file

◆ SparseDirectMUMPS() [2/2]

PETScWrappers::SparseDirectMUMPS::SparseDirectMUMPS ( SolverControl cn,
const MPI_Comm &  mpi_communicator,
const AdditionalData data = AdditionalData() 

Constructor. This constructor is deprecated and ignores the MPI communicator argument. Use the other constructor instead.


Definition at line 663 of file

Member Function Documentation

◆ solve() [1/2]

void PETScWrappers::SparseDirectMUMPS::solve ( const MatrixBase A,
VectorBase x,
const VectorBase b 

The method to solve the linear system.

Definition at line 707 of file

◆ set_symmetric_mode()

void PETScWrappers::SparseDirectMUMPS::set_symmetric_mode ( const bool  flag)

The method allows to take advantage if the system matrix is symmetric by using LDL^T decomposition instead of more expensive LU. The argument indicates whether the matrix is symmetric or not.

Definition at line 920 of file

◆ set_solver_type()

void PETScWrappers::SparseDirectMUMPS::set_solver_type ( KSP &  ksp) const

Function that takes a Krylov Subspace Solver context object, and sets the type of solver that is requested by the derived class.

Implements PETScWrappers::SolverBase.

Definition at line 680 of file

◆ convergence_test()

PetscErrorCode PETScWrappers::SparseDirectMUMPS::convergence_test ( KSP  ksp,
const PetscInt  iteration,
const PetscReal  residual_norm,
KSPConvergedReason *  reason,
void *  solver_control 

A function that is used in PETSc as a callback to check convergence. It takes the information provided from PETSc and checks it against deal.II's own SolverControl objects to see if convergence has been reached.

Definition at line 881 of file

◆ solve() [2/2]

void SolverBase< VectorType >::solve ( const MatrixBase A,
VectorBase x,
const VectorBase b,
const PreconditionBase preconditioner 

Solve the linear system Ax=b. Depending on the information provided by derived classes and the object passed as a preconditioner, one of the linear solvers and preconditioners of PETSc is chosen. Repeated calls to solve() do not reconstruct the preconditioner for performance reasons. See class Documentation.

Definition at line 52 of file

◆ reset()

void SolverBase< VectorType >::reset ( )

Resets the contained preconditioner and solver object. See class description for more details.

Definition at line 149 of file

◆ set_prefix()

void SolverBase< VectorType >::set_prefix ( const std::string &  prefix)

Sets a prefix name for the solver object. Useful when customizing the PETSc KSP object with command-line options.

Definition at line 142 of file

◆ control()

SolverControl & SolverBase< VectorType >::control ( ) const

Access to object that controls convergence.

Definition at line 156 of file

◆ initialize()

void SolverBase< VectorType >::initialize ( const PreconditionBase preconditioner)

initialize the solver with the preconditioner. This function is intended for use with SLEPc spectral transformation class.

Definition at line 203 of file

Member Data Documentation

◆ additional_data

const AdditionalData PETScWrappers::SparseDirectMUMPS::additional_data

Store a copy of flags for this particular solver.

Definition at line 943 of file petsc_solver.h.

◆ solver_data

std::unique_ptr<SolverDataMUMPS> PETScWrappers::SparseDirectMUMPS::solver_data

Definition at line 978 of file petsc_solver.h.

◆ symmetric_mode

bool PETScWrappers::SparseDirectMUMPS::symmetric_mode

Flag specifies whether matrix being factorized is symmetric or not. It influences the type of the used preconditioner (PCLU or PCCHOLESKY)

Definition at line 984 of file petsc_solver.h.

◆ solver_control

SolverControl& PETScWrappers::SolverBase::solver_control

Reference to the object that controls convergence of the iterative solver. In fact, for these PETSc wrappers, PETSc does so itself, but we copy the data from this object before starting the solution process, and copy the data back into it afterwards.

Definition at line 151 of file petsc_solver.h.

◆ prefix_name

std::string PETScWrappers::SolverBase::prefix_name

Solver prefix name to qualify options specific to the PETSc KSP object in the current context. Note: A hyphen (-) must NOT be given at the beginning of the prefix name. The first character of all runtime options is AUTOMATICALLY the hyphen.

Definition at line 166 of file petsc_solver.h.

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