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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PC/PCFieldSplitGetSubKSP.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PCFieldSplitGetSubKSP</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/PC/PCFieldSplitGetSubKSP.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PCFieldSplitGetSubKSP"><H1>PCFieldSplitGetSubKSP</H1></A>
Gets the <A HREF="../KSP/KSP.html#KSP">KSP</A> contexts for all splits
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscpc.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PC/PCFieldSplitGetSubKSP.html#PCFieldSplitGetSubKSP">PCFieldSplitGetSubKSP</A>(<A HREF="../PC/PC.html#PC">PC</A> pc,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *n,<A HREF="../KSP/KSP.html#KSP">KSP</A> *subksp[])
</PRE>
Collective on <A HREF="../KSP/KSP.html#KSP">KSP</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pc </B></TD><TD>- the preconditioner context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- the number of splits
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>subksp </B></TD><TD>- the array of <A HREF="../KSP/KSP.html#KSP">KSP</A> contexts
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
After <A HREF="../PC/PCFieldSplitGetSubKSP.html#PCFieldSplitGetSubKSP">PCFieldSplitGetSubKSP</A>() the array of KSPs is to be freed by the user with <A HREF="../Sys/PetscFree.html#PetscFree">PetscFree</A>()
(not the <A HREF="../KSP/KSP.html#KSP">KSP</A> just the array that contains them).
<P>
You must call <A HREF="../PC/PCSetUp.html#PCSetUp">PCSetUp</A>() before calling <A HREF="../PC/PCFieldSplitGetSubKSP.html#PCFieldSplitGetSubKSP">PCFieldSplitGetSubKSP</A>().
<P>
If the fieldsplit is of type <A HREF="../PC/PCCompositeType.html#PCCompositeType">PC_COMPOSITE_SCHUR</A>, it returns the <A HREF="../KSP/KSP.html#KSP">KSP</A> object used inside the
Schur complement and the <A HREF="../KSP/KSP.html#KSP">KSP</A> object used to iterate over the Schur complement.
To access all the <A HREF="../KSP/KSP.html#KSP">KSP</A> objects used in <A HREF="../PC/PCCompositeType.html#PCCompositeType">PC_COMPOSITE_SCHUR</A>, use <A HREF="../PC/PCFieldSplitSchurGetSubKSP.html#PCFieldSplitSchurGetSubKSP">PCFieldSplitSchurGetSubKSP</A>().
<P>
If the fieldsplit is of type <A HREF="../PC/PCCompositeType.html#PCCompositeType">PC_COMPOSITE_GKB</A>, it returns the <A HREF="../KSP/KSP.html#KSP">KSP</A> object used to solve the
inner linear system defined by the matrix H in each loop.
<P>
Fortran Usage: You must pass in a <A HREF="../KSP/KSP.html#KSP">KSP</A> array that is large enough to contain all the local KSPs.
You can call <A HREF="../PC/PCFieldSplitGetSubKSP.html#PCFieldSplitGetSubKSP">PCFieldSplitGetSubKSP</A>(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
<A HREF="../KSP/KSP.html#KSP">KSP</A> array must be.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PC/PCFIELDSPLIT.html#PCFIELDSPLIT">PCFIELDSPLIT</A>
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/pc/impls/fieldsplit/fieldsplit.c.html#PCFieldSplitGetSubKSP">src/ksp/pc/impls/fieldsplit/fieldsplit.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/tutorials/ex43.c.html">src/ksp/ksp/tutorials/ex43.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex70.c.html">src/ksp/ksp/tutorials/ex70.c.html</A><BR>
<A HREF="../../../src/snes/tutorials/ex70.c.html">src/snes/tutorials/ex70.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/ksp/pc/impls/fieldsplit/fieldsplit.c.html#PCFieldSplitGetSubKSP_FieldSplit_Schur">PCFieldSplitGetSubKSP_FieldSplit_Schur in src/ksp/pc/impls/fieldsplit/fieldsplit.c</A><BR>
<A HREF="../../../src/ksp/pc/impls/fieldsplit/fieldsplit.c.html#PCFieldSplitGetSubKSP_FieldSplit">PCFieldSplitGetSubKSP_FieldSplit in src/ksp/pc/impls/fieldsplit/fieldsplit.c</A><BR>
<BR><A HREF="./index.html">Index of all PC 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>
|
