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
|
<!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/PetscInfoEnabled.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscInfoEnabled</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/Profiling/PetscInfoEnabled.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscInfoEnabled"><H1>PetscInfoEnabled</H1></A>
Checks whether a given OBJECT_CLASSID is allowed to print using <A HREF="../Profiling/PetscInfo.html#PetscInfo">PetscInfo</A>()
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Profiling/PetscInfoEnabled.html#PetscInfoEnabled">PetscInfoEnabled</A>(<A HREF="../Sys/PetscClassId.html#PetscClassId">PetscClassId</A> classid, <A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> *enabled)
</PRE>
Not Collective
<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>classid </B></TD><TD>- PetscClassid retrieved from a <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> e.g. VEC_CLASSID
</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>enabled </B></TD><TD>- <A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> indicating whether this classid is allowed to print
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Use PETSC_SMALLEST_CLASSID to check if "sys" <A HREF="../Profiling/PetscInfo.html#PetscInfo">PetscInfo</A>() calls are enabled. When PETSc is configured with debugging
support this function checks if classid >= PETSC_SMALLEST_CLASSID, otherwise it assumes valid classid.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Profiling/PetscInfo.html#PetscInfo">PetscInfo</A>(), <A HREF="../Profiling/PetscInfoAllow.html#PetscInfoAllow">PetscInfoAllow</A>(), <A HREF="../Profiling/PetscInfoGetInfo.html#PetscInfoGetInfo">PetscInfoGetInfo</A>(), PetscObjectGetClassid()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/info/verboseinfo.c.html#PetscInfoEnabled">src/sys/info/verboseinfo.c</A>
<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>
|
