File: PetscInfo.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 (69 lines) | stat: -rw-r--r-- 3,458 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Profiling/PetscInfo.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscInfo</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/Profiling/PetscInfo.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscInfo"><H1>PetscInfo</H1></A>
Logs informative data, which is printed to standard output or a file when the option -info &lt;file&gt; is specified. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include &lt;petscsys.h&gt;
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Profiling/PetscInfo.html#PetscInfo">PetscInfo</A>(void *vobj, const char message[])
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscInfo1(void *vobj, const char formatmessage[],arg1)
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> PetscInfo2(void *vobj, const char formatmessage[],arg1,arg2)
etc
</PRE>
Collective over <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> argument
<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>vobj </B></TD><TD>- object most closely associated with the logging statement or NULL
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>message </B></TD><TD>- logging message
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>formatmessage </B></TD><TD>- logging message using standard "printf" format
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Key</FONT></H3>
<pre>
   -info : activates printing of <A HREF="../Profiling/PetscInfo.html#PetscInfo">PetscInfo</A>() messages
</pre>
<P>

<P>
Fortran Note: This function does not take the vobj argument, there is only the <A HREF="../Profiling/PetscInfo.html#PetscInfo">PetscInfo</A>()
version, not PetscInfo1() etc.
<P>
<H3><FONT COLOR="#CC3333">Example of Usage</FONT></H3>
<pre>
</pre>
<pre>
    <A HREF="../Mat/Mat.html#Mat">Mat</A> A
</pre>
<pre>
    double alpha
</pre>
<pre>
    PetscInfo1(A,"Matrix uses parameter alpha=%g\n",alpha);
</pre>
<pre>
</pre>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Profiling/PetscInfoAllow.html#PetscInfoAllow">PetscInfoAllow</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/sys/info/verboseinfo.c.html#PetscInfo">src/sys/info/verboseinfo.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/sys/examples/tutorials/ex3f.F.html">src/sys/examples/tutorials/ex3f.F.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex72.c.html">src/ksp/ksp/examples/tutorials/ex72.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
<BR><A HREF="./index.html">Index of all Profiling 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>