Reference documentation for deal.II version 9.3.0

#include <deal.II/lac/petsc_solver.h>
Classes  
struct  AdditionalData 
Public Member Functions  
SolverBiCG (SolverControl &cn, const MPI_Comm &mpi_communicator=PETSC_COMM_SELF, 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 
const MPI_Comm  mpi_communicator 
std::string  prefix_name 
An implementation of the solver interface using the PETSc BiCG solver.
Definition at line 429 of file petsc_solver.h.
PETScWrappers::SolverBiCG::SolverBiCG  (  SolverControl &  cn, 
const MPI_Comm &  mpi_communicator = PETSC_COMM_SELF , 

const AdditionalData &  data = AdditionalData() 

) 
Constructor. In contrast to deal.II's own solvers, there is no need to give a vector memory object. However, PETSc solvers want to have an MPI communicator context over which computations are parallelized. By default, PETSC_COMM_SELF
is used here, but you can change this. Note that for single processor (nonMPI) versions, this parameter does not have any effect.
The last argument takes a structure with additional, solver dependent flags for tuning.
Note that the communicator used here must match the communicator used in the system matrix, solution, and right hand side object of the solve to be done with this solver. Otherwise, PETSc will generate hard to track down errors, see the documentation of the SolverBase class.
Definition at line 354 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 363 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 53 of file petsc_solver.cc.

virtualinherited 
Resets the contained preconditioner and solver object. See class description for more details.
Definition at line 161 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 154 of file petsc_solver.cc.

inherited 
Access to object that controls convergence.
Definition at line 168 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 213 of file petsc_solver.cc.

protected 
Store a copy of the flags for this particular solver.
Definition at line 462 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 181 of file petsc_solver.h.

protectedinherited 
Copy of the MPI communicator object to be used for the solver.
Definition at line 186 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 201 of file petsc_solver.h.