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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscObjectStateIncrease.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscObjectStateIncrease</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/Sys/PetscObjectStateIncrease.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscObjectStateIncrease"><H1>PetscObjectStateIncrease</H1></A>
Increases the state of any <A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsc/private/petscimpl.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscObjectStateIncrease.html#PetscObjectStateIncrease">PetscObjectStateIncrease</A>(<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A> obj)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>obj </B> -any PETSc object, for example a <A HREF="../Vec/Vec.html#Vec">Vec</A>, <A HREF="../Mat/Mat.html#Mat">Mat</A> or <A HREF="../KSP/KSP.html#KSP">KSP</A>. This must be
cast with a (<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>), for example,
<A HREF="../Sys/PetscObjectStateIncrease.html#PetscObjectStateIncrease">PetscObjectStateIncrease</A>((<A HREF="../Sys/PetscObject.html#PetscObject">PetscObject</A>)mat);
<br>
<P>
Notes: object state is an integer which gets increased every time
the object is changed internally. By saving and later querying the object state
one can determine whether information about the object is still current.
Currently, state is maintained for <A HREF="../Vec/Vec.html#Vec">Vec</A> and <A HREF="../Mat/Mat.html#Mat">Mat</A> objects.
<P>
This routine is mostly for internal use by PETSc; a developer need only
call it after explicit access to an object's internals. Routines such
as <A HREF="../Vec/VecSet.html#VecSet">VecSet</A>() or <A HREF="../Mat/MatScale.html#MatScale">MatScale</A>() already call this routine. It is also called, as a
precaution, in <A HREF="../Vec/VecRestoreArray.html#VecRestoreArray">VecRestoreArray</A>(), <A HREF="../Mat/MatRestoreRow.html#MatRestoreRow">MatRestoreRow</A>(), <A HREF="../Mat/MatDenseRestoreArray.html#MatDenseRestoreArray">MatDenseRestoreArray</A>().
<P>
This routine is logically collective because state equality comparison needs to be possible without communication.
<P>
<P>
seealso: <A HREF="../Sys/PetscObjectStateGet.html#PetscObjectStateGet">PetscObjectStateGet</A>()
<P>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../include/petsc/private/petscimpl.h.html#PetscObjectStateIncrease">include/petsc/private/petscimpl.h</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>
|
