[cig-commits] commit:
Mercurial
hg at geodynamics.org
Mon Nov 24 11:58:46 PST 2008
changeset: 80:819e158b3b34
user: RobertTurnbull
date: Wed Apr 30 03:43:02 2008 +0000
files: Geometry/src/TensorMath.h Swarm/src/GaussParticleLayout.meta Swarm/src/SwarmDump.meta Swarm/src/UnionParticleLayout.meta Utils/src/DiscretisationContext.meta Utils/src/DomainContext.meta Utils/src/TimeIntegratee.meta
description:
Filling out some meta files in StgDomain that correspond to trac ticket : http://csd.vpac.org/trac/CM/AuScope/AuScopeDoc/ticket/118
Fixing some header file documentation in TensorMath
diff -r 7aa403fc2f9a -r 819e158b3b34 Geometry/src/TensorMath.h
--- a/Geometry/src/TensorMath.h Fri Apr 18 02:04:11 2008 +0000
+++ b/Geometry/src/TensorMath.h Wed Apr 30 03:43:02 2008 +0000
@@ -123,7 +123,7 @@ int SymmetricTensor_TensorMap(Dimension_
/** Alternate mapping index for 2D SymmetricTensor */
#define MAP_2D_SYMM_TENSOR( ii, jj ) ( (ii) == (jj) ? (ii) : 2 )
-/** Alternate mapping index for 2D SymmetricTensor */
+/** Alternate mapping index for 3D SymmetricTensor */
#define MAP_3D_SYMM_TENSOR( ii, jj ) ( (ii) == (jj) ? (ii) : ((ii) + (jj) + 2) )
/** Alternate wrapper for indexing a SymmetricTensor */
diff -r 7aa403fc2f9a -r 819e158b3b34 Swarm/src/GaussParticleLayout.meta
--- a/Swarm/src/GaussParticleLayout.meta Fri Apr 18 02:04:11 2008 +0000
+++ b/Swarm/src/GaussParticleLayout.meta Wed Apr 30 03:43:02 2008 +0000
@@ -48,6 +48,11 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="particleLayout">
+ <param name="Type">GaussParticleLayout</param>
+ <param name="gaussParticles">2</param>
+ </struct>
+</param>
</StGermainData>
diff -r 7aa403fc2f9a -r 819e158b3b34 Swarm/src/SwarmDump.meta
--- a/Swarm/src/SwarmDump.meta Fri Apr 18 02:04:11 2008 +0000
+++ b/Swarm/src/SwarmDump.meta Wed Apr 30 03:43:02 2008 +0000
@@ -13,7 +13,7 @@
<param name="Parent">Stg_Component</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Dumps all the information from the Swarm into a binary file. Occurs on the 'Dump' Entry Point specified by the 'dumpEvery' parameter in your imput file. This component will used HDF5 if it is installed.</param>
<!--Now the interesting stuff-->
@@ -23,7 +23,7 @@
<param name="Name">newFileEachTime</param>
<param name="Type">Bool</param>
<param name="Default">True</param>
- <param name="Description">...</param>
+ <param name="Description">The flag set whether you want the file to re-written over each output step or if you want a new file time.</param>
</struct>
</list>
@@ -33,17 +33,23 @@
<param name="Essential">True</param>
<param name="Name">context</param>
<param name="Type">AbstractContext</param>
- <param name="Description">...</param>
+ <param name="Description">The current context we are working in.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 181 of the c file and then remove this comment afterwards -->
-
-
-<!-- PLEASE, check line number 182 for a dependency and add its information 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">A list of swarms that out want to output.</param>
+ </struct>
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="swarmDump">
+ <param name="Type">SwarmDump</param>
+ <param name="Swarm">materialSwarm</param>
+ <param name="newFileEachTime">false</param>
+ </struct>
+</param>
</StGermainData>
diff -r 7aa403fc2f9a -r 819e158b3b34 Swarm/src/UnionParticleLayout.meta
--- a/Swarm/src/UnionParticleLayout.meta Fri Apr 18 02:04:11 2008 +0000
+++ b/Swarm/src/UnionParticleLayout.meta Wed Apr 30 03:43:02 2008 +0000
@@ -27,5 +27,14 @@
</struct>
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="particleLayout">
+ <param name="Type">UnionParticleLayout</param>
+ <list name="ParticleLayoutList">
+ <param>ParticleLayout1</param>
+ <param>ParticleLayout2</param>
+ <param>ParticleLayout3</param>
+ </list>
+ </struct>
+</param>
diff -r 7aa403fc2f9a -r 819e158b3b34 Utils/src/DiscretisationContext.meta
--- a/Utils/src/DiscretisationContext.meta Fri Apr 18 02:04:11 2008 +0000
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
-<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
-
-<param name="Name">DiscretisationContext</param>
-<param name="Organisation">VPAC</param>
-<param name="Project">StGermain</param>
-<param name="Location">./StGermain/Discretisation/Utils/src/</param>
-<param name="Project Web">https://csd.vpac.org/twiki/bin/view/Stgermain/WebHome</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">AbstractContext</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
-
-<list name="Params">
-
-</list>
-
-<list name="Dependencies">
-
-</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
-
-</StGermainData>
diff -r 7aa403fc2f9a -r 819e158b3b34 Utils/src/DomainContext.meta
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Utils/src/DomainContext.meta Wed Apr 30 03:43:02 2008 +0000
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
+<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
+
+<param name="Name">DiscretisationContext</param>
+<param name="Organisation">VPAC</param>
+<param name="Project">StGermain</param>
+<param name="Location">./StGermain/Discretisation/Utils/src/</param>
+<param name="Project Web">https://csd.vpac.org/twiki/bin/view/Stgermain/WebHome</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">AbstractContext</param>
+<param name="Description">Builds on the AbstractContext by adding a field variable register as well as recorded how many dimensions the problem is in.</param>
+
+<!--Now the interesting stuff-->
+<list name="Params">
+ <struct>
+ <param name="Name">dim</param>
+ <param name="Type">UnsignedInt</param>
+ <param name="Default">2</param>
+ <param name="Description">How many dimensions we are working in (either 2 or 3). This parameter is taken form the root dictionary.</param>
+ </struct>
+</list>
+
+<list name="Dependencies">
+</list>
+<!-- Add an exmaple XML if possible -->
+<param name="Example">N/A</param>
+
+</StGermainData>
diff -r 7aa403fc2f9a -r 819e158b3b34 Utils/src/TimeIntegratee.meta
--- a/Utils/src/TimeIntegratee.meta Fri Apr 18 02:04:11 2008 +0000
+++ b/Utils/src/TimeIntegratee.meta Wed Apr 30 03:43:02 2008 +0000
@@ -16,6 +16,12 @@
<param name="Description">A general class which integrates each element in a Variable through time. It does this through a TimeDerivative method which it calls for each element in the Variable. This happens every time the TimeIntegrator that this object is attached to executes (This should happen on the AbstractContext_EP_Step EntryPoint.</param>
<list name="Params">
+ <struct>
+ <param name="Name">allowFallbackToFirstOrder</param>
+ <param name="Type">Bool</param>
+ <param name="Default">False</param>
+ <param name="Description"></param>
+ </struct>
</list>
<list name="Dependencies">
@@ -43,6 +49,6 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
</StGermainData>
More information about the CIG-COMMITS
mailing list