File: PetscOListRemoveReference.html

package info (click to toggle)
petsc 3.2.dfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 124,660 kB
  • sloc: ansic: 342,250; cpp: 62,975; python: 32,761; fortran: 17,337; makefile: 15,867; xml: 621; objc: 594; sh: 492; java: 381; f90: 347; csh: 245
file content (38 lines) | stat: -rw-r--r-- 2,419 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscOListRemoveReference</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="PetscOListRemoveReference"><H1>PetscOListRemoveReference</H1></A>
Calls <A HREF="../Sys/PetscObjectDereference.html#PetscObjectDereference">PetscObjectDereference</A>() on an object in the list immediately but keeps a pointer to the object in the list. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PetscErrorCode  PetscOListRemoveReference(PetscOList *fl,const char name[])
</PRE>
<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>fl </B></TD><TD>- the object list
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- the name to use for the object
</TD></TR></TABLE>
<P>

<P>
Notes: Use <A HREF="../Sys/PetscOListAdd.html#PetscOListAdd">PetscOListAdd</A>(<A HREF="../Sys/PetscOList.html#PetscOList">PetscOList</A>,const char name[],<A HREF="../Sys/PETSC_NULL.html#PETSC_NULL">PETSC_NULL</A>) to truly remove the object from the list
<P>
Use this routine ONLY if you know that the object referenced will remain in existence until the pointing object is destroyed
<P>
Developer Note: this is to handle some cases that otherwise would result in having circular references so reference counts never got to zero
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Sys/PetscOListDestroy.html#PetscOListDestroy">PetscOListDestroy</A>(), <A HREF="../Sys/PetscOListFind.html#PetscOListFind">PetscOListFind</A>(), <A HREF="../Sys/PetscOListDuplicate.html#PetscOListDuplicate">PetscOListDuplicate</A>(), <A HREF="../Sys/PetscOListReverseFind.html#PetscOListReverseFind">PetscOListReverseFind</A>(), <A HREF="../Sys/PetscOListDuplicate.html#PetscOListDuplicate">PetscOListDuplicate</A>(), <A HREF="../Sys/PetscOListAdd.html#PetscOListAdd">PetscOListAdd</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/objects/olist.c.html#PetscOListRemoveReference">src/sys/objects/olist.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>
</BODY></HTML>