[MOAB-dev] r5035 - MOAB/trunk/itaps/imesh

[jvporter at wisc.edu]

Author: jvporter
Date: 2011-06-24 14:11:03 -0500 (Fri, 24 Jun 2011)
New Revision: 5035

Modified:
   MOAB/trunk/itaps/imesh/iMesh.h
   MOAB/trunk/itaps/imesh/iMesh_MOAB.cpp
Log:
Update to use latest revision of iMesh.h and make a stub for iMesh_optimize


Modified: MOAB/trunk/itaps/imesh/iMesh.h
===================================================================
--- MOAB/trunk/itaps/imesh/iMesh.h	2011-06-23 15:59:08 UTC (rev 5034)
+++ MOAB/trunk/itaps/imesh/iMesh.h	2011-06-24 19:11:03 UTC (rev 5035)
@@ -263,10 +263,9 @@
  * \brief  Set geometric dimension of vertex coordinates
  *
  * Set the geometric dimension of the mesh.  Note:  An application
- * should not expect this function to succeed unless the mesh database
- * is empty (no vertices created, no files read, etc.)
- *
- * \pre iMesh instance must be <em>empty</em>; no vertex entities
+ * should not expect this function to succeed unless the mesh instance
+ * is empty. An empty mesh instance is any mesh instance in which there are 
+ * no vertex entities.
  ******************************************************************************/
 
 void iMesh_setGeometricDimension(
@@ -416,24 +415,36 @@
 
 /***************************************************************************//**
  * \ingroup  MeshModification
- * \brief  Check if entity handles have changed since last reset or instance
- * construction
+ * \brief Permit implementation to 'optimize' the mesh instance 
  *
- * Return whether entity handles have changed since last reset or since
- * instance construction.  If non-zero value is returned, it is not
- * guaranteed that a handle from before the last call to this function
- * represents the same entity as the same handle value does now.  If
- * doReset is non-zero, resets the starting point for this function.
+ * Its concievable that after a series of operations modifying the mesh
+ * instance, the implementation's internal representation of the mesh may
+ * include data and tie up memory resources that could be 'optimized' away.
+ * For example, if the implementation only marks removed entities for deletion
+ * but does not actually free up memory resources associated those entities,
+ * a call to this function gives the implementation the 'ok' to go ahead and
+ * free up such memory.
+ *
+ * Depending on the implementation as well as the amount and kind of changes
+ * to the mesh that have been made prior to calling it, this call may be
+ * very expensive in time complexity. On the other hand, it is also perfectly
+ * acceptable that an implementation basically treat this operation as a no-op.
+ *
+ * In any event, any entity, entity set, iterator or tag handle obtained prior 
+ * to calling this method will may be invalidated as a result of this call. In
+ * that case, the caller must re-acquire handles after making this call. A
+ * return argument indicates if handles have been invalidated.
  ******************************************************************************/
 
-void iMesh_areEHValid(