[cig-commits] commit:

Mercurial hg at geodynamics.org
Mon Nov 24 11:59:01 PST 2008 

changeset:   94:76007441fd13
user:        LukeHodkinson
date:        Wed May 14 03:20:19 2008 +0000
files:       Mesh/src/MeshGenerator.meta Mesh/src/MeshTopology.meta Mesh/src/MeshVariable.meta Mesh/src/Mesh_Algorithms.meta Mesh/src/Mesh_ElementType.meta Mesh/src/Mesh_HexAlgorithms.meta Mesh/src/Mesh_RegularAlgorithms.meta
description:
Updating more meta files.


diff -r 41653dd59374 -r 76007441fd13 Mesh/src/MeshGenerator.meta
--- a/Mesh/src/MeshGenerator.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/MeshGenerator.meta	Wed May 14 03:20:19 2008 +0000
@@ -2,18 +2,55 @@
 <!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
-<param name="Name">MeshGenerator</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="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">MeshGenerator is an internal mechanism for building a mesh of up to three dimensions.  Later, the Mesh component may hold  holds information.
-MeshGenerator takes a list of meshes as its targets.  It is an abstract class and gets inherited by other classes such as CartesianGenerator.</param>
+  <param name="Name">MeshGenerator</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="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">
+    The base class for supplying mesh data to the Mesh component.  Provides
+    a very simple interface.
+  </param>
+
+  <list name="Params">
+    <struct>
+      <param name="Name">dims</param>
+      <param name="Type">Integer</param>
+      <param name="Default">2</param>
+      <param name="Description">
+        The number of dimensions of the mesh to generate.
+      </param>
+    </struct>
+  </list>
+
+  <list name="Dependencies">
+    <struct>
+      <param name="Essential">Only if 'meshes' not specified</param>
+      <param name="Name">mesh</param>
+      <param name="Type">Mesh</param>
+      <param name="Description">
+        The Mesh component to be filled with data.
+      </param>
+    </struct>
+    <struct>
+      <param name="Essential">Only if 'mesh' not specified</param>
+      <param name="Name">meshes</param>
+      <param name="Type">List</param>
+      <param name="Description">
+        A list of Mesh components, each to be filled with data the same
+        data.
+      </param>
+    </struct>
+  </list>
+
+  <param name="Example">
+  </param>
 
 </StGermainData>
diff -r 41653dd59374 -r 76007441fd13 Mesh/src/MeshTopology.meta
--- a/Mesh/src/MeshTopology.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/MeshTopology.meta	Wed May 14 03:20:19 2008 +0000
@@ -2,30 +2,31 @@
 <!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
-<param name="Name">MeshTopology</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="Copyright">StGermain Framework. Copyright (C) 2003-2005 VPAC.</param>
-<param name="License">https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense</param>
-<param name="Parent">Stg_Component</param>
-<param name="Reference">...</param>
-<param name="Summary">Stores topological information about a mesh and useful for Shadowing.</param>
-<param name="Description"><p>MeshTopology stores topological information about a mesh but manages no geometric information.</p><p>MeshTopology is used when Shadowing.  Shadowing is a process by which some data pertaining to a section of the mesh gets duplicated and assigned to a processor managing adjacent decomposition regions.  Shadowing is managed automatically by MeshTopology and can be performed to a specified depth.</p><p>No assumptions are made about how the data is stored.  MeshTopology merely stores and indexes data as requested, per algorithmic demands.</p>
-</param>
+  <param name="Name">MeshTopology</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="Copyright">StGermain Framework. Copyright (C) 2003-2005 VPAC.</param>
+  <param name="License">https://csd.vpac.org/twiki/bin/view/Stgermain/SoftwareLicense</param>
+  <param name="Parent">Stg_Component</param>
+  <param name="Reference">...</param>
+  <param name="Summary">Stores topological information about a mesh and useful for Shadowing.</param>
+  <param name="Description">
+    <p>MeshTopology stores topological information about a mesh but manages no geometric information.</p><p>MeshTopology is used when Shadowing.  Shadowing is a process by which some data pertaining to a section of the mesh gets duplicated and assigned to a processor managing adjacent decomposition regions.  Shadowing is managed automatically by MeshTopology and can be performed to a specified depth.</p><p>No assumptions are made about how the data is stored.  MeshTopology merely stores and indexes data as requested, per algorithmic demands.</p>
+  </param>
 
-<!--Now the interesting stuff-->
+  <list name="Params">
+    n/a
+  </list>
 
+  <list name="Dependencies">
+    n/a
+  </list>
 
-<list name="Params">
+  <param name="Example">
+    n/a
+  </param>
 
-</list>
-
-<list name="Dependencies">
-
-</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
-
+</StGermainData>
diff -r 41653dd59374 -r 76007441fd13 Mesh/src/MeshVariable.meta
--- a/Mesh/src/MeshVariable.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/MeshVariable.meta	Wed May 14 03:20:19 2008 +0000
@@ -9,7 +9,38 @@
 <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">Stg_Component</param>
