← Back to branch summary

~ubuntu-branches/ubuntu/karmic/hypre/karmic

« back to all changes in this revision

Viewing changes to docs/bHYPRE_ref_manual/StructGrid.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam C. Powell, IV
  • Date: 2009-03-20 11:40:12 UTC
  • mfrom: (4.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20090320114012-132h6ok9w2r6o609
Tags: 2.4.0b-2
Rebuild against new openmpi.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/bHYPRE_ref_manual/StructGrid.html
 
1
<html><head><TITLE>Struct Grid</TITLE></head>
 
2
<body>
 
3
<H2><A HREF ="#DOC.DOCU" > <IMG BORDER=0 SRC=down.gif></A>  Struct Grid  </H2>
 
4
<hr>
 
5
<DL>
 
6
<DT>
 
7
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid__object.html><B>bHYPRE_StructGrid__object</B></A> 
 
8
 <DD><I>
 
9
Symbol "bHYPRE</I>
 
10
<DT>
 
11
<IMG BORDER=0 SRC=icon1.gif>extern  C  struct  <!1><A HREF="bHYPRE_StructGrid__object.html">bHYPRE_StructGrid__object</A>* bHYPRE_StructGrid__create sidl_BaseInterface* <B>_ex</B>
 
12
 <DD><I>
 
13
Constructor function for the class</I>
 
14
<DT>
 
15
<IMG BORDER=0 SRC=icon1.gif>bHYPRE_StructGrid  <B>bHYPRE_StructGrid__createRemote</B>(const char * url, sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
16
 <DD><I>
 
17
RMI constructor function for the class</I>
 
18
<DT>
 
19
<IMG BORDER=0 SRC=icon1.gif>bHYPRE_StructGrid  <B>bHYPRE_StructGrid__wrapObj</B>(void * data, sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
20
 <DD><I>
 
21
Wraps up the private data struct pointer (struct bHYPRE_StructGrid__data) passed in rather than running the constructor</I>
 
22
<DT>
 
23
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid__connect.html><B>bHYPRE_StructGrid__connect</B></A> 
 
24
 <DD><I>
 
25
RMI connector function for the class</I>
 
26
<DT>
 
27
<IMG BORDER=0 SRC=icon1.gif>bHYPRE_StructGrid  <B>bHYPRE_StructGrid_Create</B>(  bHYPRE_MPICommunicator mpi_comm,  int32_t dim,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
28
 <DD><I>
 
29
This function is the preferred way to create a Struct Grid</I>
 
30
<DT>
 
31
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid_SetCommunicator.html><B>bHYPRE_StructGrid_SetCommunicator</B></A> 
 
32
 <DD><I>
 
33
Set the MPI Communicator</I>
 
34
<DT>
 
35
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid_Destroy.html><B>bHYPRE_StructGrid_Destroy</B></A> 
 
36
 <DD><I>
 
37
The Destroy function doesn't necessarily destroy anything</I>
 
38
<DT>
 
39
<IMG BORDER=0 SRC=icon1.gif>SIDL_C_INLINE_DECL  int32_t  <B>bHYPRE_StructGrid_SetDimension</B>(  bHYPRE_StructGrid self,  int32_t dim,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
40
 <DD><I>
 
41
Method:  SetDimension[]</I>
 
42
<DT>
 
43
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid_SetExtents.html><B>bHYPRE_StructGrid_SetExtents</B></A> 
 
44
 <DD><I>
 
45
Define the lower and upper corners of a box of the grid</I>
 
46
<DT>
 
47
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid_SetPeriodic.html><B>bHYPRE_StructGrid_SetPeriodic</B></A> 
 
48
 <DD><I>
 
49
Set the periodicity for the grid</I>
 
50
<DT>
 
51
<IMG BORDER=0 SRC=icon1.gif> <A HREF=bHYPRE_StructGrid_SetNumGhost.html><B>bHYPRE_StructGrid_SetNumGhost</B></A> 
 
52
 <DD><I>
 
53
Set the number of ghost zones, separately on the lower and upper sides
 
54
for each dimension</I>
 
55
<DT>
 
56
<IMG BORDER=0 SRC=icon1.gif>SIDL_C_INLINE_DECL  int32_t  <B>bHYPRE_StructGrid_Assemble</B>(  bHYPRE_StructGrid self,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
57
 <DD><I>
 
58
final construction of the object before its use </I>
 
59
<DT>
 
60
<IMG BORDER=0 SRC=icon1.gif> struct  <!1><A HREF="bHYPRE_StructGrid__object.html">bHYPRE_StructGrid__object</A>* bHYPRE_StructGrid__cast void* obj sidl_BaseInterface* <B>_ex</B>
 
61
 <DD><I>
 
62
Cast method for interface and class type conversions</I>
 
63
<DT>
 
64
<IMG BORDER=0 SRC=icon1.gif>void*  <B>bHYPRE_StructGrid__cast2</B>( void* obj, const char* type, sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
65
 <DD><I>
 
66
String cast method for interface and class type conversions</I>
 
67
<DT>
 
68
<IMG BORDER=0 SRC=icon1.gif>SIDL_C_INLINE_DECL  void  <B>bHYPRE_StructGrid__exec</B>(  bHYPRE_StructGrid self,  const char* methodName,  sidl_rmi_Call inArgs,  sidl_rmi_Return outArgs,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
69
 <DD><I>
 
70
Select and execute a method by name</I>
 
71
<DT>
 
72
<IMG BORDER=0 SRC=icon1.gif>SIDL_C_INLINE_DECL  char*  <B>bHYPRE_StructGrid__getURL</B>(  bHYPRE_StructGrid self,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
73
 <DD><I>
 
74
Get the URL of the Implementation of this object (for RMI)</I>
 
75
<DT>
 
76
<IMG BORDER=0 SRC=icon1.gif>SIDL_C_INLINE_DECL  void  <B>bHYPRE_StructGrid__raddRef</B>(  bHYPRE_StructGrid self,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
77
 <DD><I>
 
78
On a remote object, addrefs the remote instance</I>
 
79
<DT>
 
80
<IMG BORDER=0 SRC=icon1.gif>SIDL_C_INLINE_DECL  sidl_bool  <B>bHYPRE_StructGrid__isRemote</B>(  bHYPRE_StructGrid self,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
81
 <DD><I>
 
82
TRUE if this object is remote, false if local</I>
 
83
<DT>
 
84
<IMG BORDER=0 SRC=icon1.gif>sidl_bool  <B>bHYPRE_StructGrid__isLocal</B>(  bHYPRE_StructGrid self,  sidl_BaseInterface *<!2><A HREF="VectorInterface.html#DOC.3.10">_ex</A>)
 
85
 <DD><I>
 
86
TRUE if this object is remote, false if local</I>
 
87
<DT>
 
88
<IMG BORDER=0 SRC=icon1.gif> struct  <!1><A HREF="bHYPRE_StructGrid__object.html">bHYPRE_StructGrid__object</A>* bHYPRE_StructGrid__rmicast void* obj struct sidl_BaseInterface__object <B>**_ex</B>
 
89
 <DD><I>
 
90
Cast method for interface and class type conversions</I>
 
91
<DT>
 
92
<IMG BORDER=0 SRC=icon1.gif> <A HREF=_ex.38.html><B>**_ex</B></A> 
 
93
 <DD><I>
 
94
RMI connector function for the class</I>
 
95
</DL>
 
96
<A NAME="DOC.DOCU">
 
97
<DL></DL><P><I><A HREF="aindex.html"> alphabetic index</A></I>  <I><A HREF="HIER.html"> hierarchy of classes</A></I><P><hr>
 
98
<center>
 
99
<img src="hypre_wiw.gif">
 
100
</center>
 
101
 
 
102
<P Align=right><I>generated by <A HREF="http://www.zib.de/Visual/software/doc++/index.html">doc++</A></I>
 
103
</BODY>