1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPSetType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPSetType</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.7.5 v3.7.5 docs/manualpages/KSP/KSPSetType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPSetType"><H1>KSPSetType</H1></A>
Builds <A HREF="../KSP/KSP.html#KSP">KSP</A> for a particular solver.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
PetscErrorCode KSPSetType(KSP ksp, KSPType type)
</PRE>
Logically Collective on <A HREF="../KSP/KSP.html#KSP">KSP</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ksp </B></TD><TD>- the Krylov space context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type </B></TD><TD>- a known method
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<DT><B>-ksp_type <method> </B> -Sets the method; use -help for a list
of available methods (for instance, cg or gmres)
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
See "petsc/include/petscksp.h" for available methods (for instance,
<A HREF="../KSP/KSPCG.html#KSPCG">KSPCG</A> or <A HREF="../KSP/KSPGMRES.html#KSPGMRES">KSPGMRES</A>).
<P>
Normally, it is best to use the <A HREF="../KSP/KSPSetFromOptions.html#KSPSetFromOptions">KSPSetFromOptions</A>() command and
then set the <A HREF="../KSP/KSP.html#KSP">KSP</A> 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 <A HREF="../KSP/KSPSetType.html#KSPSetType">KSPSetType</A>() 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.
<P>
<P>
Developer Note: <A HREF="../KSP/KSPRegister.html#KSPRegister">KSPRegister</A>() is used to add Krylov types to KSPList from which they
are accessed by <A HREF="../KSP/KSPSetType.html#KSPSetType">KSPSetType</A>().
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../KSP/KSP.html#KSP">KSP</A>, set, method
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PC/PCSetType.html#PCSetType">PCSetType</A>(), <A HREF="../KSP/KSPType.html#KSPType">KSPType</A>, <A HREF="../KSP/KSPRegister.html#KSPRegister">KSPRegister</A>(), <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ksp/ksp/interface/itcreate.c.html#KSPSetType">src/ksp/ksp/interface/itcreate.c</A>
<BR><A HREF="./index.html">Index of all KSP routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/pc/examples/tutorials/ex1.c.html">src/ksp/pc/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ksp/pc/examples/tutorials/ex2.c.html">src/ksp/pc/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex7.c.html">src/ksp/ksp/examples/tutorials/ex7.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex8.c.html">src/ksp/ksp/examples/tutorials/ex8.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex30.c.html">src/ksp/ksp/examples/tutorials/ex30.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex52.c.html">src/ksp/ksp/examples/tutorials/ex52.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex62.c.html">src/ksp/ksp/examples/tutorials/ex62.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex52f.F.html">src/ksp/ksp/examples/tutorials/ex52f.F.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/maros.c.html">src/tao/constrained/examples/tutorials/maros.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/toy.c.html">src/tao/constrained/examples/tutorials/toy.c.html</A><BR>
<A HREF="../../../src/tao/constrained/examples/tutorials/toyf.F.html">src/tao/constrained/examples/tutorials/toyf.F.html</A><BR>
</BODY></HTML>
|
