[cig-commits] commit:
Mercurial
hg at geodynamics.org
Mon Nov 24 11:59:42 PST 2008
changeset: 172:1b1d9f2bd3e6
user: Julian Giordani <julian.giordani at sci.monash.edu.au>
date: Thu Oct 30 18:00:48 2008 +1100
files: Geometry/src/ParallelDelaunay.meta Shape/src/Box.meta Shape/src/ConvexHull.meta Shape/src/Everywhere.meta Shape/src/PythonShape.meta Shape/src/ShapeClass.meta Shape/src/Sphere.meta Shape/src/Superellipsoid.meta Shape/src/Union.c Shape/src/Union.meta Swarm/src/FileParticleLayout.meta Swarm/src/SwarmOutput.meta Swarm/src/TriGaussParticleLayout.meta Utils/src/AllElementsVC.meta Utils/src/AllNodesVC.meta Utils/src/DofLayout.meta Utils/src/FieldVariable.meta Utils/src/SemiRegDeform.meta Utils/src/SemiRegDeform.meta.disabled Utils/src/ShapeAdvector.meta Utils/src/WallVC.meta
description:
* Updating meta files
* Removed some useless comments from Union.c
diff -r bebcee520530 -r 1b1d9f2bd3e6 Geometry/src/ParallelDelaunay.meta
--- a/Geometry/src/ParallelDelaunay.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Geometry/src/ParallelDelaunay.meta Thu Oct 30 18:00:48 2008 +1100
@@ -36,5 +36,5 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/Box.meta
--- a/Shape/src/Box.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/Box.meta Thu Oct 30 18:00:48 2008 +1100
@@ -14,9 +14,6 @@
<param name="Reference">...</param>
<param name="Summary">...</param>
<param name="Description">Defines a Box shape</param>
-
-<!--Now the interesting stuff-->
-
<list name="Params">
<struct>
@@ -78,8 +75,6 @@
</list>
<list name="Dependencies">
-<!-- This component calls in another directory so the info above/below may not be complete-->
-
</list>
<!-- Add an exmaple XML if possible -->
<param name="Example">...</param>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/ConvexHull.meta
--- a/Shape/src/ConvexHull.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/ConvexHull.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,7 +13,7 @@
<param name="Parent">Stg_Shape</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This will create a convex hull geometry based on a vertex array supplied. Currently this definition only works for 3 vertecies in 2D and 4 in 3D.</param>
<!--Now the interesting stuff-->
@@ -23,10 +23,42 @@
</list>
<list name="Dependencies">
-<!-- This component calls in another directory so the info above/below may not be complete-->
-
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+<![CDATA[
+ <struct name="shape">
+ <param name="Type">ConvexHull</param>
+ <list name="verticies">
+ <asciidata>
+ <columnDefinition name = "x" type="double"/>
+ <columnDefinition name = "y" type="double"/>
+ <columnDefinition name = "z" type="double"/>
+ 0.3 0.0 0.0
+ -0.3 0.0 0.0
+ 0.0 0.3 0.0
+ </asciidata>
+ </list>
+ </struct>
+
+
+ <!-- In 3D -->
+ <struct name="shape">
+ <param name="Type">ConvexHull</param>
+ <param name="startZ">0.3</param>
+ <list name="verticies">
+ <asciidata>
+ <columnDefinition name = "x" type="double"/>
+ <columnDefinition name = "y" type="double"/>
+ <columnDefinition name = "z" type="double"/>
+ 0.0 0.5 -0.2
+ -0.5 -0.366 -0.2
+ 0.5 -0.366 -0.2
+ 0.0 0.0 0.666
+ </asciidata>
+ </list>
+ </struct>
+ ]]>
+</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/Everywhere.meta
--- a/Shape/src/Everywhere.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/Everywhere.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,10 +13,7 @@
<param name="Parent">Stg_Shape</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">This defines a geometry over the whole computational domain</param>
<list name="Params">
@@ -25,7 +22,6 @@
<list name="Dependencies">
</list>
-<!-- Add an exmaple XML if possible -->
<param name="Example">...</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/PythonShape.meta
--- a/Shape/src/PythonShape.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/PythonShape.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,7 +13,7 @@
<param name="Parent">Stg_Shape</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">Allows for a geometry to be defined in python.</param>
<!--Now the interesting stuff-->
@@ -23,7 +23,7 @@
<param name="Name">Function</param>
<param name="Type">String</param>
<param name="Default">"0"</param>
- <param name="Description">...</param>
+ <param name="Description">Geometry function</param>
</struct>
</list>
@@ -32,6 +32,13 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+<![CDATA[
+ <struct name="shape">
+ <param name="Type">PythonShape</param>
+ <param name="Function"> y > 4 * x * x - 0.5 </param>
+ </struct>
+ ]]>
+</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/ShapeClass.meta
--- a/Shape/src/ShapeClass.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/ShapeClass.meta Thu Oct 30 18:00:48 2008 +1100
@@ -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">The parent class for how Shapes (geometries) are defined in Underworld. This parent class provides data structures and polymoric functions for its children classes - as such should never be an instance of this class, only its children.</param>
<!--Now the interesting stuff-->
@@ -62,6 +62,6 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/Sphere.meta
--- a/Shape/src/Sphere.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/Sphere.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,17 +13,14 @@
<param name="Parent">Stg_Shape</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">This creates a sphere geometry</param>
<list name="Params">
<struct>
<param name="Name">radius</param>
<param name="Type">Double</param>
<param name="Default">0.0</param>
- <param name="Description">...</param>
+ <param name="Description">The radius of the sphere</param>
</struct>
</list>
@@ -31,7 +28,6 @@
<list name="Dependencies">
</list>
-<!-- Add an exmaple XML if possible -->
<param name="Example">...</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/Superellipsoid.meta
--- a/Shape/src/Superellipsoid.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/Superellipsoid.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,7 +13,7 @@
<param name="Parent">Stg_Shape</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This creates a superellipsoid shape $ f(x,y,z) = \left{(\frac{x}{r_x})^{\frac{1}{e_1}} + (\frac{y}{r_y})^{\frac{1}{e_1}}\text{ in 2D}\\\left[(\frac{x}{r_x})^{\frac{1}{e_2}} + (\frac{y}{r_y})^{\frac{1}{e_2}}\right]^{\frac{e_2}{e_1}} +(\frac{z}{r_z})^{\frac{1}{e_1}}\text{ in 3D}\right $ A point is deemed inside the shape if f is ≤ 1</param>
<!--Now the interesting stuff-->
@@ -23,31 +23,31 @@
<param name="Name">radiusX</param>
<param name="Type">Double</param>
<param name="Default">1.0</param>
- <param name="Description">...</param>
+ <param name="Description">Is $r_x$ in the above equation</param>
</struct>
<struct>
<param name="Name">radiusY</param>
<param name="Type">Double</param>
<param name="Default">1.0</param>
- <param name="Description">...</param>
+ <param name="Description">Is $r_y$ in the above equation</param>
</struct>
<struct>
<param name="Name">radiusZ</param>
<param name="Type">Double</param>
<param name="Default">1.0</param>
- <param name="Description">...</param>
+ <param name="Description">Is $r_y$ in the above equation</param>
</struct>
<struct>
<param name="Name">epsilon1</param>
<param name="Type">Double</param>
<param name="Default">1.0</param>
- <param name="Description">...</param>
+ <param name="Description">Is $e_1$ in the above equation</param>
</struct>
<struct>
<param name="Name">epsilon2</param>
<param name="Type">Double</param>
<param name="Default">1.0</param>
- <param name="Description">...</param>
+ <param name="Description">Is $e_2$ in the above equation</param>
</struct>
</list>
@@ -56,6 +56,20 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+<![CDATA[
+ <struct name="shape">
+ <param name="Type">Superellipsoid</param>
+ <param name="CentreX">0.0</param>
+ <param name="CentreY">0.0</param>
+ <param name="CentreZ">0.0</param>
+ <param name="epsilon1">0.5</param>
+ <param name="epsilon2">1.5</param>
+ <param name="radiusX">0.3</param>
+ <param name="radiusY">0.4</param>
+ <param name="radiusZ">0.4</param>
+ </struct>
+]]>
+</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/Union.c
--- a/Shape/src/Union.c Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/Union.c Thu Oct 30 18:00:48 2008 +1100
@@ -228,10 +228,6 @@ void _Union_Construct( void* combination
_Stg_Shape_Construct( self, cf, data );
optionsList = Dictionary_Get( dictionary, "shapes" );
- /* Journal_Firewall( vertexList != NULL, */
- /* Journal_Register( Error_Type, self->type ), */
- /* "In func %s: vertexList specifying the combination is NULL.\n", */
- /* __func__); */
shapeCount = Dictionary_Entry_Value_GetCount(optionsList);
@@ -240,12 +236,6 @@ void _Union_Construct( void* combination
isComplement = Memory_Alloc_Array( Bool, shapeCount, "Complement Array" );
memset( shapeList, 0, shapeCount * sizeof(Stg_Shape*) );
memset( isComplement, 0, shapeCount * sizeof(Bool) );
-
- /* TALK ABOUT WITH ROB, will there be some Flag for Union or Intersection type in the XML file. */
- /* If so do we need another variable on the combination class which is this flag, and then use that flag */
- /* to determine the method of test if a particle is inside or outside the shape */
-
-
Stream_Indent( stream );
for ( shape_I = 0 ; shape_I < shapeCount ; shape_I++) {
diff -r bebcee520530 -r 1b1d9f2bd3e6 Shape/src/Union.meta
--- a/Shape/src/Union.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Shape/src/Union.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,38 +13,41 @@
<param name="Parent">Stg_Shape</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">This is used to create a union geometry of two other geometries. Not can be used in the union if the geometry is preceded by a !</param>
<list name="Params">
-
</list>
<list name="Dependencies">
-<!-- This component calls in another directory so the info above/below may not be complete-->
<struct>
<param name="Essential">True</param>
- <param name="Name">&nameShape[1]</param>
- <param name="Type">Stg_Shape</param>
- <param name="Description">...</param>
+ <param name="Name">shapes</param>
+ <param name="Type">list</param>
+ <param name="Description">A list of shapes (each defined in a param tag). A ! preceding the shape name will caused the not of that shape to be used in the union</param>
+ </struct>
+</list>
+<!-- Add an exmaple XML if possible -->
+<param name="Example">
+<![CDATA[
+ <struct name="myUnion">
+ <param name="Type">Union</param>
+ <list name="shapes">
+ <param>box</param>
+ <param>sphere</param>
+ </list>
</struct>
-<!-- PLEASE, check the above struct information is accurate, in line number 243 of the c file and then remove this comment afterwards -->
-
- <struct>
- <param name="Essential">True</param>
- <param name="Name">nameShape</param>
- <param name="Type">Stg_Shape</param>
- <param name="Description">...</param>
+ <!-- With the NOT of a sphere -->
+ <struct name="myUnionWithNot">
+ <param name="Type">Union</param>
+ <list name="shapes">
+ <param>box</param>
+ <param>!sphere</param>
+ </list>
</struct>
-<!-- PLEASE, check the above struct information is accurate, in line number 247 of the c file and then remove this comment afterwards -->
-
-</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+ ]]>
+</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Swarm/src/FileParticleLayout.meta
--- a/Swarm/src/FileParticleLayout.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Swarm/src/FileParticleLayout.meta Thu Oct 30 18:00:48 2008 +1100
@@ -32,6 +32,6 @@
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Swarm/src/SwarmOutput.meta
--- a/Swarm/src/SwarmOutput.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Swarm/src/SwarmOutput.meta Thu Oct 30 18:00:48 2008 +1100
@@ -55,6 +55,6 @@
</struct>
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Swarm/src/TriGaussParticleLayout.meta
--- a/Swarm/src/TriGaussParticleLayout.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Swarm/src/TriGaussParticleLayout.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,7 +13,7 @@
<param name="Parent">PerCellParticleLayout</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">At present this particle layout will only put a single particle in the middle of triangular element. This layout type is not well tested or used... so use with care.</param>
<!--Now the interesting stuff-->
diff -r bebcee520530 -r 1b1d9f2bd3e6 Utils/src/AllElementsVC.meta
--- a/Utils/src/AllElementsVC.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Utils/src/AllElementsVC.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,19 +13,20 @@
<param name="Parent">VariableCondition</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">Provides a definition across all elements. AllElementsVC is not a strict component, so its definition in xml is not standard.</param>
<list name="Params">
</list>
<list name="Dependencies">
-
+ <struct>
+ <param name="Name">variables</param>
+ <param name="Type">VC list</param>
+ <param name="Default">N/A</param>
+ <param name="Description">See example. Type can be a: int, double, short, char and func (function defined by a plugin)</param>
+ </struct>
</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Utils/src/AllNodesVC.meta
--- a/Utils/src/AllNodesVC.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Utils/src/AllNodesVC.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,19 +13,20 @@
<param name="Parent">VariableCondition</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">Provides a definition of a variable on all nodes. AllNodesVC is not a standard component, so its definition in xml is not standard.</param>
<list name="Params">
</list>
<list name="Dependencies">
-
+ <struct>
+ <param name="Name">variables</param>
+ <param name="Type">VC list</param>
+ <param name="Default">N/A</param>
+ <param name="Description">See example. Type can be a: int, double, short, char and func (function defined by a plugin)</param>
+ </struct>
</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example"></param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Utils/src/DofLayout.meta
--- a/Utils/src/DofLayout.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Utils/src/DofLayout.meta Thu Oct 30 18:00:48 2008 +1100
@@ -20,40 +20,60 @@
<p>DofLayout refers to scalar variables only, not vectors, though a wrapper can be applied later to convert vectors.</p>
</param>
-<!--Now the interesting stuff-->
-
-
<list name="Params">
<struct>
- <param name="Name">Count</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name"></param>
- <param name="Type">UnsignedInt( cf, self->name, "BaseVariableCount", Dictionary_Entry_Value_GetCount</param>
- <param name="Default"></param>
- <param name="Description">...</param>
+ <param name="Name">BaseVariableCount</param>
+ <param name="Type">int</param>
+ <param name="Default">sizeof(BaseVariables) list</param>
+ <param name="Description">Number of BaseVariables (each components) to be stored by this dof</param>
</struct>
</list>
<list name="Dependencies">
-<!-- This component calls in another directory so the info above/below may not be complete-->
-<!-- This component calls in another directory so the info above/below may not be complete-->
<struct>
<param name="Essential">True</param>
- <param name="Name">variableName</param>
- <param name="Type">Variable</param>
- <param name="Description">...</param>
+ <param name="Name">mesh</param>
+ <param name="Type">Mesh</param>
+ <param name="Description">The discrete mesh the variable will be associated with</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 320 of the c file and then remove this comment afterwards -->
+ <struct>
+ <param name="Essential">True</param>
+ <param name="Name">BaseVariables</param>
+ <param name="Type">list</param>
+ <param name="Description">The BaseVariables (each components) to be stored by this dof</param>
+ </struct>
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+<![CDATA[
+ <!-- velocityDofLayout -->
+ <struct name="velocityDofLayout">
+ <param name="Type">DofLayout</param>
+ <param name="mesh">velocityMesh</param>
+ <param name="BaseVariableCount">dim</param>
+ <list name="BaseVariables">
+ <param>vx</param>
+ <param>vy</param>
+ <param>vz</param>
+ </list>
+ </struct>
+ <!-- How the BaseVariables are defined -->
+ <struct name="velocity">
+ <param name="Type">MeshVariable</param>
+ <param name="mesh">velocityMesh</param>
+ <param name="Rank">Vector</param>
+ <param name="DataType">Double</param>
+ <param name="VectorComponentCount">dim</param>
+ <list name="names">
+ <param>vx</param>
+ <param>vy</param>
+ <param>vz</param>
+ </list>
+ </struct>
+ </param>
+]]>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Utils/src/FieldVariable.meta
--- a/Utils/src/FieldVariable.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Utils/src/FieldVariable.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,23 +13,20 @@
<param name="Parent">Stg_Component</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">Creates the background data structures for a variable across the whole domain. This class doesn't do much but just provides an api for accessing variable information. (The real work of a variable is done Variable class and the FeVariable class). As this is an abstract class it is not used explicitly in xml. </param>
<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">Number of dimensions the field exists in</param>
</struct>
<struct>
<param name="Name">fieldComponentCount</param>
<param name="Type">UnsignedInt</param>
<param name="Default">0</param>
- <param name="Description">...</param>
+ <param name="Description">Number of components which make up the field.</param>
</struct>
</list>
@@ -37,7 +34,6 @@
<list name="Dependencies">
</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Utils/src/SemiRegDeform.meta
--- a/Utils/src/SemiRegDeform.meta Thu Oct 30 14:59:40 2008 +1100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,38 +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">SemiRegDeform</param>
-<param name="Author">...</param>
-<param name="Organisation">VPAC</param>
-<param name="Project">StgDomain</param>
-<param name="Location">./StgDomain/Discretisation/Utils/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">A remeshing tool that performs a semi-regular deformation. It used linear interpolation and can operate in one, two or three dimensions.</param>
-<param name="Description"><p>SemiRegDeform is a method for remeshing. It performs a semi-regular deformation.</p>
-
-<p>To use it, pass SemiRegDeform a set of two points on the mesh you wish to deform. SemiRegDeform will construct a straight line between these points and evenly redistribute any nodes that lie along that line. When moving nodes, SemiRegDeform does a linear interpolation on the contents of those features to preserve the accuracy of their data.</p>
-
-<p>Running SemiRegDeform on a large mesh is moderately time-consuming for a single-processor system, though the process is faster when parallelised. SemiRegDeform has been designed to automatically run in parallel, and although this process is non-trivial internally, the mechanism is accessible from the same simple interface.</p>
-
-<p>Furthermore, you can remesh at a higher resolution by using more than one linear set of points. To do this, define a number of lines via the two-point interface. You can build-up a remeshing procedure with SemiRegDeform that works in two or three dimensions, and the order of operations is unimportant.</p>
-</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 bebcee520530 -r 1b1d9f2bd3e6 Utils/src/SemiRegDeform.meta.disabled
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Utils/src/SemiRegDeform.meta.disabled Thu Oct 30 18:00:48 2008 +1100
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
+<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
+
+<param name="Name">SemiRegDeform</param>
+<param name="Author">...</param>
+<param name="Organisation">VPAC</param>
+<param name="Project">StgDomain</param>
+<param name="Location">./StgDomain/Discretisation/Utils/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">A remeshing tool that performs a semi-regular deformation. It used linear interpolation and can operate in one, two or three dimensions.</param>
+<param name="Description"><p>SemiRegDeform is a method for remeshing. It performs a semi-regular deformation.</p>
+
+<p>To use it, pass SemiRegDeform a set of two points on the mesh you wish to deform. SemiRegDeform will construct a straight line between these points and evenly redistribute any nodes that lie along that line. When moving nodes, SemiRegDeform does a linear interpolation on the contents of those features to preserve the accuracy of their data.</p>
+
+<p>Running SemiRegDeform on a large mesh is moderately time-consuming for a single-processor system, though the process is faster when parallelised. SemiRegDeform has been designed to automatically run in parallel, and although this process is non-trivial internally, the mechanism is accessible from the same simple interface.</p>
+
+<p>Furthermore, you can remesh at a higher resolution by using more than one linear set of points. To do this, define a number of lines via the two-point interface. You can build-up a remeshing procedure with SemiRegDeform that works in two or three dimensions, and the order of operations is unimportant.</p>
+</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 bebcee520530 -r 1b1d9f2bd3e6 Utils/src/ShapeAdvector.meta
--- a/Utils/src/ShapeAdvector.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Utils/src/ShapeAdvector.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,10 +13,7 @@
<param name="Parent">Stg_Component</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
-
+<param name="Description">Associates a certain type of TimeIntegrator (a data structure in charge of advection methods) with a given shape class. This creates a new vector variable called shapeCentreVariable. Unfortunately the author has no experience with this components and I can't elaborate more... pardon</param>
<list name="Params">
@@ -27,32 +24,23 @@
<param name="Essential">True</param>
<param name="Name">TimeIntegrator</param>
<param name="Type">TimeIntegrator</param>
- <param name="Description">...</param>
+ <param name="Description">The object in change of certain advection processes</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 178 of the c file and then remove this comment afterwards -->
<struct>
<param name="Essential">True</param>
<param name="Name">VelocityField</param>
<param name="Type">FieldVariable</param>
- <param name="Description">...</param>
+ <param name="Description">The velocity field is needed because it's advection</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 179 of the c file and then remove this comment afterwards -->
-
<struct>
<param name="Essential">True</param>
<param name="Name">Shape</param>
<param name="Type">Stg_Shape</param>
- <param name="Description">...</param>
+ <param name="Description">The shape which will be associated with the time integrator</param>
</struct>
-<!-- PLEASE, check the above struct information is accurate, in line number 180 of the c file and then remove this comment afterwards -->
-
-
</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example"></param>
</StGermainData>
diff -r bebcee520530 -r 1b1d9f2bd3e6 Utils/src/WallVC.meta
--- a/Utils/src/WallVC.meta Thu Oct 30 14:59:40 2008 +1100
+++ b/Utils/src/WallVC.meta Thu Oct 30 18:00:48 2008 +1100
@@ -13,19 +13,102 @@
<param name="Parent">VariableCondition</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
-<param name="Description">...</param>
-
-<!--Now the interesting stuff-->
+<param name="Description">Provides a definition of wall conditions. A wallVC is not a strict component, so its definition in xml is not standard.</param>
<list name="Params">
-
-</list>
+ <struct>
+ <param name="Name">wall</param>
+ <param name="Type">string</param>
+ <param name="Default">0</param>
+ <param name="Description">back, left bottom, right, top, front</param>
+ </struct>
+ <struct>
+ <param name="Name">variables</param>
+ <param name="Type">VC list</param>
+ <param name="Default">N/A</param>
+ <param name="Description">See example. Type can be a: int, double, short, char and func (function defined by a plugin)</param>
+ </struct>
<list name="Dependencies">
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+<![CDATA[
+ <!-- this sets up slip BC on four faces, and outflow velocity conditions on the left and right faces -->
+ <struct name="velocityBCs">
+ <param name="type">CompositeVC</param>
+ <list name="vcList">
+ <struct>
+ <param name="type"> WallVC </param>
+ <param name="wall"> bottom </param>
+ <list name="variables">
+ <struct>
+ <param name="name">vy</param>
+ <param name="type">double</param>
+ <param name="value"> 0 </param>
+ </struct>
+ </list>
+ </struct>
+ <struct>
+ <param name="type"> WallVC </param>
+ <param name="wall"> left </param>
+ <list name="variables">
+ <struct>
+ <param name="name">vx</param>
+ <param name="type">double</param>
+ <param name="value"> -0.5 </param>
+ </struct>
+ </list>
+ </struct>
+ <struct>
+ <param name="type"> WallVC </param>
+ <param name="wall"> right </param>
+ <list name="variables">
+ <struct>
+ <param name="name">vx</param>
+ <param name="type">double</param>
+ <param name="value"> 0.5 </param>
+ </struct>
+ </list>
+ </struct>
+ <struct>
+ <param name="type"> WallVC </param>
+ <param name="wall"> front </param>
+ <list name="variables">
+ <struct>
+ <param name="name">vz</param>
+ <param name="type">double</param>
+ <param name="value"> 0 </param>
+ </struct>
+ </list>
+ </struct>
+ <struct>
+ <param name="type"> WallVC </param>
+ <param name="wall"> back </param>
+ <list name="variables">
+ <struct>
+ <param name="name">vz</param>
+ <param name="type">double</param>
+ <param name="value"> 0 </param>
+ </struct>
+ </list>
+ </struct>
+ <struct>
+ <param name="type"> WallVC </param>
+ <param name="wall"> top </param>
+ <list name="variables">
+ <struct>
+ <param name="name">vy</param>
+ <param name="type">double</param>
+ <param name="value"> 0 </param>
+ </struct>
+ </list>
+ </struct>
+ </list>
+ </struct>
+</param>
+]]>
</StGermainData>
More information about the CIG-COMMITS
mailing list