-<param name="Description">...</param>
+<param name="Parent">Variable</param>
+
+<param name="Description">
+  A kind of Variable component that implicitly extracts the number of items in
+  the variable from the number of elements in any topological dimension from
+  the mesh.
+</param>
+
+  <list name="Params">
+    <struct>
+      <param name="Name">topologicalDim</param>
+      <param name="Type">Integer</param>
+      <param name="Default">0</param>
+      <param name="Description">
+        The topological dimension to use as the number of items in the
+        variable.
+      </param>
+    </struct>
+  </list>
+
+  <list name="Dependencies">
+    <struct>
+      <param name="Essential">Yes</param>
+      <param name="Name">mesh</param>
+      <param name="Type">Mesh</param>
+      <param name="Description">
+        The mesh to take the number of items from.
+      </param>
+    </struct>
+  </list>
+
+  <param name="Example">
+  </param>
 
 </StGermainData>
diff -r 41653dd59374 -r 76007441fd13 Mesh/src/Mesh_Algorithms.meta
--- a/Mesh/src/Mesh_Algorithms.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/Mesh_Algorithms.meta	Wed May 14 03:20:19 2008 +0000
@@ -2,14 +2,32 @@
 <!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
-<param name="Name">Mesh_Algorithms</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">Stg_Component</param>
-<param name="Description">...</param>
+  <param name="Name">Mesh_Algorithms</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">Stg_Component</param>
+
+  <param name="Description">
+    Base class for defining algorithms that operate on entire meshes.  Operations
+    include calculating the nearest vertex to any point, searching the mesh to
+    find which element contains a point and calculating local/domain/global coordinate
+    ranges.
+  </param>
+
+  <list name="Params">
+    n/a
+  </list>
+
+  <list name="Dependencies">
+    n/a
+  </list>
+
+  <param name="Example">
+    n/a
+  </param>
 
 </StGermainData>
diff -r 41653dd59374 -r 76007441fd13 Mesh/src/Mesh_ElementType.meta
--- a/Mesh/src/Mesh_ElementType.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/Mesh_ElementType.meta	Wed May 14 03:20:19 2008 +0000
@@ -2,14 +2,32 @@
 <!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
-<param name="Name">Mesh_ElementType</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">Stg_Component</param>
-<param name="Description">...</param>
+  <param name="Name">Mesh_ElementType</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">Stg_Component</param>
+
+  <param name="Description">
+    Base class for defining operations on a per-element level for a mesh.
+    Operations include determining if an element contains a point in space,
+    calculating the centroid of an element and calculating the shortest
+    distance between any two vertices of an element.
+  </param>
+
+  <list name="Params">
+    n/a
+  </list>
+
+  <list name="Dependencies">
+    n/a
+  </list>
+
+  <param name="Example">
+    n/a
+  </param>
 
 </StGermainData>
diff -r 41653dd59374 -r 76007441fd13 Mesh/src/Mesh_HexAlgorithms.meta
--- a/Mesh/src/Mesh_HexAlgorithms.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/Mesh_HexAlgorithms.meta	Wed May 14 03:20:19 2008 +0000
@@ -2,14 +2,30 @@
 <!DOCTYPE StGermainData SYSTEM "stgermain.dtd">
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
-<param name="Name">Mesh_HexAlgorithms</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">Stg_Component</param>
-<param name="Description">...</param>
+  <param name="Name">Mesh_HexAlgorithms</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">Mesh_Algorithms</param>
+
+  <param name="Description">
+    Provides various optimised mesh related algorithms specific to meshes with hexahedral
+    elements only.
+  </param>
+
+  <list name="Params">
+    n/a
+  </list>
+
+  <list name="Dependencies">
+    n/a
+  </list>
+
+  <param name="Example">
+    n/a
+  </param>
 
 </StGermainData>
diff -r 41653dd59374 -r 76007441fd13 Mesh/src/Mesh_RegularAlgorithms.meta
--- a/Mesh/src/Mesh_RegularAlgorithms.meta	Wed May 14 03:14:26 2008 +0000
+++ b/Mesh/src/Mesh_RegularAlgorithms.meta	Wed May 14 03:20:19 2008 +0000
@@ -9,7 +9,23 @@
 <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">Stg_Component</param>
-<param name="Description">...</param>
+<param name="Parent">Mesh_Algorithms</param>
+
+  <param name="Description">
+    Provides various optimised mesh related algorithms specific to regular structued
+    meshes with hexahedral elements only.
+  </param>
+
+  <list name="Params">
+    n/a
+  </list>
+
+  <list name="Dependencies">
+    n/a
+  </list>
+
+  <param name="Example">
+    n/a
+  </param>
 
 </StGermainData>

More information about the CIG-COMMITS mailing list