[cig-commits] commit: Filling out meta files
Mercurial
hg at geodynamics.org
Mon Nov 24 11:31:03 PST 2008
changeset: 103:b44d618c41f9
user: RobertTurnbull
date: Tue Jul 29 07:47:22 2008 +0000
files: MaterialPoints/src/SwarmAdvector.meta Weights/src/DiscreteVoronoiWeights.meta Weights/src/MomentBalanceWeights.meta
description:
Filling out meta files
See Trac ticket - 136
diff -r 86054e1f6e91 -r b44d618c41f9 MaterialPoints/src/SwarmAdvector.meta
--- a/MaterialPoints/src/SwarmAdvector.meta Thu Jul 24 05:34:16 2008 +0000
+++ b/MaterialPoints/src/SwarmAdvector.meta Tue Jul 29 07:47:22 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">SwarmAdvector</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">VPAC and MCC</param>
<param name="Project">PICellerator</param>
<param name="Location">./PICellerator/MaterialPoints/src/</param>
@@ -11,12 +11,9 @@
<param name="Copyright">Copyright (C) 2005 VPAC and Monash Cluster Computing.</param>
<param name="License">https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">TimeIntegratee</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Reference">http://en.wikipedia.org/wiki/Advection</param>
+<param name="Summary">A component which moves particles according to a velocity field each timestep.</param>
+<param name="Description">A component which moves particles according to a velocity field each timestep.</param>
<list name="Params">
@@ -27,32 +24,32 @@
<param name="Essential">True</param>
<param name="Name">VelocityField</param>
<param name="Type">FeVariable</param>
- <param name="Description">...</param>
+ <param name="Description">The Velocity Field which advects the particles around.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 184 of the c file and then remove this comment afterwards -->
<struct>
<param name="Essential">True</param>
<param name="Name">Swarm</param>
<param name="Type">Swarm</param>
- <param name="Description">...</param>
+ <param name="Description">The swarm of particles to be advected.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 185 of the c file and then remove this comment afterwards -->
<struct>
<param name="Essential">No</param>
<param name="Name">PeriodicBCsManager</param>
<param name="Type">PeriodicBoundariesManager</param>
- <param name="Description">...</param>
+ <param name="Description">If the model has periodic boundary conditions, there my be Periodic Boundary conditions manager which controls how the particles go around the periodic boundaries. If no Periodic BCs Manager is given, and the SwarmAdvector discovers that the mesh is periodic, it will create one for you.</param>
</struct>
+</list>
-<!-- PLEASE, check the above struct information is accurate, in line number 186 of the c file and then remove this comment afterwards -->
-
-
-</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="materialPointsAdvector">
+ <param name="Type">SwarmAdvector</param>
+ <param name="Swarm">materialPointsSwarm</param>
+ <param name="TimeIntegrator">timeIntegrator</param>
+ <param name="VelocityField">VelocityField</param>
+ </struct>
+</param>
</StGermainData>
diff -r 86054e1f6e91 -r b44d618c41f9 Weights/src/DiscreteVoronoiWeights.meta
--- a/Weights/src/DiscreteVoronoiWeights.meta Thu Jul 24 05:34:16 2008 +0000
+++ b/Weights/src/DiscreteVoronoiWeights.meta Tue Jul 29 07:47:22 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">DiscreteVoronoiWeights</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">VPAC and MCC</param>
<param name="Project">PICellerator</param>
<param name="Location">./PICellerator/Weights/src/</param>
@@ -11,15 +11,11 @@
<param name="Copyright">Copyright (C) 2005 VPAC and Monash Cluster Computing.</param>
<param name="License">https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">WeightsCalculator</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Reference"></param>
+<param name="Summary">Calculates the weights via a discrete voronoi diagram.</param>
+<param name="Description">A component to calculate the weights for the particles in the elements by creating a discrete voronoi diagram and using the areas associated with the particles to calculate the weights.</param>
<list name="Params">
-
</list>
<list name="Dependencies">
@@ -27,14 +23,17 @@
<param name="Essential">True</param>
<param name="Name">DiscreteVoronoi</param>
<param name="Type">DiscreteVoronoi</param>
- <param name="Description">...</param>
+ <param name="Description">The Discrete Voronoi component to use to work out the areas associated with the particles.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 121 of the c file and then remove this comment afterwards -->
-
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="weights">
+ <param name="Type">DiscreteVoronoiWeights</param>
+ <param name="DiscreteVoronoi">discreteVoronoi</param>
+ </struct>
+
+</param>
</StGermainData>
diff -r 86054e1f6e91 -r b44d618c41f9 Weights/src/MomentBalanceWeights.meta
--- a/Weights/src/MomentBalanceWeights.meta Thu Jul 24 05:34:16 2008 +0000
+++ b/Weights/src/MomentBalanceWeights.meta Tue Jul 29 07:47:22 2008 +0000
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">MomentBalanceWeights</param>
-<param name="Author">...</param>
+<param name="Author">Dave May and Robert Turnbull</param>
<param name="Organisation">VPAC and MCC</param>
<param name="Project">PICellerator</param>
<param name="Location">./PICellerator/Weights/src/</param>
@@ -11,12 +11,9 @@
<param name="Copyright">Copyright (C) 2005 VPAC and Monash Cluster Computing.</param>
<param name="License">https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">WeightsCalculator</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Reference"></param>
+<param name="Summary">Calculates the weights for particles in an element and satisfies the linear constraints.</param>
+<param name="Description">This assumes the weights are uniform in the quadrants of the elements and then ascertains what those weights are using the linear constraints.</param>
<list name="Params">
@@ -27,14 +24,15 @@
<param name="Essential">No</param>
<param name="Name">BackupWeights</param>
<param name="Type">WeightsCalculator</param>
- <param name="Description">...</param>
+ <param name="Description">Another weights routine to use if the Moment Balence one fails. This will be necessary if no particles are found in one of the quadrants of an element.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 175 of the c file and then remove this comment afterwards -->
-
-
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="weights">
+ <param name="Type">MomentBalanceWeights</param>
+ <param name="BackupWeights">constantWeights</param>
+ </struct>
+</param>
</StGermainData>
More information about the CIG-COMMITS
mailing list