1
<html><head><TITLE>bHYPRE_SStructVariable__enum</TITLE></head>
3
<H2><A HREF ="#DOC.DOCU" > <IMG BORDER=0 SRC=down.gif></A> enum bHYPRE_SStructVariable__enum </H2><BLOCKQUOTE>
9
<h2> Documentation </h2>
12
Symbol "bHYPRE.SStructVariable" (version 1.0.0)<P>The SStructVariable enumerated type.<P>An enumerated type that supports cell centered, node
13
centered, face centered, and edge centered variables. Face
14
centered variables are split into x-face, y-face, and z-face
15
variables, and edge centered variables are split into x-edge,
16
y-edge, and z-edge variables. The edge centered variable
17
types are only used in 3D. In 2D, edge centered variables
18
are handled by the face centered types.<P>Variables are referenced relative to an abstract (cell centered)
19
index in the following way:
21
<LI> cell centered variables are aligned with the index;
22
<LI> node centered variables are aligned with the cell corner
23
at relative index (1/2, 1/2, 1/2);
24
<LI> x-face, y-face, and z-face centered variables are aligned
25
with the faces at relative indexes (1/2, 0, 0), (0, 1/2, 0),
26
and (0, 0, 1/2), respectively;
27
<LI> x-edge, y-edge, and z-edge centered variables are aligned
28
with the edges at relative indexes (0, 1/2, 1/2), (1/2, 0, 1/2),
29
and (1/2, 1/2, 0), respectively.
30
</UL><P>The supported identifiers are:
32
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_CELL</tt>
33
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_NODE</tt>
34
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_XFACE</tt>
35
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_YFACE</tt>
36
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_ZFACE</tt>
37
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_XEDGE</tt>
38
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_YEDGE</tt>
39
<LI> <TT>HYPRE_SSTRUCT_VARIABLE_ZEDGE</tt>
40
</UL><P>NOTE: Although variables are referenced relative to a unique
41
abstract cell-centered index, some variables are associated
42
with multiple grid cells. For example, node centered
43
variables in 3D are associated with 8 cells (away from
44
boundaries). Although grid cells are distributed uniquely to
45
different processes, variables may be owned by multiple
46
processes because they may be associated with multiple cells.
51
<DL></DL><P><I><A HREF="aindex.html"> alphabetic index</A></I> <I><A HREF="HIER.html"> hierarchy of classes</A></I><P><hr>
53
<img src="hypre_wiw.gif">
56
<P Align=right><I>generated by <A HREF="http://www.zib.de/Visual/software/doc++/index.html">doc++</A></I>
added
removed
src/docs/bHYPRE_ref_manual/bHYPRE_SStructVariable__enum.html
