[cgma-dev] r3115 - cgm/trunk/geom/parallel

[hongjun at mcs.anl.gov]

Author: hongjun
Date: 2009-08-21 11:06:01 -0500 (Fri, 21 Aug 2009)
New Revision: 3115

Added:
   cgm/trunk/geom/parallel/CGMParallelConventions.h
Log:
o Tag conventions for naming parallel CGM things
o It was omitted for parallel iGeom


Added: cgm/trunk/geom/parallel/CGMParallelConventions.h
===================================================================
--- cgm/trunk/geom/parallel/CGMParallelConventions.h	                        (rev 0)
+++ cgm/trunk/geom/parallel/CGMParallelConventions.h	2009-08-21 16:06:01 UTC (rev 3115)
@@ -0,0 +1,83 @@
+#ifndef CGM_PARALLEL_CONVENTIONS_H
+#define CGM_PARALLEL_CONVENTIONS_H
+
+/** Tag conventions for naming parallel things.
+ */
+
+/** \brief Global identifier for interface geom
+ *
+ * An integer identifier common to the corresponding geom entity
+ * instances on each processor for a geom entity on the interface.
+ */
+#define PARALLEL_GID_TAG_NAME "GLOBAL_ID"
+
+/** \brief Tag on a geomset representing a parallel partition.
+ *
+ * When the geometry is partitioned for use in a parallel environment,
+ * the each CPUs partiiton of the geom is stored in a geomset with
+ * this tag.  The value of the tag is an integer "part identifier".
+ */
+#define PARALLEL_PARTITION_TAG_NAME "PARALLEL_PARTITION"
+#define PARALLEL_PART_TAG_NAME PARALLEL_PARTITION_TAG_NAME
+
+/** \brief Tag that groups the set of parts/partitions that are
+ *         a covering of the geom.
+ *
+ * This tag labels an entity set for which the child sets are part(ition)s
+ * that together are a single partitioning of the geom.  I.e. There should
+ * be no geom entity that is contained in more than one child part(ition)
+ * set, and typically every geom entity of the dimenion used to partition
+ * the geom is contained in exactly one of the child sets.
+ *
+ * The data for this tag is a single integer value.  The value of
+ * the tag is undefined.
+ */
+#define PARALLEL_PARITIONING_TAG_NAME "PARALLEL_GEOM_PARITIONING"
+
+/** \brief Tag storing which other processor a given entity is shared with
+ *
+ * This single-valued tag implies an entity is shared with one other proc
+ */
+#define PARALLEL_SHARED_PROC_TAG_NAME "__PARALLEL_SHARED_PROC"
+ 
+/** \brief Tag storing which other processorS a given entity is shared with
+ *
+ * This multiple-valued tag implies an entity is shared with multiple
+ * other processors.  Length of tag is application-dependent, and depends on
+ * what the maximum number of processors is which share an entity
+ */
+#define PARALLEL_SHARED_PROCS_TAG_NAME "__PARALLEL_SHARED_PROCS"
+ 
+/** \brief Tag storing the handle of a shared entity on the other proc
+ *
+ * This single-valued tag implies an entity is shared with one other proc
+ */
+#define PARALLEL_SHARED_HANDLE_TAG_NAME "__PARALLEL_SHARED_HANDLE"
+ 
+/** \brief Tag storing handles of a shared entity on other processors
+ *
+ * This multiple-valued tag implies an entity is shared with multiple
+ * other processors.  Length of tag is application-dependent, and depends on
+ * what the maximum number of processors is which share an entity
+ */
+#define PARALLEL_SHARED_HANDLES_TAG_NAME "__PARALLEL_SHARED_HANDLES"
+ 
+/** \brief Tag storing parallel status (as bits in this tag)
+ *
+ * This tag stores various aspects of parallel status in bits; see also 
+ * #define's following, to be used in bit mask operations.  If an entity is
+ * not shared with any other processors, the pstatus is 0, otherwise it's > 0
+ *
+ * bit 0: !owned (0=owned, 1=not owned)
+ * bit 1: shared (0=not shared, 1=shared)
+ * bit 2: interface (0=not interface, 1=interface)
+ * bit 3: ghost (0=not ghost, 1=ghost)
+ */
+#define PARALLEL_STATUS_TAG_NAME "__PARALLEL_STATUS"
+
+#define PSTATUS_NOT_OWNED 0x1
+#define PSTATUS_SHARED 0x2
+#define PSTATUS_INTERFACE 0x4
+#define PSTATUS_GHOST 0x8
+
+#endif