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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>ADDAHCiter</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="ADDAHCiter"><H1>ADDAHCiter</H1></A>
iterates through a hypercube lc, uc, idx all have to be valid arrays of size dim This function return <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>, if idx exceeds uc, <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> otherwise. There are no guarantees on what happens if idx is not in the hypercube spanned by lc, uc, this should be checked with <A HREF="../DM/ADDAHCiterStartup.html#ADDAHCiterStartup">ADDAHCiterStartup</A>.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmadda.h"
PetscBool ADDAHCiter(const PetscInt dim, const PetscInt *const lc, const PetscInt *const uc, PetscInt *const idx)</PRE>
<H3><FONT COLOR="#CC3333">Use this code as follows</FONT></H3>
if( <A HREF="../DM/ADDAHCiterStartup.html#ADDAHCiterStartup">ADDAHCiterStartup</A>(dim, lc, uc, idx) ) {
do {
...
} while( <A HREF="../DM/ADDAHCiter.html#ADDAHCiter">ADDAHCiter</A>(dim, lc, uc, idx) );
}
<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>dim </B></TD><TD>- the number of dimension
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lc </B></TD><TD>- the "lower" corner
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>uc </B></TD><TD>- the "upper" corner
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<DT><B>idx </B> -the index that this function increases
<br>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/dm/adda/adda.c.html#ADDAHCiter">src/dm/adda/adda.c</A>
<BR><A HREF="./index.html">Index of all DM 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>
|
