File: PCFieldSplitSetDetectSaddlePoint.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (51 lines) | stat: -rw-r--r-- 3,664 bytes parent folder | download
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
<!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/PCFieldSplitSetDetectSaddlePoint.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PCFieldSplitSetDetectSaddlePoint</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/PCFieldSplitSetDetectSaddlePoint.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PCFieldSplitSetDetectSaddlePoint"><H1>PCFieldSplitSetDetectSaddlePoint</H1></A>
Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscpc.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PC/PCFieldSplitSetDetectSaddlePoint.html#PCFieldSplitSetDetectSaddlePoint">PCFieldSplitSetDetectSaddlePoint</A>(<A HREF="../PC/PC.html#PC">PC</A> pc,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> flg)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Also sets the split type to <A HREF="../PC/PCCompositeType.html#PCCompositeType">PC_COMPOSITE_SCHUR</A> (see <A HREF="../PC/PCFieldSplitSetType.html#PCFieldSplitSetType">PCFieldSplitSetType</A>()) and the Schur preconditioner type to <A HREF="../PC/PCFieldSplitSchurPreType.html#PCFieldSplitSchurPreType">PC_FIELDSPLIT_SCHUR_PRE_SELF</A> (see <A HREF="../PC/PCFieldSplitSetSchurPre.html#PCFieldSplitSetSchurPre">PCFieldSplitSetSchurPre</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 Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>flg  </B></TD><TD>- boolean indicating whether to detect fields or not
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pc_fieldsplit_detect_saddle_point</B></TD></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../PC/PCFIELDSPLIT.html#PCFIELDSPLIT">PCFIELDSPLIT</A>, <A HREF="../PC/PCFieldSplitSetDetectSaddlePoint.html#PCFieldSplitSetDetectSaddlePoint">PCFieldSplitSetDetectSaddlePoint</A>(), <A HREF="../PC/PCFieldSplitSetType.html#PCFieldSplitSetType">PCFieldSplitSetType</A>(), <A HREF="../PC/PCFieldSplitSetSchurPre.html#PCFieldSplitSetSchurPre">PCFieldSplitSetSchurPre</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>Intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/pc/impls/fieldsplit/fieldsplit.c.html#PCFieldSplitSetDetectSaddlePoint">src/ksp/pc/impls/fieldsplit/fieldsplit.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/impls/stag/tutorials/ex2.c.html">src/dm/impls/stag/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex3.c.html">src/dm/impls/stag/tutorials/ex3.c.html</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>