Reference documentation for deal.II version GIT 2f5445400b 20230205 22:30:02+00:00

#include <deal.II/lac/petsc_solver.h>
Classes  
struct  AdditionalData 
Public Member Functions  
SolverGMRES (SolverControl &cn, const AdditionalData &data=AdditionalData())  
SolverGMRES (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) 
SolverControl &  control () const 
void  initialize (const PreconditionBase &preconditioner) 
Protected Member Functions  
virtual void  set_solver_type (KSP &ksp) const override 
Protected Attributes  
const AdditionalData  additional_data 
SolverControl &  solver_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) 
Private Attributes  
std::unique_ptr< SolverData >  solver_data 
An implementation of the solver interface using the PETSc GMRES solver.
Definition at line 447 of file petsc_solver.h.
SolverGMRES< VectorType >::SolverGMRES  (  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 400 of file petsc_solver.cc.
SolverGMRES< VectorType >::SolverGMRES  (  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 406 of file petsc_solver.cc.

overrideprotectedvirtual 
Function that takes a Krylov Subspace Solver context object, and sets the type of solver that is appropriate for this class.
Implements PETScWrappers::SolverBase.
Definition at line 414 of file petsc_solver.cc.

inherited 
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 petsc_solver.cc.

virtualinherited 
Resets the contained preconditioner and solver object. See class description for more details.
Definition at line 149 of file petsc_solver.cc.

inherited 
Sets a prefix name for the solver object. Useful when customizing the PETSc KSP object with commandline options.
Definition at line 142 of file petsc_solver.cc.

inherited 
Access to object that controls convergence.
Definition at line 156 of file petsc_solver.cc.

inherited 
initialize the solver with the preconditioner. This function is intended for use with SLEPc spectral transformation class.
Definition at line 203 of file petsc_solver.cc.

staticprivateinherited 
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 163 of file petsc_solver.cc.

protected 
Store a copy of the flags for this particular solver.
Definition at line 498 of file petsc_solver.h.

protectedinherited 
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.

protectedinherited 
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.

privateinherited 
Pointer to an object that stores the solver context. This is recreated in the main solver routine if necessary.
Definition at line 216 of file petsc_solver.h.