File: SNESNGMRESSetRestartType.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 (54 lines) | stat: -rw-r--r-- 3,360 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
52
53
54
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESNGMRESSetRestartType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESNGMRESSetRestartType</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/SNES/SNESNGMRESSetRestartType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESNGMRESSetRestartType"><H1>SNESNGMRESSetRestartType</H1></A>
Sets the restart type for <A HREF="../SNES/SNESNGMRES.html#SNESNGMRES">SNESNGMRES</A>. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESNGMRESSetRestartType.html#SNESNGMRESSetRestartType">SNESNGMRESSetRestartType</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes,SNESNGMRESRestartType rtype)
</PRE>
Logically Collective on <A HREF="../SNES/SNES.html#SNES">SNES</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>snes </B></TD><TD>- the iterative context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rtype </B></TD><TD>- restart type
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_ngmres_restart_type&lt;difference,periodic,none&gt; </B></TD><TD>- set the restart type
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_ngmres_restart[30] </B></TD><TD>- sets the number of iterations before restart for periodic
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">SNESNGMRESRestartTypes</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NGMRES_RESTART_NONE </B></TD><TD>- never restart
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NGMRES_RESTART_DIFFERENCE </B></TD><TD>- restart based upon difference criteria
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SNES_NGMRES_RESTART_PERIODIC </B></TD><TD>- restart after a fixed number of iterations
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The default line search used is the L2 line search and it requires two additional function evaluations.
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/impls/ngmres/snesngmres.c.html#SNESNGMRESSetRestartType">src/snes/impls/ngmres/snesngmres.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/snes/impls/ngmres/snesngmres.c.html#SNESNGMRESSetRestartType_NGMRES">SNESNGMRESSetRestartType_NGMRES in src/snes/impls/ngmres/snesngmres.c</A><BR>
<BR><A HREF="./index.html">Index of all SNES 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>