File: PetscConvEstGetConvRate.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (52 lines) | stat: -rw-r--r-- 2,769 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
<!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.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/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>
<DT><B>ce   </B> -The PetscConvEst object
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>alpha </B> -The convergence rate for each field
<br>
<P>
Note: The convergence rate alpha is defined by
<pre>
|| u_h - u_exact || &lt; C h^alpha
</pre>
where u_h is the discrete solution, and h is a measure of the discretization size.
<P>
We solve a series of problems on refined meshes, 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>
<DT><B>-snes_convergence_estimate : Execute convergence estimation and print out the rate</B> -

<br>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 PetscConvEst, convergence
<BR>
<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>()
<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>