petsc-3.14.6 2021-03-30
Report Typos and Errors

KSPSetType

Builds KSP for a particular solver.

Synopsis

#include "petscksp.h" 
PetscErrorCode  KSPSetType(KSP ksp, KSPType type)
Logically Collective on ksp

Input Parameters

ksp - the Krylov space context
type - a known method

Options Database Key

-ksp_type <method> - Sets the method; use -help for a list of available methods (for instance, cg or gmres)

Notes

See "petsc/include/petscksp.h" for available methods (for instance, KSPCG or KSPGMRES).

Normally, it is best to use the KSPSetFromOptions() command and then set the KSP type from the options database rather than by using this routine. Using the options database provides the user with maximum flexibility in evaluating the many different Krylov methods. The KSPSetType() routine is provided for those situations where it is necessary to set the iterative solver independently of the command line or options database. This might be the case, for example, when the choice of iterative solver changes during the execution of the program, and the user's application is taking responsibility for choosing the appropriate method. In other words, this routine is not for beginners.

Developer Note: KSPRegister() is used to add Krylov types to KSPList from which they are accessed by KSPSetType().

See Also

PCSetType(), KSPType, KSPRegister(), KSPCreate()

Level

intermediate

Location

src/ksp/ksp/interface/itcreate.c

Examples

src/dm/impls/stag/tutorials/ex2.c.html
src/dm/impls/stag/tutorials/ex3.c.html
src/dm/impls/stag/tutorials/ex4.c.html
src/ksp/pc/tutorials/ex1.c.html
src/ksp/pc/tutorials/ex2.c.html
src/ksp/ksp/tutorials/ex7.c.html
src/ksp/ksp/tutorials/ex8.c.html
src/ksp/ksp/tutorials/ex27.c.html
src/ksp/ksp/tutorials/ex52.c.html
src/ksp/ksp/tutorials/ex59.c.html
src/ksp/ksp/tutorials/ex62.c.html

Index of all KSP routines
Table of Contents for all manual pages
Index of all manual pages