[cig-commits] commit:

[Mercurial]

changeset:   136:b681563d014a
user:        JulianGiordani
date:        Mon Aug 11 04:27:48 2008 +0000
files:       Swarm/src/ParticleCommHandler.meta Swarm/src/ParticleMovementHandler.meta Swarm/src/PerCellParticleLayout.meta Swarm/src/SingleCellLayout.meta Swarm/src/TriGaussParticleLayout.meta
description:
Updating some of the meta files in my StgDomain meta ticket.


diff -r e821f44f0f35 -r b681563d014a Swarm/src/ParticleCommHandler.meta
--- a/Swarm/src/ParticleCommHandler.meta	Mon Aug 11 03:19:32 2008 +0000
+++ b/Swarm/src/ParticleCommHandler.meta	Mon Aug 11 04:27:48 2008 +0000
@@ -6,14 +6,14 @@
 <param name="Author">...</param>
 <param name="Organisation">VPAC</param>
 <param name="Project">StgDomain</param>
-<param name="Location">./StgDomain/Discretisation/Swarm/src/</param>
+<param name="Location">./StgDomain/Swarm/src/</param>
 <param name="Project Web">http://www.stgermainproject.org/StgDomain.html</param>
 <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="Reference">...</param>
 <param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This in an abstrct call which provides function pointers that run after a solve.</param>
 
 <!--Now the interesting stuff-->
 
diff -r e821f44f0f35 -r b681563d014a Swarm/src/ParticleMovementHandler.meta
--- a/Swarm/src/ParticleMovementHandler.meta	Mon Aug 11 03:19:32 2008 +0000
+++ b/Swarm/src/ParticleMovementHandler.meta	Mon Aug 11 04:27:48 2008 +0000
@@ -5,12 +5,12 @@
 <param name="Name">ParticleMovementHandler</param>
 <param name="Organisation">VPAC</param>
 <param name="Project">StgDomain</param>
-<param name="Location">./</param>
+<param name="Location">./StgDomain/Swarm/src</param>
 <param name="Project Web">http://www.stgermainproject.org/StgDomain.html</param>
 <param name="Copyright">StGermain Framework. Copyright (C) 2003-2005 VPAC.</param>
 <param name="License">https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense</param>
 <param name="Parent">ParticleCommHandler</param>
-<param name="Description">...</param>
+<param name="Description">This component handles particle swarms moving between multiple processors. One particle handler can be used by many swarms, but must be specifed to each swarm separately.</param>
 
 <!--Now the interesting stuff-->
 
diff -r e821f44f0f35 -r b681563d014a Swarm/src/PerCellParticleLayout.meta
--- a/Swarm/src/PerCellParticleLayout.meta	Mon Aug 11 03:19:32 2008 +0000
+++ b/Swarm/src/PerCellParticleLayout.meta	Mon Aug 11 04:27:48 2008 +0000
@@ -13,7 +13,7 @@
 <param name="Parent">ParticleLayout</param>
 <param name="Reference">...</param>
 <param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This is an abstract class for defining an initial distribution of particles cell-by-cell. This class only provides simple data structure and function pointers which execute in the initialisation phase.</param>
 
 <!--Now the interesting stuff-->
 
diff -r e821f44f0f35 -r b681563d014a Swarm/src/SingleCellLayout.meta
--- a/Swarm/src/SingleCellLayout.meta	Mon Aug 11 03:19:32 2008 +0000
+++ b/Swarm/src/SingleCellLayout.meta	Mon Aug 11 04:27:48 2008 +0000
@@ -44,37 +44,37 @@
 		<param name="Name">minX</param>
 		<param name="Type">Double</param>
 		<param name="Default">-1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the min X coordinate within a cell</param>
 	</struct>
 	<struct>
 		<param name="Name">minY</param>
 		<param name="Type">Double</param>
 		<param name="Default">-1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the min Y coordinate within a cell</param>
 	</struct>
 	<struct>
 		<param name="Name">minZ</param>
 		<param name="Type">Double</param>
 		<param name="Default">-1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the min Z coordinate within a cell</param>
 	</struct>
 	<struct>
 		<param name="Name">maxX</param>
 		<param name="Type">Double</param>
 		<param name="Default">1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the max X coordinate within a cell</param>
 	</struct>
 	<struct>
 		<param name="Name">maxY</param>
 		<param name="Type">Double</param>
 		<param name="Default">1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the max Y coordinate within a cell</param>
 	</struct>
 	<struct>
 		<param name="Name">maxZ</param>
 		<param name="Type">Double</param>
 		<param name="Default">1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the max Z coordinate within a cell</param>
 	</struct>
 
 </list>
diff -r e821f44f0f35 -r b681563d014a Swarm/src/TriGaussParticleLayout.meta
--- a/Swarm/src/TriGaussParticleLayout.meta	Mon Aug 11 03:19:32 2008 +0000
+++ b/Swarm/src/TriGaussParticleLayout.meta	Mon Aug 11 04:27:48 2008 +0000
@@ -19,7 +19,18 @@
 
 
 <list name="Params">
-
+	<struct>
+		<param name="Name">dim</param>
+		<param name="Type">Int</param>
+		<param name="Default">3</param>
+		<param name="Description">Number of spatial dimensions for the simulation. This value is taken from the root dictionary and should never be specified otherwise.</param>
+	</struct>
+	<struct>
+		<param name="Name">particlesPerCell</param>
+		<param name="Type">Int</param>
+		<param name="Default">1</param>
+		<param name="Description">Number of particles to use in the cell. This value is taken from the root dictionary and should never be specified otherwise. </param>
+	</struct>
 </list>
 
 <list name="Dependencies">