[cig-commits] commit: Updated some meta files
Mercurial
hg at geodynamics.org
Mon Nov 24 11:31:01 PST 2008
changeset: 98:c1c7ac95a05a
user: BelindaMay
date: Wed Jun 11 05:47:34 2008 +0000
files: MaterialPoints/src/CoincidentMapper.meta MaterialPoints/src/GaussMapper.meta MaterialPoints/src/ManyToOneMapper.meta MaterialPoints/src/MaterialFeVariable.meta MaterialPoints/src/OneToOneMapper.meta MaterialPoints/src/PeriodicBoundariesManager.meta Weights/src/VolumeWeights.meta Weights/src/WeightsCalculator.meta
description:
Updated some meta files
diff -r d717a6f624dc -r c1c7ac95a05a MaterialPoints/src/CoincidentMapper.meta
--- a/MaterialPoints/src/CoincidentMapper.meta Wed May 28 02:09:22 2008 +0000
+++ b/MaterialPoints/src/CoincidentMapper.meta Wed Jun 11 05:47:34 2008 +0000
@@ -14,22 +14,15 @@
<param name="Reference">...</param>
<param name="Summary">...</param>
<param name="Description">A one-to-one mapper that maps integration points to material points at the same coordinates. A simple global to local operation is performed. The weight of the integration point is dependant on the WeightCalculator of the IntegrationPointsSwarm.</param>
+
<!--Now the interesting stuff-->
-
-
<list name="Params">
-
</list>
<list name="Dependencies">
- <struct>
- <param name="Essential">True</param>
- <param name="Name">MaterialPointsSwarm</param>
- <param name="Type">MaterialPointsSwarm</param>
- <param name="Description">The material points to be mapped.</param>
- </struct>
</list>
+
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">Underworld/InputFiles/timingExamples/ExtensionNoVisuals_100x100x50.xml</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a MaterialPoints/src/GaussMapper.meta
--- a/MaterialPoints/src/GaussMapper.meta Wed May 28 02:09:22 2008 +0000
+++ b/MaterialPoints/src/GaussMapper.meta Wed Jun 11 05:47:34 2008 +0000
@@ -19,21 +19,13 @@ BackgroundParticleLayout.</param>
BackgroundParticleLayout.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
-
</list>
<list name="Dependencies">
- <struct>
- <param name="Essential">True</param>
- <param name="Name">MaterialPointsSwarm</param>
- <param name="Type">MaterialPointsSwarm</param>
- <param name="Description">The material points to be mapped.</param>
- </struct>
</list>
+
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">Underworld/GaussSwarm.xml</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a MaterialPoints/src/ManyToOneMapper.meta
--- a/MaterialPoints/src/ManyToOneMapper.meta Wed May 28 02:09:22 2008 +0000
+++ b/MaterialPoints/src/ManyToOneMapper.meta Wed Jun 11 05:47:34 2008 +0000
@@ -16,10 +16,7 @@
<param name="Description">Maps many MaterialPointsSwarms to one IntegrationPointsSwarm</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
-
</list>
<list name="Dependencies">
@@ -30,7 +27,8 @@
<param name="Description">The list of material points to be mapped.</param>
</struct>
</list>
+
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">n/a</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a MaterialPoints/src/MaterialFeVariable.meta
--- a/MaterialPoints/src/MaterialFeVariable.meta Wed May 28 02:09:22 2008 +0000
+++ b/MaterialPoints/src/MaterialFeVariable.meta Wed Jun 11 05:47:34 2008 +0000
@@ -13,13 +13,10 @@
<param name="Parent">ParticleFeVariable</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Extends on ParticleFeVariable by adding material properties (and an IntegrationPointsSwarm) </param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
-
</list>
<list name="Dependencies">
@@ -27,14 +24,11 @@
<param name="Essential">True</param>
<param name="Name">Material</param>
<param name="Type">Material</param>
- <param name="Description">...</param>
+ <param name="Description">The material properties to be applied </param>
</struct>
+</list>
-<!-- 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">./Underworld/InputFiles/ExtensionFMM3D.xml</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a MaterialPoints/src/OneToOneMapper.meta
--- a/MaterialPoints/src/OneToOneMapper.meta Wed May 28 02:09:22 2008 +0000
+++ b/MaterialPoints/src/OneToOneMapper.meta Wed Jun 11 05:47:34 2008 +0000
@@ -16,8 +16,6 @@
<param name="Description">An abstract mapper which will yield one-to-one mapping of integration points to material points.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
</list>
@@ -26,11 +24,11 @@
<param name="Essential">True</param>
<param name="Name">MaterialPointsSwarm</param>
<param name="Type">MaterialPointsSwarm</param>
- <param name="Description">The material swarm to map to</param>
+ <param name="Description">The list of material points to be mapped.</param>
</struct>
+</list>
-</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">n/a</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a MaterialPoints/src/PeriodicBoundariesManager.meta
--- a/MaterialPoints/src/PeriodicBoundariesManager.meta Wed May 28 02:09:22 2008 +0000
+++ b/MaterialPoints/src/PeriodicBoundariesManager.meta Wed Jun 11 05:47:34 2008 +0000
@@ -4,5 +4,45 @@
<param name="Name">PeriodicBoundariesManager</param>
<param name="Author">...</param>
+<param name="Organisation">VPAC and MCC</param>
+<param name="Project">PICellerator</param>
+<param name="Location">./PICellerator/MaterialPoints/src/</param>
+<param name="Project Web">https://csd.vpac.org/twiki/bin/view/PICellerator/WebHome</param>
+<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">Stg_Component</param>
+<param name="Reference">...</param>
+<param name="Summary">...</param>
+<param name="Description">The PeriodicBoundariesManager sets up periodic boundaries and changes particle coordinates when particles cross periodic boundaries </param>
+
+<!--Now the interesting stuff-->
+
+
+<list name="Params">
+ <struct>
+ <param name="Name">PeriodicBoundaries</param>
+ <param name="Type">List</param>
+ <param name="Default"></param>
+ <param name="Description">A list of strings defining which boundaries are periodic (eg. I_AXIS, J_AXIS) </param>
+ </struct>
+</list>
+
+<list name="Dependencies">
+ <struct>
+ <param name="Essential">True</param>
+ <param name="Name">mesh</param>
+ <param name="Type">Mesh</param>
+ <param name="Description">The mesh that the swarm exists in, and which defines the boundaries</param>
+ </struct>
+ <struct>
+ <param name="Essential">True</param>
+ <param name="Name">Swarm</param>
+ <param name="Type">Swarm</param>
+ <param name="Description">The swarm of particles that the PeriodicBoundariesManager must move if they cross a periodic boundary</param>
+ </struct>
+</list>
+
+<!-- Add an exmaple XML if possible -->
+<param name="Example">Underworld/InputFiles/VariableConditions/velocityBCs.shear2D.xml</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a Weights/src/VolumeWeights.meta
--- a/Weights/src/VolumeWeights.meta Wed May 28 02:09:22 2008 +0000
+++ b/Weights/src/VolumeWeights.meta Wed Jun 11 05:47:34 2008 +0000
@@ -13,13 +13,10 @@
<param name="Parent">WeightsCalculator</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Calculates PIC integration weights based on cell volumes</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
-
</list>
<list name="Dependencies">
@@ -27,20 +24,18 @@
<param name="Essential">True</param>
<param name="Name">Shape</param>
<param name="Type">Stg_Shape</param>
- <param name="Description">...</param>
+ <param name="Description">The overall shape</param>
</struct>
<struct>
<param name="Essential">True</param>
<param name="Name">Mesh</param>
<param name="Type">FeMesh</param>
- <param name="Description">...</param>
+ <param name="Description">The mesh - assumed to be regular</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>
-
-</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">PICellerator/Apps/src/MaterialPointSwarm-test1.xml</param>
</StGermainData>
diff -r d717a6f624dc -r c1c7ac95a05a Weights/src/WeightsCalculator.meta
--- a/Weights/src/WeightsCalculator.meta Wed May 28 02:09:22 2008 +0000
+++ b/Weights/src/WeightsCalculator.meta Wed Jun 11 05:47:34 2008 +0000
@@ -13,25 +13,22 @@
<param name="Parent">Stg_Component</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">A WeightsCalculator is a component that allows PIC integration weights to calculated in different ways. Current methods include VolumeWeights, ConstantWeights, DiscreteVoronoiWeights, DVCWeights, IterativeWeights and MomentBalanceWeights.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
<struct>
<param name="Name">dim</param>
<param name="Type">UnsignedInt</param>
<param name="Default">0</param>
- <param name="Description">...</param>
+ <param name="Description">The number of dimensions we are working in</param>
</struct>
-
</list>
<list name="Dependencies">
+</list>
-</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">Underworld/InputFiles/timingExamples/ExtensionNoVisuals_100x100x50.xml</param>
</StGermainData>
More information about the CIG-COMMITS
mailing list