Reference documentation for deal.II version GIT relicensing-12-g89ba5bf9db 2024-02-24 00:00:03+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\}}\)
No Matches
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Member Functions | List of all members
PETScWrappers::SolverRichardson Class Reference

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

Inheritance diagram for PETScWrappers::SolverRichardson:
Inheritance graph


struct  AdditionalData

Public Member Functions

 SolverRichardson (SolverControl &cn, const AdditionalData &data=AdditionalData())
 SolverRichardson (SolverControl &cn, const MPI_Comm mpi_communicator, const AdditionalData &data=AdditionalData())
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)
KSP petsc_ksp ()
 operator KSP () const

Protected Member Functions

virtual void set_solver_type (KSP &ksp) const override
void initialize_ksp_with_comm (const MPI_Comm comm)
void perhaps_set_convergence_test () const

Protected Attributes

const AdditionalData additional_data
KSP ksp
SmartPointer< SolverControl, SolverBasesolver_control
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)

Detailed Description

An implementation of the solver interface using the PETSc Richardson solver.

Definition at line 237 of file petsc_solver.h.

Constructor & Destructor Documentation

◆ SolverRichardson() [1/2]

SolverRichardson< VectorType >::SolverRichardson ( SolverControl cn,
const AdditionalData data = AdditionalData() 

Constructor. In contrast to deal.II's own solvers, there is no need to give a vector memory object.

The last argument takes a structure with additional, solver dependent flags for tuning.

Definition at line 256 of file

◆ SolverRichardson() [2/2]

SolverRichardson< VectorType >::SolverRichardson ( 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 264 of file

Member Function Documentation

◆ set_solver_type()

void SolverRichardson< VectorType >::set_solver_type ( KSP &  ksp) const

Function that takes a Krylov Subspace Solver context object, and sets the type of solver that is appropriate for this class.

Reimplemented from PETScWrappers::SolverBase.

Definition at line 272 of file

◆ solve()

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 83 of file

◆ reset()

void SolverBase< VectorType >::reset ( )

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

Definition at line 148 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 141 of file

◆ control()

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

Access to object that controls convergence.

Definition at line 155 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 231 of file

◆ petsc_ksp()

KSP SolverBase< VectorType >::petsc_ksp ( )

Return the PETSc KSP object.

Definition at line 68 of file

◆ operator KSP()

SolverBase< VectorType >::operator KSP ( ) const

Conversion operator to gain access to the underlying PETSc type. If you do this, you cut this class off some information it may need, so this conversion operator should only be used if you know what you do.

Definition at line 75 of file

◆ initialize_ksp_with_comm()

void SolverBase< VectorType >::initialize_ksp_with_comm ( const MPI_Comm  comm)

Utility to create the KSP object and attach convergence test.

Definition at line 206 of file

◆ perhaps_set_convergence_test()

void SolverBase< VectorType >::perhaps_set_convergence_test ( ) const

Utility to use deal.II convergence testing.

This call changes the convergence criterion when the instance of the class has a SolverControl object associated.

Definition at line 222 of file

◆ convergence_test()

PetscErrorCode SolverBase< VectorType >::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 on 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 166 of file

Member Data Documentation

◆ additional_data

const AdditionalData PETScWrappers::SolverRichardson::additional_data

Store a copy of the flags for this particular solver.

Definition at line 281 of file petsc_solver.h.

◆ ksp

KSP PETScWrappers::SolverBase::ksp

The PETSc KSP object.

Definition at line 167 of file petsc_solver.h.

◆ solver_control

SmartPointer<SolverControl, SolverBase> 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 175 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 205 of file petsc_solver.h.

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