[MOAB-dev] r2914 - MOAB/trunk/tools/iMesh/python/doc

[jvporter at wisc.edu]

Author: jvporter
Date: 2009-05-27 14:50:01 -0500 (Wed, 27 May 2009)
New Revision: 2914

Modified:
   MOAB/trunk/tools/iMesh/python/doc/ibase.rst
   MOAB/trunk/tools/iMesh/python/doc/imesh.rst
Log:
Add documentation for enumeration types


Modified: MOAB/trunk/tools/iMesh/python/doc/ibase.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/ibase.rst	2009-05-27 18:53:22 UTC (rev 2913)
+++ MOAB/trunk/tools/iMesh/python/doc/ibase.rst	2009-05-27 19:50:01 UTC (rev 2914)
@@ -2,4 +2,40 @@
  iBase Interface
 =================
 
-Nothing here yet...
\ No newline at end of file
+.. module:: itaps.iBase
+
+.. class:: itaps.iBase.type
+
+   .. data:: vertex
+
+   .. data:: edge
+
+   .. data:: face
+
+   .. data:: region
+
+   .. data:: all
+
+
+.. class:: itaps.iBase.adjCost
+
+   .. data:: unavailable
+
+   .. data:: all_order_1
+
+   .. data:: all_order_logn
+
+   .. data:: all_order_n
+
+   .. data:: some_order_1
+
+   .. data:: some_order_logn
+
+   .. data:: some_order_n
+
+
+.. class:: itaps.iBase.storageOrder
+
+   .. data:: interleaved
+
+   .. data:: blocked
\ No newline at end of file

Modified: MOAB/trunk/tools/iMesh/python/doc/imesh.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/imesh.rst	2009-05-27 18:53:22 UTC (rev 2913)
+++ MOAB/trunk/tools/iMesh/python/doc/imesh.rst	2009-05-27 19:50:01 UTC (rev 2914)
@@ -71,6 +71,62 @@
    .. method:: rmvTag(entities, tag)
 
 
+.. class:: itaps.iMesh.topology
+
+   An enumeration of mesh element topologies corresponding to
+   ``iMesh_EntityTopology``.
+
+   .. data:: point
+
+      A general zero-dimensional entity
+
+   .. data:: line_segment
+
+      A general one-dimensional entity
+
+   .. data:: polygon
+
+      A general two-dimensional element
+
+   .. data:: triangle
+
+      A three-sided, two-dimensional element
+
+   .. data:: quadrilateral
+
+      A four-sided, two-dimensional element
+
+   .. data:: polyhedron
+
+      A general three-dimensional element
+
+   .. data:: tetrahedron
+
+      A four-sided, three-dimensional element whose faces are triangles
+
+   .. data:: hexahedron
+
+      A six-sided, three-dimensional element whose faces are quadrilaterals
+
+   .. data:: prism
+
+      A five-sided, three-dimensional element which has three quadrilateral
+      faces and two triangular faces
+
+   .. data:: pyramid
+
+      A five-sided, three-dimensional element which has one quadrilateral face
+      and four triangular faces
+
+   .. data:: septahedron
+
+      A hexahedral entity with one collapsed edge
+
+   .. data:: all
+
+      Allows the user to request information about all the topology types
+
+
 .. class:: itaps.iMesh.iterator
 
    .. method:: reset()
@@ -104,7 +160,7 @@
 
    .. method:: getParents(numHops)
 
-   .. method:: iterate(type, topo[, count])
+   .. method:: iterate(type, topo[, count=1])
 
    .. method:: difference(entSet)