File: TSMonitorLGCtxCreate.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (81 lines) | stat: -rw-r--r-- 7,022 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TS/TSMonitorLGCtxCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSMonitorLGCtxCreate</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/TS/TSMonitorLGCtxCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSMonitorLGCtxCreate"><H1>TSMonitorLGCtxCreate</H1></A>
Creates a TSMonitorLGCtx context for use with <A HREF="../TS/TS.html#TS">TS</A> to monitor the solution process graphically in various ways 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"  
PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
</PRE>
Collective on <A HREF="../TS/TS.html#TS">TS</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>host </B></TD><TD>- the X display to open, or null for the local machine
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>label </B></TD><TD>- the title to put in the title bar
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x, y </B></TD><TD>- the screen coordinates of the upper left coordinate of the window
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>m, n </B></TD><TD>- the screen width and height in pixels
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>howoften </B></TD><TD>- if positive then determines the frequency of the plotting, if -1 then only at the final time
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>ctx </B> -the context
<br>
<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>-ts_monitor_lg_timestep </B></TD><TD>- automatically sets line graph monitor
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_solution </B></TD><TD>- monitor the solution (or certain values of the solution by calling <A HREF="../TS/TSMonitorLGSetDisplayVariables.html#TSMonitorLGSetDisplayVariables">TSMonitorLGSetDisplayVariables</A>() or <A HREF="../TS/TSMonitorLGCtxSetDisplayVariables.html#TSMonitorLGCtxSetDisplayVariables">TSMonitorLGCtxSetDisplayVariables</A>())
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_error </B></TD><TD>- monitor the error
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_ksp_iterations </B></TD><TD>- monitor the number of <A HREF="../KSP/KSP.html#KSP">KSP</A> iterations needed for each timestep
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_snes_iterations </B></TD><TD>- monitor the number of <A HREF="../SNES/SNES.html#SNES">SNES</A> iterations needed for each timestep
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-lg_use_markers &lt;true,false&gt; </B></TD><TD>- mark the data points (at each time step) on the plot; default is true
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Use <A HREF="../TS/TSMonitorLGCtxDestroy.html#TSMonitorLGCtxDestroy">TSMonitorLGCtxDestroy</A>() to destroy.
<P>
One can provide a function that transforms the solution before plotting it with <A HREF="../TS/TSMonitorLGCtxSetTransform.html#TSMonitorLGCtxSetTransform">TSMonitorLGCtxSetTransform</A>() or <A HREF="../TS/TSMonitorLGSetTransform.html#TSMonitorLGSetTransform">TSMonitorLGSetTransform</A>()
<P>
Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a <A HREF="../TS/TS.html#TS">TS</A> object as the
first argument (if that <A HREF="../TS/TS.html#TS">TS</A> object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object
as the first argument.
<P>
One can control the names displayed for each solution or error variable with <A HREF="../TS/TSMonitorLGCtxSetVariableNames.html#TSMonitorLGCtxSetVariableNames">TSMonitorLGCtxSetVariableNames</A>() or <A HREF="../TS/TSMonitorLGSetVariableNames.html#TSMonitorLGSetVariableNames">TSMonitorLGSetVariableNames</A>()
<P>
<P>

<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 <A HREF="../TS/TS.html#TS">TS</A>, monitor, line graph, residual
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 TSMonitorLGTimeStep(), <A HREF="../TS/TSMonitorSet.html#TSMonitorSet">TSMonitorSet</A>(), <A HREF="../TS/TSMonitorLGSolution.html#TSMonitorLGSolution">TSMonitorLGSolution</A>(), <A HREF="../TS/TSMonitorLGError.html#TSMonitorLGError">TSMonitorLGError</A>(), <A HREF="../TS/TSMonitorDefault.html#TSMonitorDefault">TSMonitorDefault</A>(), <A HREF="../Vec/VecView.html#VecView">VecView</A>(), 
<BR><A HREF="../TS/TSMonitorLGCtxCreate.html#TSMonitorLGCtxCreate">TSMonitorLGCtxCreate</A>(), <A HREF="../TS/TSMonitorLGCtxSetVariableNames.html#TSMonitorLGCtxSetVariableNames">TSMonitorLGCtxSetVariableNames</A>(), TSMonitorLGCtxGetVariableNames(),
<A HREF="../TS/TSMonitorLGSetVariableNames.html#TSMonitorLGSetVariableNames">TSMonitorLGSetVariableNames</A>(), <A HREF="../TS/TSMonitorLGGetVariableNames.html#TSMonitorLGGetVariableNames">TSMonitorLGGetVariableNames</A>(), <A HREF="../TS/TSMonitorLGSetDisplayVariables.html#TSMonitorLGSetDisplayVariables">TSMonitorLGSetDisplayVariables</A>(), <A HREF="../TS/TSMonitorLGCtxSetDisplayVariables.html#TSMonitorLGCtxSetDisplayVariables">TSMonitorLGCtxSetDisplayVariables</A>(),
<A HREF="../TS/TSMonitorLGCtxSetTransform.html#TSMonitorLGCtxSetTransform">TSMonitorLGCtxSetTransform</A>(), <A HREF="../TS/TSMonitorLGSetTransform.html#TSMonitorLGSetTransform">TSMonitorLGSetTransform</A>(), <A HREF="../TS/TSMonitorLGError.html#TSMonitorLGError">TSMonitorLGError</A>(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
<A HREF="../TS/TSMonitorEnvelopeCtxCreate.html#TSMonitorEnvelopeCtxCreate">TSMonitorEnvelopeCtxCreate</A>(), <A HREF="../TS/TSMonitorEnvelopeGetBounds.html#TSMonitorEnvelopeGetBounds">TSMonitorEnvelopeGetBounds</A>(), <A HREF="../TS/TSMonitorEnvelopeCtxDestroy.html#TSMonitorEnvelopeCtxDestroy">TSMonitorEnvelopeCtxDestroy</A>(), TSMonitorEnvelop()
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/interface/ts.c.html#TSMonitorLGCtxCreate">src/ts/interface/ts.c</A>
<BR><A HREF="./index.html">Index of all TS 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>