[cig-commits] commit:

[Mercurial]

changeset:   103:3c4e029f3945
user:        DavidLee
date:        Wed May 14 06:25:43 2008 +0000
files:       Swarm/src/CellLayout.meta Swarm/src/ElementCellLayout.meta Swarm/src/SingleCellLayout.meta Swarm/src/TriSingleCellLayout.meta
description:
meta files for cell layout components


diff -r 4be466fe68ae -r 3c4e029f3945 Swarm/src/CellLayout.meta
--- a/Swarm/src/CellLayout.meta	Wed May 14 06:22:58 2008 +0000
+++ b/Swarm/src/CellLayout.meta	Wed May 14 06:25:43 2008 +0000
@@ -10,7 +10,8 @@
 <param name="Copyright">StGermain Framework. Copyright (C) 2003-2005 VPAC.</param>
 <param name="License">The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html</param>
 <param name="Parent">Stg_Component</param>
-<param name="Description">...</param>
+<param name="isAbstractClass">True</param>
+<param name="Description">Abstract parent class for concrete cell layout class implementations which describe how the particle cells are to be arranged with respect to the element mesh. Contains wrappers for the polymorphic functions.</param>
 
 <!--Now the interesting stuff-->
 
@@ -23,6 +24,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">n/a</param>
 
 </StGermainData>
diff -r 4be466fe68ae -r 3c4e029f3945 Swarm/src/ElementCellLayout.meta
--- a/Swarm/src/ElementCellLayout.meta	Wed May 14 06:22:58 2008 +0000
+++ b/Swarm/src/ElementCellLayout.meta	Wed May 14 06:25:43 2008 +0000
@@ -32,6 +32,7 @@
   </list>
 
   <param name="Example">
+    ./StgDomain/Swarm/tests/testParticleCoords.xml
   </param>
 
 </StGermainData>
diff -r 4be466fe68ae -r 3c4e029f3945 Swarm/src/SingleCellLayout.meta
--- a/Swarm/src/SingleCellLayout.meta	Wed May 14 06:22:58 2008 +0000
+++ b/Swarm/src/SingleCellLayout.meta	Wed May 14 06:25:43 2008 +0000
@@ -10,7 +10,7 @@
 <param name="Copyright">StGermain Framework. Copyright (C) 2003-2005 VPAC.</param>
 <param name="License">The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html</param>
 <param name="Parent">CellLayout</param>
-<param name="Description">...</param>
+<param name="Description">Cell layout for a single particle arrangement, to be mapped to each of the elements.</param>
 
 <!--Now the interesting stuff-->
 
@@ -20,25 +20,25 @@
 		<param name="Name">dim</param>
 		<param name="Type">UnsignedInt</param>
 		<param name="Default">0</param>
-		<param name="Description">...</param>
+		<param name="Description">Dimensionality of the cell.</param>
 	</struct>
 	<struct>
 		<param name="Name">dimExistsI</param>
 		<param name="Type">Bool</param>
 		<param name="Default">True</param>
-		<param name="Description">...</param>
+		<param name="Description">If the cell is defined in the ith dimension, then add particles to the cell in this dimension</param>
 	</struct>
 	<struct>
 		<param name="Name">dimExistsJ</param>
 		<param name="Type">Bool</param>
 		<param name="Default">True</param>
-		<param name="Description">...</param>
+		<param name="Description">If the cell is defined in the jth dimension, then add particles to the cell in this dimension</param>
 	</struct>
 	<struct>
-		<param name="Name"></param>
-		<param name="Type">Bool( cf, self->name, "dimExistsK", </param>
-		<param name="Default"></param>
-		<param name="Description">...</param>
+		<param name="Name">dimExistsK</param>
+		<param name="Type">Bool</param>
+		<param name="Default">dim == 3</param>
+		<param name="Description">If the cell is defined in the kth dimension, then add particles to the cell in this dimension</param>
 	</struct>
 	<struct>
 		<param name="Name">minX</param>
@@ -83,6 +83,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">./StgFEM/Apps/StgFEM_Components/GaussSwarm.xml</param>
 
 </StGermainData>
diff -r 4be466fe68ae -r 3c4e029f3945 Swarm/src/TriSingleCellLayout.meta
--- a/Swarm/src/TriSingleCellLayout.meta	Wed May 14 06:22:58 2008 +0000
+++ b/Swarm/src/TriSingleCellLayout.meta	Wed May 14 06:25:43 2008 +0000
@@ -12,6 +12,7 @@
   <param name="Parent">CellLayout</param>
 
   <param name="Description">
+    Single particle cell denoted by a (right angled) triangular arrangment of nodes. 
   </param>
 
   <list name="Params">
@@ -20,6 +21,7 @@
       <param name="Type">Integer</param>
       <param name="Default">0</param>
       <param name="Description">
+        Dimensionality of the cell.
       </param>
     </struct>