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
|
<!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/KSPCGSetType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPCGSetType</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/KSP/KSPCGSetType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPCGSetType"><H1>KSPCGSetType</H1></A>
Sets the variant of the conjugate gradient method to use for solving a linear system with a complex coefficient matrix. This option is irrelevant when solving a real system.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../KSP/KSPCGSetType.html#KSPCGSetType">KSPCGSetType</A>(<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp,<A HREF="../KSP/KSPCGType.html#KSPCGType">KSPCGType</A> 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 iterative context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>type </B></TD><TD>- the variant of CG to use, one of
</TD></TR></TABLE>
<PRE>
<A HREF="../KSP/KSPCGType.html#KSPCGType">KSP_CG_HERMITIAN</A> - complex, Hermitian matrix (default)
<A HREF="../KSP/KSPCGType.html#KSPCGType">KSP_CG_SYMMETRIC</A> - complex, symmetric matrix
</PRE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ksp_cg_hermitian </B></TD><TD>- Indicates Hermitian matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ksp_cg_symmetric </B></TD><TD>- Indicates symmetric matrix
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
By default, the matrix is assumed to be complex, Hermitian.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
CG, conjugate gradient, Hermitian, symmetric, set, type
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../KSP/KSP.html#KSP">KSP</A>, <A HREF="../KSP/KSPCG.html#KSPCG">KSPCG</A>
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/ksp/impls/cg/cgtype.c.html#KSPCGSetType">src/ksp/ksp/impls/cg/cgtype.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/ksp/ksp/impls/cg/cg.c.html#KSPCGSetType_CG">KSPCGSetType_CG in src/ksp/ksp/impls/cg/cg.c</A><BR>
<A HREF="../../../src/ksp/ksp/impls/cg/cgne/cgne.c.html#KSPCGSetType_CGNE">KSPCGSetType_CGNE in src/ksp/ksp/impls/cg/cgne/cgne.c</A><BR>
<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>
</BODY></HTML>
|
