File: PetscTrValid.html

package info (click to toggle)
petsc 2.1.3-1.woody.1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 70,272 kB
  • ctags: 310,869
  • sloc: ansic: 257,275; sh: 9,870; makefile: 7,622; fortran: 6,211; cpp: 1,026; python: 416; csh: 41; asm: 9
file content (56 lines) | stat: -rw-r--r-- 2,346 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscTrValid</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="PetscTrValid"><H1>PetscTrValid</H1></A>
Test the memory for corruption.  This can be used to check for memory overwrites. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsc.h" 
int PetscTrValid(int line,const char function[],const char file[],const char dir[])
</PRE>
<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>line </B></TD><TD>- line number where call originated.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>function </B></TD><TD>- name of function calling
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>file </B></TD><TD>- file where function is
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dir </B></TD><TD>- directory where function is
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Return value</FONT></H3>
The number of errors detected.
<P>
<H3><FONT COLOR="#CC3333">Output Effect</FONT></H3>
Error messages are written to stdout.
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
You should generally use <A HREF="../Sys/CHKMEMQ.html#CHKMEMQ">CHKMEMQ</A> or CHKMEMA as a short cut for calling this
routine.
<P>
The line, function, file and dir are given by the C preprocessor as
__LINE__, __FUNCT__, __FILE__, and __DIR__
<P>
The Fortran calling sequence is simply <A HREF="../Sys/PetscTrValid.html#PetscTrValid">PetscTrValid</A>(ierr)
<P>
No output is generated if there are no problems detected.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Sys/CHKMEMQ.html#CHKMEMQ">CHKMEMQ</A>, CHKMEMA
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/src/memory/mtr.c.html#PetscTrValid">src/sys/src/memory/mtr.c</A>
<BR><A HREF="./index.html">Index of all Sys 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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ts/examples/tutorials/ex1f.F.html">src/ts/examples/tutorials/ex1f.F.html</A><BR>
</BODY></HTML>