File: PetscConvEstGetConvRate.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,563 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/PetscConvEstGetConvRate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscConvEstGetConvRate</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/PetscConvEstGetConvRate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscConvEstGetConvRate"><H1>PetscConvEstGetConvRate</H1></A>
Returns an estimate of the convergence rate for the discretization 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscconvest.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/PetscConvEstGetConvRate.html#PetscConvEstGetConvRate">PetscConvEstGetConvRate</A>(PetscConvEst ce, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> alpha[])
</PRE>
Not collective
<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>ce   </B></TD><TD>- The PetscConvEst object
</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>alpha </B></TD><TD>- The convergence rate for each field
</TD></TR></TABLE>
<P>
Note: The convergence rate alpha is defined by
<pre>
|| u_\Delta - u_exact || &lt; C \Delta^alpha
</pre>
where u_\Delta is the discrete solution, and Delta is a measure of the discretization size. We usually use h for the
spatial resolution and \Delta t for the temporal resolution.
<P>
We solve a series of problems using increasing resolution (refined meshes or decreased timesteps), calculate an error
based upon the exact solution in the DS, and then fit the result to our model above using linear regression.
<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>-snes_convergence_estimate : Execute convergence estimation inside <A HREF="../SNES/SNESSolve.html#SNESSolve">SNESSolve</A>() and print out the rate</B></TD>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_convergence_estimate : Execute convergence estimation inside <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>() and print out the rate</B></TD></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../SNES/PetscConvEstSetSolver.html#PetscConvEstSetSolver">PetscConvEstSetSolver</A>(), <A HREF="../SNES/PetscConvEstCreate.html#PetscConvEstCreate">PetscConvEstCreate</A>(), <A HREF="../SNES/PetscConvEstGetConvRate.html#PetscConvEstGetConvRate">PetscConvEstGetConvRate</A>(), <A HREF="../SNES/SNESSolve.html#SNESSolve">SNESSolve</A>(), <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</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/snes/utils/convest.c.html#PetscConvEstGetConvRate">src/snes/utils/convest.c</A>
<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>