[cig-commits] r9323 - in short/3D/PyLith/trunk/examples/twocells: twoquad4 twotri3

[brad at geodynamics.org]

Author: brad
Date: 2008-02-13 15:54:35 -0800 (Wed, 13 Feb 2008)
New Revision: 9323

Modified:
   short/3D/PyLith/trunk/examples/twocells/twoquad4/README
   short/3D/PyLith/trunk/examples/twocells/twotri3/README
Log:
Cleaned up text in README.

Modified: short/3D/PyLith/trunk/examples/twocells/twoquad4/README
===================================================================
--- short/3D/PyLith/trunk/examples/twocells/twoquad4/README	2008-02-13 22:55:30 UTC (rev 9322)
+++ short/3D/PyLith/trunk/examples/twocells/twoquad4/README	2008-02-13 23:54:35 UTC (rev 9323)
@@ -1,53 +1,57 @@
-This directory contains a set of 3 elastic plane strain example
+This directory contains a set of three elastic plane strain example
 problems. All problems share the same mesh and material properties,
 with the only differences being in the boundary conditions.  The mesh
-consists of two quadrilaterals forming a rectangular mesh.  The
-information describing the examples may be divided into four groups:
+consists of two quadrilaterals forming a rectangular mesh.
 
-1.  Global mesh information:  described in file twoquad4.mesh
+The information describing the examples may be divided into four
+groups:
 
-2.  Parameter settings common to all examples:  described in file
-pylithapp.cfg.
+  * Global mesh information: see twoquad4.mesh
+  * Parameter settings common to all three examples: see pylithapp.cfg.
+  * Material properties common to all three examples: see matprops.spatialdb
+  * Example-specific parameters and boundary condition specifications.
 
-3.  Material properties common to all examples:  described in the
-database file matprops.cfg.
+The examples and associated files are:
 
-4.  Example-specific parameters and boundary condition specifications.
+  * axialdisp
 
-The examples and associated files are:
+    Axial displacements are applied to the left and right edges of the
+    mesh.
 
-1.  axialdisp:  Axial displacements are applied to the left and right
-edges of the mesh.
-  a.  axialdisp.cfg:  Parameter settings for this problem.
-  b.  axialdisp.spatialdb:  Boundary condition database for this
-      problem.
+    - axialdisp.cfg:  Parameter settings.
+    - axialdisp.spatialdb: Database of Dirichlet BC values.
 
-2.  sheardisp:  The left and right edges of the mesh are pinned in the
-x-direction.  The left edge has a negative y-displacement, while the
-right edge has a positive y-displacement.
-  a.  sheardisp.cfg:  Parameter settings for this problem.
-  b.  sheardisp.spatialdb:  Boundary condition database for this
-      problem.
+  * sheardisp: 
 
-3.  dislocation:  Fault displacements are applied between the two
-elements, while the left and right edges are fixed in x and y.
-  a.  dislocation.cfg:  Parameter settings for this problem.
-  b.  dislocation.spatialdb:  Boundary condition database for this
-      problem.
-  c.  dislocation_disp.spatialdb:  Fault slip database for this problem.
-  d.  dislocation_sliprate.spatialdb:  Fault slip rate database for this
-      problem.
-  e.  dislocation_sliptime.spatialdb:  Fault slip time database for this
-      problem.
+    The left and right edges of the mesh are pinned in the
+    x-direction.  The left edge has a negative y-displacement, while
+    the right edge has a positive y-displacement.
 
+    - sheardisp.cfg: Parameter settings.
+    - sheardisp.spatialdb:  Database of Dirichlet BC values.
+
+  * dislocation
+
+    Fault displacements are applied between the two elements, while
+    the left and right edges are fixed in x and y.
+
+    - dislocation.cfg:  Parameter settings.
+    - dislocation.spatialdb: Database of Dirichlet BC values.
+    - dislocation_disp.spatialdb:  Database of fault slip values.
+    - dislocation_sliprate.spatialdb: Database of peak slip rate values.
+    - dislocation_sliptime.spatialdb: Database of slip initiation time values.
+
 All of the files are documented.  The 'pylithapp.cfg' file is read
 automatically when running PyLith.  To add to or override these
 settings, you may place an additional .cfg file on the command line.
+
 To run the examples, you can type:
-pylith axialdisp.cfg
-pylith sheardisp.cfg
-pylith dislocation.cfg
 
