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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Viewer/PetscViewerAMSOpen.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscViewerAMSOpen</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="PetscViewerAMSOpen"><H1>PetscViewerAMSOpen</H1></A>
Opens an AMS memory snooper <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A>.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h" */
PetscErrorCode PetscViewerAMSOpen(MPI_Comm comm,const char name[],PetscViewer *lab)
</PRE>
Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</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>comm </B></TD><TD>- the MPI communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- name of AMS communicator being created if NULL is passed defaults to PETSc
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>lab </B> -the <A HREF="../Viewer/PetscViewer.html#PetscViewer">PetscViewer</A>
<br>
<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>-ams_port <port number> </B></TD><TD>- port number where you are running AMS client
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-xxx_view ams </B></TD><TD>- publish the object xxx
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-xxx_ams_block </B></TD><TD>- blocks the program at the end of a critical point (for <A HREF="../KSP/KSP.html#KSP">KSP</A> and <A HREF="../SNES/SNES.html#SNES">SNES</A> it is the end of a solve) until
the user unblocks the the problem with an external tool that access the object with the AMS
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ams_java </B></TD><TD>- open JAVA AMS client
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Fortran Note</FONT></H3>
This routine is not supported in Fortran.
<P>
See the matlab/petsc directory in the AMS installation for one example of external
tools that can monitor PETSc objects that have been published.
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Unlike other viewers that only access the object being viewed on the call to XXXView(object,viewer) the AMS viewer allows
one to view the object asynchronously as the program continues to run. One can remove AMS access to the object with a call to
PetscObjectAMSViewOff().
<P>
Information about the AMS is available via http://www.mcs.anl.gov/ams.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Viewer/PetscViewerDestroy.html#PetscViewerDestroy">PetscViewerDestroy</A>(), <A HREF="../Viewer/PetscViewerStringSPrintf.html#PetscViewerStringSPrintf">PetscViewerStringSPrintf</A>(), <A HREF="../Viewer/PETSC_VIEWER_AMS_.html#PETSC_VIEWER_AMS_">PETSC_VIEWER_AMS_</A>(), <A HREF="../Sys/PetscObjectAMSBlock.html#PetscObjectAMSBlock">PetscObjectAMSBlock</A>(),
<BR>PetscObjectAMSViewOff(), <A HREF="../Sys/PetscObjectAMSTakeAccess.html#PetscObjectAMSTakeAccess">PetscObjectAMSTakeAccess</A>(), <A HREF="../Sys/PetscObjectAMSGrantAccess.html#PetscObjectAMSGrantAccess">PetscObjectAMSGrantAccess</A>()
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/classes/viewer/impls/ams/amsopen.c.html#PetscViewerAMSOpen">src/sys/classes/viewer/impls/ams/amsopen.c</A>
<BR><A HREF="./index.html">Index of all Viewer 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>
|
