[cig-commits] commit:
Mercurial
hg at geodynamics.org
Mon Nov 24 11:59:02 PST 2008
changeset: 96:11423dee6c54
user: BelindaMay
date: Wed May 14 04:04:12 2008 +0000
files: Mesh/src/CartesianGenerator.meta Mesh/src/CompressionAdaptor.meta Mesh/src/MeshAdaptor.meta Mesh/src/SurfaceAdaptor.meta
description:
Updating meta files
diff -r 2118028c1e78 -r 11423dee6c54 Mesh/src/CartesianGenerator.meta
--- a/Mesh/src/CartesianGenerator.meta Wed May 14 03:27:33 2008 +0000
+++ b/Mesh/src/CartesianGenerator.meta Wed May 14 04:04:12 2008 +0000
@@ -3,16 +3,101 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">CartesianGenerator</param>
-<param name="Author">...</param>
<param name="Organisation">VPAC</param>
-<param name="Project">StGermain</param>
-<param name="Location">./StGermain/Discretisation/Mesh/src/</param>
-<param name="Project Web">https://csd.vpac.org/twiki/bin/view/Stgermain/WebHome</param>
+<param name="Project">StgDomain</param>
+<param name="Location">./StgDomain/Mesh/src/</param>
+<param name="Project Web">http://mcc.monash.edu.au/Software/Underworld</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"></param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
+<param name="Parent">MeshGenerator</param>
+<param name="Description">A MeshGenerator specifically for Cartesian meshes </param>
+
+<list name="Params">
+ <struct>
+ <param name="Name">maxDecomposedDims</param>
+ <param name="Type">UnsignedInt</param>
+ <param name="Default">0</param>
+ <param name="Description">The maximum number of dimensions over which the mesh can be decomposed</param>
+ </struct>
+ <struct>
+ <param name="Name">minDecompositions</param>
+ <param name="Type">List</param>
+ <param name="Default"></param>
+ <param name="Description">The maximum number of dimensions over which the mesh can be decomposed</param>
+ </struct>
+ <struct>
+ <param name="Name">maxDecompositions</param>
+ <param name="Type">List</param>
+ <param name="Default"></param>
+ <param name="Description">A list of integers representing the maximum number of decompositions that can be done in each dimension</param>
+ </struct>
+ <struct>
+ <param name="Name">minCoord</param>
+ <param name="Type">List</param>
+ <param name="Default"></param>
+ <param name="Description">A list of doubles representing the minimum coordinate in each dimension</param>
+ </struct>
+ <struct>
+ <param name="Name">maxCoord</param>
+ <param name="Type"></param>
+ <param name="Default"></param>
+ <param name="Description">A list of doubles representing the maximum coordinate in each dimension</param>
+ </struct>
+ <struct>
+ <param name="Name">restartTimestep</param>
+ <param name="Type">Unsigned Int</param>
+ <param name="Default">0</param>
+ <param name="Description">The timestep to restart from when loading from checkpoint. </param>
+ </struct>
+ <struct>
+ <param name="Name">checkpointReadPath</param>
+ <param name="Type">String</param>
+ <param name="Default">./</param>
+ <param name="Description">Specifies the relative path from which to read checkpoint files from when restarting.</param>
+ </struct>
+ <struct>
+ <param name="Name">checkPointPrefixString</param>
+ <param name="Type">String</param>
+ <param name="Default">""</param>
+ <param name="Description">A string to prefix checkpoint filenames.</param>
+ </struct>
+ <struct>
+ <param name="Name">shadowDepth</param>
+ <param name="Type">UnsignedInt</param>
+ <param name="Default">1</param>
+ <param name="Description">The depth to which particles are shadowed</param>
+ </struct>
+ <struct>
+ <param name="Name">regular</param>
+ <param name="Type">Bool</param>
+ <param name="Default">True</param>
+ <param name="Description">Defines whether the mesh is regular</param>
+ </struct>
+ <struct>
+ <param name="Name">periodic_x</param>
+ <param name="Type">Bool</param>
+ <param name="Default">False</param>
+ <param name="Description">Defines whether the mesh is periodic in the x direction</param>
+ </struct>
+ <struct>
+ <param name="Name">periodic_y</param>
+ <param name="Type">Bool</param>
+ <param name="Default">False</param>
+ <param name="Description">Defines whether the mesh is periodic in the y direction</param>
+ </struct>
+ <struct>
+ <param name="Name">periodic_z</param>
+ <param name="Type">Bool</param>
+ <param name="Default">False</param>
+ <param name="Description">Defines whether the mesh is periodic in the z direction</param>
+ </struct>
+</list>
+
+<list name="Dependencies">
+
+</list>
+
+<!-- Add an exmaple XML if possible -->
+<param name="Example">n/a</param>
</StGermainData>
diff -r 2118028c1e78 -r 11423dee6c54 Mesh/src/CompressionAdaptor.meta
--- a/Mesh/src/CompressionAdaptor.meta Wed May 14 03:27:33 2008 +0000
+++ b/Mesh/src/CompressionAdaptor.meta Wed May 14 04:04:12 2008 +0000
@@ -5,14 +5,30 @@
<param name="Name">CompressionAdaptor</param>
<param name="Author">...</param>
<param name="Organisation">VPAC</param>
-<param name="Project">StGermain</param>
-<param name="Location">./StGermain/Discretisation/Mesh/src/</param>
+<param name="Project">StgDomain</param>
+<param name="Location">./StgDomain/Mesh/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"></param>
+<param name="Parent">MeshAdaptor</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">A type of MeshAdaptor that lets you compress the mesh.</param>
+
+<list name="Params">
+ <struct>
+ <param name="Name">compressionfactor</param>
+ <param name="Type">Double</param>
+ <param name="Default">0.0</param>
+ <param name="Description">Controls the extent to which the mesh is compressed</param>
+ </struct>
+</list>
+
+<list name="Dependencies">
+</list>
+
+<!-- Add an exmaple XML if possible -->
+<param name="Example">n/a</param>
+
</StGermainData>
diff -r 2118028c1e78 -r 11423dee6c54 Mesh/src/MeshAdaptor.meta
--- a/Mesh/src/MeshAdaptor.meta Wed May 14 03:27:33 2008 +0000
+++ b/Mesh/src/MeshAdaptor.meta Wed May 14 04:04:12 2008 +0000
@@ -5,12 +5,12 @@
<param name="Name">MeshAdaptor</param>
<param name="Author">...</param>
<param name="Organisation">VPAC</param>
-<param name="Project">StGermain</param>
-<param name="Location">./StGermain/Discretisation/Mesh/src/</param>
+<param name="Project">StgDomain</param>
+<param name="Location">./StgDomain/Mesh/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"></param>
+<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
+<param name="Parent">MeshGenerator</param>
<param name="Reference">...</param>
<param name="Summary">A plug-in that lets you modify the output of a MeshGenerator without changing its code.</param>
<param name="Description"><p>A MeshAdaptor is a customisable component that can be inserted into the mesh generation pipeline. An Adaptor permits you modify the output from different types of mesh generators without modifying the code of a mesh generator. Conceptually, an adaptor can be viewed as a filter or an addition to the output stage.</p>
@@ -19,8 +19,6 @@
<p>Note that one or more MeshAdaptors may be inserted into the process, and there is no theoretical limit to the number of MeshAdaptors. In practise, using more than three or four MeshAdaptors may add a prohibitive overhead and could be grounds for optimisation by removing or combining adaptors.
This modular approach allows a small set of MeshAdaptors to be plugged-in in many combinations for a wide range of effects.</p>
-
-<p>SurfaceAdaptor is an example of a MeshAdaptor. It allows you to modify the top surface without changing the underlying layers. Presently, it's the only MeshAdaptor, but it makes for a useful case study and other MeshAdaptors can be constructed in future.</p>
<p>Each MeshAdaptor is active on its local processor as part of that processor's pipeline. Generally, an even mesh decomposition will lead to processor-load being balanced and processors keeping in synch with their neighbours, but there is no restriction on how a MeshAdaptor can operate. Inserting additional steps where there are dependencies on other processors and pipelines can result in a pipeline stall. This may be the case if there is extensive interaction between processors, as in the following example:</p>
@@ -31,4 +29,25 @@ MeshGenerator4 --> MeshAdaptor4a --> Mes
MeshGenerator4 --> MeshAdaptor4a --> MeshAdaptor4b --> Mesh4</p>
</param>
+<list name="Params">
+</list>
+
+<list name="Dependencies">
+ <struct>
+ <param name="Essential">False</param>
+ <param name="Name">sourceMesh</param>
+ <param name="Type">Mesh</param>
+ <param name="Description">Used as a template </param>
+ </struct>
+ <struct>
+ <param name="Essential">True</param>
+ <param name="Name">sourceGenerator</param>
+ <param name="Type">MeshGenerator</param>
+ <param name="Description">Used as a template if sourceMesh is not available. </param>
+ </struct>
+</list>
+
+<!-- Add an exmaple XML if possible -->
+<param name="Example">n/a</param>
+
</StGermainData>
diff -r 2118028c1e78 -r 11423dee6c54 Mesh/src/SurfaceAdaptor.meta
--- a/Mesh/src/SurfaceAdaptor.meta Wed May 14 03:27:33 2008 +0000
+++ b/Mesh/src/SurfaceAdaptor.meta Wed May 14 04:04:12 2008 +0000
@@ -3,24 +3,59 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">SurfaceAdaptor</param>
-<param name="Author">...</param>
<param name="Organisation">VPAC</param>
-<param name="Project">StGermain</param>
-<param name="Location">./StGermain/Discretisation/Mesh/src/</param>
-<param name="Project Web">https://csd.vpac.org/twiki/bin/view/Stgermain/WebHome</param>
+<param name="Project">StgDomain</param>
+<param name="Location">./StgDomain/Mesh/src/</param>
+<param name="Project Web">http://mcc.monash.edu.au/Software/Underworld.</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"></param>
-<param name="Reference">...</param>
+<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
+<param name="Parent">MeshAdaptor</param>
<param name="Summary">A type of MeshAdaptor that lets you modify the top surface of a mesh without altering the underlying layers.</param>
<param name="Description"><p>SurfaceAdaptor is a type of MeshAdaptor. It allows you to selectively change the top surface of a mesh without altering the underlying layers. </p>
-
-<p>SurfaceAdaptor is an example of a MeshAdaptor. It allows you to modify the top surface without changing the underlying layers. Presently, it's the only MeshAdaptor, but it makes for a useful case study and other MeshAdaptors can be constructed in future.</p>
<p> <br/>Questions: Is SurfaceAdaptor useful when dealing with conditions with highly stratified materials?
Where forces acting on material being modelled only affect the surface and don't penetrate the bulk of the material?
Useful as a quick approximation because you're interested only in examining the surface?
-TODO: Does it stricktly deal with the top layer only, or can you set the depth to which the SurfaceAdaptor goes? This has implications for mesh deformation, level of detail, size of “cells†etc.</p>
+TODO: Does it strictly deal with the top layer only, or can you set the depth to which the SurfaceAdaptor goes? This has implications for mesh deformation, level of detail, size of “cells†etc.</p>
</param>
+<list name="Params">
+ <struct>
+ <param name="Name">surfaceType</param>
+ <param name="Type">String</param>
+ <param name="Default">""</param>
+ <param name="Description">The type of surface to be used - can be "wedge", "sine" or "cosine"</param>
+ </struct>
+ <struct>
+ <param name="Name">offset</param>
+ <param name="Type">Double</param>
+ <param name="Default">0.0</param>
+ <param name="Description">The length of the flat section before the slope of a wedge begins</param>
+ </struct>
+ <struct>
+ <param name="Name">gradient</param>
+ <param name="Type">Double</param>
+ <param name="Default">0.5</param>
+ <param name="Description">The gradient of the slope of a wedge</param>
+ </struct>
+ <struct>
+ <param name="Name">amplitude</param>
+ <param name="Type">Double</param>
+ <param name="Default">1.0</param>
+ <param name="Description">The amplitude of a sine/cosine wave</param>
+ </struct>
+ <struct>
+ <param name="Name">frequency</param>
+ <param name="Type">Double</param>
+ <param name="Default">1.0</param>
+ <param name="Description">The frequency of a sine/cosine wave</param>
+ </struct>
+</list>
+
+<list name="Dependencies">
+</list>
+
+<!-- Add an exmaple XML if possible -->
+<param name="Example">n/a</param>
+
</StGermainData>
More information about the CIG-COMMITS
mailing list