-Each of these commands will produce a corresponding VTK file, which may be viewed with visualization packages such as ParaView or Mayavi.  The
-jpeg files in this directory show results for the different examples
-visualized using ParaView.
+  pylith axialdisp.cfg
+  pylith sheardisp.cfg
+  pylith dislocation.cfg
+
+Each of these commands will produce a corresponding suite of VTK
+files, which may be viewed with visualization packages such as
+ParaView or Mayavi.  The jpeg files in this directory show results for
+the different examples visualized using ParaView.

Modified: short/3D/PyLith/trunk/examples/twocells/twotri3/README
===================================================================
--- short/3D/PyLith/trunk/examples/twocells/twotri3/README	2008-02-13 22:55:30 UTC (rev 9322)
+++ short/3D/PyLith/trunk/examples/twocells/twotri3/README	2008-02-13 23:54:35 UTC (rev 9323)
@@ -1,54 +1,61 @@
-This directory contains a set of 3 elastic plane strain example
+This directory contains a set of three elastic plane strain example
 problems. All problems share the same mesh and material properties,
 with the only differences being in the boundary conditions.  The mesh
-consists of two triangles forming a square.  The information describing
-the examples may be divided into four groups:
+consists of two triangles forming a square.  
 
-1.  Global mesh information:  described in file twotri3.mesh
+The information describing the examples may be divided into four
+groups:
 
-2.  Parameter settings common to all examples:  described in file
-pylithapp.cfg.
+  * Global mesh information: see twotri3.mesh
 
-3.  Material properties common to all examples:  described in the
-database file matprops.cfg.
+  * Parameter settings common to all three examples: see pylithapp.cfg.
 
-4.  Example-specific parameters and boundary condition specifications.
+  * Material properties common to all three examples: see matprops.cfg.
 
+  * Example-specific parameters and boundary condition specifications.
+
 The examples and associated files are:
 
-1.  axialdisp:  Axial displacements are applied to the lower left and
-upper right corners of the square.
-  a.  axialdisp.cfg:  Parameter settings for this problem.
-  b.  axialdisp.spatialdb:  Boundary condition database for this
-      problem.
+  * axialdisp
 
-2.  sheardisp:  The left edge of the square is pinned in the x-direction
-and moved downward in the y-direction, while the right edge is moved
-upward in the y-direction.
-  a.  sheardisp.cfg:  Parameter settings for this problem.
-  b.  sheardisp.spatialdb:  Boundary condition database for this
-      problem.
+     Axial displacements are applied to the lower left and upper right
+     corners of the square.
 
-3.  dislocation:  Fault displacements are applied between the two
-triangles, while the lower left and upper right corners are fixed in
-x and y.
-  a.  dislocation.cfg:  Parameter settings for this problem.
-  b.  dislocation.spatialdb:  Boundary condition database for this
-      problem.
-  c.  dislocation_disp.spatialdb:  Fault slip database for this problem.
-  d.  dislocation_sliprate.spatialdb:  Fault slip rate database for this
-      problem.
-  e.  dislocation_sliptime.spatialdb:  Fault slip time database for this
-      problem.
+    - axialdisp.cfg:  Parameter settings
+    - axialdisp.spatialdb: Database with Dirichlet BC values.
 
+  * sheardisp
+
+    The left edge of the square is pinned in the x-direction and moved
+    downward in the y-direction, while the right edge is moved upward
+    in the y-direction.
+
+    - sheardisp.cfg:  Parameter settings
+    - sheardisp.spatialdb:  Database with Dirichlet BC values.
+
+  * dislocation
+
+    Fault displacements are applied between the two triangles, while
+    the lower left and upper right corners are fixed in x and y.
+
+    - dislocation.cfg:  Parameter settings.
+    - dislocation.spatialdb:  Database with Dirichlet BC values.
+    - dislocation_disp.spatialdb:  Database with fault slip values.
+    - dislocation_sliprate.spatialdb: Database with peak slip rate values.
+    - dislocation_sliptime.spatialdb:  Database with slip initiation time 
+        values.
+
 All of the files are documented.  The 'pylithapp.cfg' file is read
 automatically when running PyLith.  To add to or override these
 settings, you may place an additional .cfg file on the command line.
+
 To run the examples, you can type:
-pylith axialdisp.cfg
-pylith sheardisp.cfg
-pylith dislocation.cfg
 
-Each of these commands will produce a corresponding VTK file, which may be viewed with visualization packages such as ParaView or Mayavi.  The
-jpeg files in this directory show results for the different examples
-visualized using ParaView.
+  pylith axialdisp.cfg
+  pylith sheardisp.cfg
+  pylith dislocation.cfg
+
+Each of these commands will produce a suite of corresponding VTK
+files, which may be viewed with visualization packages such as
+ParaView, VISIT, or Mayavi.  The jpeg files in this directory show
+results for the different examples visualized using ParaView.