[cig-commits] r11454 - in short/3D/PyLith/trunk/doc/userguide/tutorials: . twohex8 twoquad4 twotet4 twotet4-geoproj twotri3

brad at geodynamics.org brad at geodynamics.org
Sun Mar 16 20:33:15 PDT 2008


Author: brad
Date: 2008-03-16 20:33:15 -0700 (Sun, 16 Mar 2008)
New Revision: 11454

Modified:
   short/3D/PyLith/trunk/doc/userguide/tutorials/tutorials.lyx
   short/3D/PyLith/trunk/doc/userguide/tutorials/twohex8/twohex8.lyx
   short/3D/PyLith/trunk/doc/userguide/tutorials/twoquad4/twoquad4.lyx
   short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4-geoproj/twotet4-geoproj.lyx
   short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4/twotet4.lyx
   short/3D/PyLith/trunk/doc/userguide/tutorials/twotri3/twotri3.lyx
Log:
Worked on tutorials.

Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/tutorials.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/tutorials.lyx	2008-03-16 22:03:37 UTC (rev 11453)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/tutorials.lyx	2008-03-17 03:33:15 UTC (rev 11454)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.2 created this file. For more info see http://www.lyx.org/
 \lyxformat 276
 \begin_document
 \begin_header
@@ -80,7 +80,7 @@
 .
 
 \color none
- For more complex tutorials, you will also need either the 
+ For more complex tutorials, you will also need either 
 \begin_inset LatexCommand htmlurl
 name "CUBIT"
 target "cubit.sandia.gov"
@@ -94,7 +94,7 @@
 
 \end_inset
 
- mesh generation packages to create your own mesh.
+ mesh generation software to create the meshes.
  If you do not wish to create your own mesh at this time, the meshes are
  also provided as part of the tutorial.
  The 
@@ -105,8 +105,12 @@
 \end_inset
 
  visualization package may be used to view simulation results.
- You may use other packages, but some adaption from what is described here
- will be necessary.
+ ParaView 3 includes built-in documentation that is accessed by clicking
+ on the Help menu item.
+ Some additional documentation is available on the ParaView wiki site (http://pa
+raview.org/Wiki/ParaView).
+ You may use other visualization software, but some adaption from what is
+ described here will be necessary.
  Alternatively, you can complete a subset of the tutorial using files provided
  (as described below), skipping the steps for which you do not have the
  proper software packages installed.
@@ -131,9 +135,9 @@
 \family typewriter
 examples/3d
 \family default
-, will require the use of a mesh generation package to create the meshes.
- All of the files used in the example problems are heavily documented, which
- should help users to understand the different file formats.
+, use external mesh generation software to create the meshes.
+ All of the files used in the example problems are extensively documented
+ with commented files.
 \end_layout
 
 \begin_layout Standard

Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/twohex8/twohex8.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/twohex8/twohex8.lyx	2008-03-16 22:03:37 UTC (rev 11453)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/twohex8/twohex8.lyx	2008-03-17 03:33:15 UTC (rev 11454)
@@ -52,9 +52,57 @@
 
 \end_inset
 
-Tutorial Using Two Trilinear Hexahedra and PyLith Mesh ASCII Format
+Tutorial Using Two Hexahedra
 \end_layout
 
+\begin_layout Standard
+PyLith features discussed in this tutorial:
+\end_layout
+
+\begin_layout Itemize
+Quasi-static solution
+\end_layout
+
+\begin_layout Itemize
+Mesh ASCII format
+\end_layout
+
+\begin_layout Itemize
+Dirichlet boundary conditions
+\end_layout
+
+\begin_layout Itemize
+Kinematic fault interface conditions
+\end_layout
+
+\begin_layout Itemize
+Maxwell viscoelastic material
+\end_layout
+
+\begin_layout Itemize
+VTK output
+\end_layout
+
+\begin_layout Itemize
+Trilinear hexaahedral cells
+\end_layout
+
+\begin_layout Itemize
+SimpleDB spatial database
+\end_layout
+
+\begin_layout Itemize
+FixedDOFDB spatial database
+\end_layout
+
+\begin_layout Itemize
+UniformDB spatial database
+\end_layout
+
+\begin_layout Itemize
+Filtering of cell output fields
+\end_layout
+
 \begin_layout Subsection
 Overview
 \end_layout
@@ -70,8 +118,8 @@
  by hand, using PyLith mesh ASCII format to describe the mesh.
  In this tutorial, we will walk through the steps necessary to construct,
  run, and view three problems that use the same mesh.
- In addition to this manual, each of the files for the example problem is
- heavily documented to aid users in understanding the basic file formats.
+ In addition to this manual, each of the files for the example problems
+ includes extensive comments.
 \end_layout
 
 \begin_layout Subsection
@@ -79,7 +127,7 @@
 \end_layout
 
 \begin_layout Standard
-The mesh consists of two hexahedra forming a brick shape (Figure 
+The mesh consists of two hexahedra forming a rectangular prism (Figure 
 \begin_inset LatexCommand ref
 reference "fig:twohex8-mesh"
 
@@ -219,10 +267,11 @@
 pylithapp.cfg
 \family default
 .
- Note that in this example we make use of the UniformDB implementation,
- rather than the SimpleDB implementation used in the other example problems.
+ Note that in this example we make use of the UniformDB spatial database,
+ rather than the SimpleDB implementation used to specify the physical properties
+ in the other example problems.
  For simple distributions of material properties (or boundary conditions),
- this implementation is actually easier to use.
+ this implementation is often easier to use.
  Examining 
 \family typewriter
 pylithapp.cfg
@@ -287,11 +336,6 @@
 \end_layout
 
 \begin_layout Standard
-Note the specification of material properties in the 
-\family typewriter
-db
-\family default
- parameters.
  Rather than specifying a database file, as for the other examples, the
  properties are specified directly in the 
 \family typewriter
@@ -302,13 +346,7 @@
 \family typewriter
 pylithapp.cfg
 \family default
-, we have commented out the section that would have used the 
-\family typewriter
-matprops.spatialdb
-\family default
- file to specify material properties.
- Either method may be used, since the material properties are uniform for
- this example.
+.
 \end_layout
 
 \begin_layout Subsection
@@ -317,7 +355,7 @@
 
 \begin_layout Standard
 The first example problem is extension of the mesh along the long axis of
- the brick.
+ the prism.
  Parameter settings that override or augment those in 
 \family typewriter
 pylithapp.cfg
@@ -354,8 +392,8 @@
 twohex8.mesh
 \family default
 ) defining the points desired, assigns a label to the boundary condition
- set, and gives the name of the spatial database defining the boundary condition
-s (
+ set, and gives the name of the spatial database with the values for the
+ Dirichlet boundary conditions (
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -373,8 +411,8 @@
 twohex8.mesh
 \family default
 ) defining the points desired, assigns a label to the boundary condition
- set, and gives the name of the spatial database defining the boundary condition
-s (
+ set, and gives the name of the spatial database with the values for the
+ Dirichlet boundary conditions (
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -393,13 +431,13 @@
 
 \begin_layout Description
 pylithapp.timedependent.materials.material.output Defines the filter to be used
- when writing cell state variables (average the quadrature points for the
+ when writing cell state variables (average over the quadrature points of the
  cell), gives the base filename for state variable output files, and defines
  the format to use when defining the output filenames for each time step.
 \end_layout
 
 \begin_layout Standard
-The boundary conditions are described in the file 
+The values for the Dirichlet boundary conditions are given in the file 
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -408,9 +446,8 @@
 axialdisp.cfg
 \family default
 .
- In this case, the desired displacement values are given at two points.
- Since data is being specified at points (rather than being uniform over
- the mesh, for example), the data dimension is one.
+ Since data is being specified using two control points (rather than being
+ uniform over the mesh, for example), the data dimension is one.
 \end_layout
 
 \begin_layout Standard
@@ -460,7 +497,7 @@
 \family typewriter
 xxxx
 \family default
- is the time for which output has been produced.
+ is the time in seconds for which output has been produced.
  These files contain the state variables for each cell at the given time.
  The default fields are the total strain and stress fields.
  As specified in 
@@ -585,8 +622,8 @@
 twohex8.mesh
 \family default
 ) defining the points desired, assigns a label to the boundary condition
- set, and gives the name of the spatial database defining the boundary condition
-s (
+ set, and gives the name of the spatial database with the values for the
+ Dirichlet boundary conditions (
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -604,8 +641,8 @@
 twohex8.mesh
 \family default
 ) defining the points desired, assigns a label to the boundary condition
- set, and gives the name of the spatial database defining the boundary condition
-s (
+ set, and gives the name of the spatial database with the values for the
+ Dirichlet boundary conditions (
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -624,13 +661,13 @@
 
 \begin_layout Description
 pylithapp.timedependent.materials.material.output Defines the filter to be used
- when writing cell state variables (average the quadrature points for the
+ when writing cell state variables (average over the quadrature points of the
  cell), gives the base filename for state variable output files, and defines
  the format to use when defining the output filenames for each time step.
 \end_layout
 
 \begin_layout Standard
-The boundary conditions are described in the file 
+The values for the Dirichlet boundary conditions are given in the file 
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -639,9 +676,8 @@
 sheardisp.cfg
 \family default
 .
- In this case, the desired displacement values are given at two points.
- Since data is being specified at points (rather than being uniform over
- the mesh, for example), the data dimension is one.
+ Data is being specified at two control points (rather than being uniform over
+ the mesh, for example), so the data dimension is one.
 \end_layout
 
 \begin_layout Standard
@@ -691,7 +727,7 @@
 \family typewriter
 xxxx
 \family default
- is the time for which output has been produced.
+ is the time in seconds for which output has been produced.
  These files contain the state variables for each cell at the given time.
  The default fields are the total strain and stress fields.
  As specified in 
@@ -779,9 +815,9 @@
 \end_layout
 
 \begin_layout Standard
-The next example problem is left lateral fault slip applied between the
+The next example problem is left-lateral fault slip applied between the
  two hexahedral cells using kinematic cohesive cells.
- The vertices away from the fault are held fixed in the x, y, and z-directions.
+ The vertices away from the fault are held fixed in the x, y, and z directions.
  Parameter settings that override or augment those in 
 \family typewriter
 pylithapp.cfg
@@ -828,9 +864,8 @@
 \family default
 ) defining the points desired, and assigns a label to the boundary condition
  set.
- In this case, rather than specifying a spatialial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ In this case, we use the default spatial database (FixedDOFDB) for the
+ Dirichlet boundary condition, which sets the displacements to zero.
 \end_layout
 
 \begin_layout Description
@@ -845,9 +880,6 @@
 \family default
 ) defining the points desired, and assigns a label to the boundary condition
  set.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
 \end_layout
 
 \begin_layout Description
@@ -857,7 +889,7 @@
 \family default
 ) defining the points on the fault, provides quadrature information, and
  then gives database names for material properties (needed for conditioning),
- fault slip, fault slip rate, and fault slip time.
+ fault slip, peak fault slip rate, and fault slip time.
 \end_layout
 
 \begin_layout Description
@@ -884,12 +916,6 @@
 \end_layout
 
 \begin_layout Standard
-Rather than specifying the displacement boundary conditions in a spatial
- database file, we use the default behavior for Dirichlet boundary conditions,
- which is a uniform displacement of zero applied at all times.
-\end_layout
-
-\begin_layout Standard
 The fault example requires three additional database files that were not
  needed for the simple displacement examples.
  The first file (
@@ -899,13 +925,13 @@
 ) specifies 0.01 m of left-lateral fault slip for the entire fault.
  The data dimension is zero since the same data is applied to all points
  in the set.
- It is also necessary to specify the slip rate, which is done in the file
+ It is also necessary to specify the peak slip rate, which is done in the file
  
 \family typewriter
 dislocation_sliprate.spatialdb
 \family default
 .
- The slip rate of 1.0e6 m/s is essentially instantaneous.
+ The peak slip rate of 1.0e6 m/s creates a step function for the slip time history.
  Finally, we must provide the time at which slip begins.
  The elastic solution begins at 
 \begin_inset Formula $t=-dt$
@@ -970,7 +996,7 @@
 \family typewriter
 xxxx
 \family default
- is the time for which output has been produced.
+ is the time in seconds for which output has been produced.
  These files will contain mesh information as well as displacement values
  at the mesh vertices.
  The second set of files will have names such as 

Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/twoquad4/twoquad4.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/twoquad4/twoquad4.lyx	2008-03-16 22:03:37 UTC (rev 11453)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/twoquad4/twoquad4.lyx	2008-03-17 03:33:15 UTC (rev 11454)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.2 created this file. For more info see http://www.lyx.org/
 \lyxformat 276
 \begin_document
 \begin_header
@@ -52,9 +52,49 @@
 
 \end_inset
 
-Tutorial Using Two Bilinear Quadrilaterals and PyLith Mesh ASCII Format
+Tutorial Using Two Quadrilaterals
 \end_layout
 
+\begin_layout Standard
+PyLith features discussed in this tutorial:
+\end_layout
+
+\begin_layout Itemize
+Quasi-static solution
+\end_layout
+
+\begin_layout Itemize
+Mesh ASCII format
+\end_layout
+
+\begin_layout Itemize
+Dirichlet boundary conditions
+\end_layout
+
+\begin_layout Itemize
+Kinematic fault interface conditions
+\end_layout
+
+\begin_layout Itemize
+Plane strain linearly elastic material
+\end_layout
+
+\begin_layout Itemize
+VTK output
+\end_layout
+
+\begin_layout Itemize
+Bilinear quadrilateral cells
+\end_layout
+
+\begin_layout Itemize
+SimpleDB spatial database
+\end_layout
+
+\begin_layout Itemize
+FixedDOFDB spatial database
+\end_layout
+
 \begin_layout Subsection
 Overview
 \end_layout
@@ -68,8 +108,8 @@
  by hand, using PyLith mesh ASCII format to describe the mesh.
  In this tutorial, we will walk through the steps necessary to construct,
  run, and view three problems that use the same mesh.
- In addition to this manual, each of the files for the example problem is
- heavily documented to aid users in understanding the basic file formats.
+ In addition to this manual, each of the files for the example problem includes
+ extensive comments.
 \end_layout
 
 \begin_layout Subsection
@@ -77,8 +117,8 @@
 \end_layout
 
 \begin_layout Standard
-The mesh consists of two square cells with edge lengths of one forming a
- regular region (Figure 
+The mesh consists of two square cells with edge lengths of one unit forming
+ a regular region (Figure 
 \begin_inset LatexCommand ref
 reference "fig:twoquad4-mesh"
 
@@ -189,8 +229,8 @@
 \begin_layout Description
 pylithapp.timedependent.materials Settings that control the material type,
  specify which material IDs are to be associated with a particular material
- type, and give the name of the spatial database containing material parameters
- for the mesh.
+ type, and give the name of the spatial database containing physical properties 
+ for the material.
  The quadrature information is also given.
 \end_layout
 
@@ -227,7 +267,7 @@
 \family typewriter
 pylithapp.cfg
 \family default
-, the parameters for the material model are given in 
+, the physical properties for the material are given in 
 \family typewriter
 matprops.spatialdb
 \family default
@@ -267,8 +307,8 @@
 twoquad4.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -299,8 +339,8 @@
 twoquad4.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -327,7 +367,7 @@
 \end_layout
 
 \begin_layout Standard
-The boundary conditions are described in the file 
+The values for the Dirichlet boundary condition are given in the file 
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -336,8 +376,8 @@
 axialdisp.cfg
 \family default
 .
- In this case, the desired displacement values are given at two points.
- Since data is being specified at points (rather than being uniform over
+ Because the data is being specified using two control points with a linear
+ variation in the values between the two (rather than being uniform over
  the mesh, for example), the data dimension is one.
 \end_layout
 
@@ -511,8 +551,8 @@
 twoquad4.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -531,8 +571,8 @@
 twoquad4.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -559,7 +599,8 @@
 \end_layout
 
 \begin_layout Standard
-The boundary conditions are described in the file 
+The values for the Dirichlet boundary conditions are described in the file
+ 
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -568,10 +609,11 @@
 sheardisp.cfg
 \family default
 .
- In this case, the desired displacement values are given at two points,
- corresponding to the two edges we want to constrain.
- Since data is being specified at points (rather than being uniform over
- the mesh, for example), the data dimension is one.
+ In this case, the desired displacement values are given at two control
+ points, corresponding to the two edges we want to constrain.
+ Since data is being specified at two points with a linear variations in
+ the values between the points (rather than being uniform over the mesh,
+ for example), the data dimension is one.
 \end_layout
 
 \begin_layout Standard
@@ -757,9 +799,10 @@
 twoquad4.mesh
 \family default
 ) defining the points desired.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ In this case, rather than specifying a spatial database file with values
+ for the Dirichlet boundary conditions, we use the default spatial database
+ (FixedDOFDB) for the Dirichlet boundary condition, which sets the displacements
+ to zero for all time.
 \end_layout
 
 \begin_layout Description
@@ -769,8 +812,8 @@
 twoquad4.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the traction vectors
+ for the Neumann boundary condition (
 \family typewriter
 axialtract.spatialdb
 \family default
@@ -785,9 +828,8 @@
 twoquad4.mesh
 \family default
 ) defining the points desired.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ In this case, we again use the FixedDOFDB, which sets the displacements
+ to zero for all time.
 \end_layout
 
 \begin_layout Description
@@ -831,7 +873,8 @@
 \end_layout
 
 \begin_layout Standard
-The Neumann boundary conditions are described in the file 
+The traction vectors for the Neumann boundary conditions are given in the
+ file 
 \family typewriter
 axialtract.spatialdb
 \family default
@@ -840,12 +883,7 @@
 axialtract.cfg
 \family default
 .
- In this case, the desired displacement values is given at a single point.
- Since data is uniform over the mesh, the data dimension is zero.
-\end_layout
-
-\begin_layout Standard
-The files containing common information (
+ The files containing common information (
 \family typewriter
 twoquad4.mesh
 \family default
@@ -946,20 +984,23 @@
 
 , which was generated using ParaView.
  The results may be compared against the analytical solution derived in
- 
+ section 
 \begin_inset LatexCommand ref
 reference "sub:Analytical-Constant-Traction"
 
 \end_inset
 
 .
- 
+\end_layout
+
+\begin_layout Standard
 \begin_inset Float figure
 wide false
 sideways false
 status open
 
 \begin_layout Standard
+\align center
 \begin_inset Graphics
 	filename figs/axialtract.jpg
 	lyxscale 50
@@ -1002,7 +1043,7 @@
 \end_layout
 
 \begin_layout Standard
-The next example problem is left lateral fault slip applied between the
+The next example problem is left-lateral fault slip applied between the
  two square cells using kinematic cohesive cells.
  The left and right boundaries are held fixed in the x and y directions.
  Parameter settings that override or augment those in 
@@ -1040,9 +1081,10 @@
 \family default
 ) defining the points desired, and assigning a label to the boundary condition
  set.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ Instead of specifying a spatial database file for the values of the Dirichlet
+ boundary condition, we use the default spatial database (FixedDOFDB) for
+ the Dirichlet boundary condition, which sets the displacements to zero
+ for all time.
 \end_layout
 
 \begin_layout Description
@@ -1058,9 +1100,8 @@
 \family default
 ) defining the points desired, and assigning a label to the boundary condition
  set.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ We use the FixedDOFDB for this boundary condition as well, which sets the
+ displacements to zero for all time.
 \end_layout
 
 \begin_layout Description
@@ -1070,7 +1111,7 @@
 \family default
 ) defining the points on the fault, provides quadrature information, and
  then gives database names for material properties (needed for conditioning),
- fault slip, fault slip rate, and fault slip time.
+ fault slip, peak fault slip rate, and fault slip time.
 \end_layout
 
 \begin_layout Description
@@ -1102,12 +1143,6 @@
 \end_layout
 
 \begin_layout Standard
-Rather than specifying the displacement boundary conditions in a spatial
- database file, we use the default behavior for Dirichlet boundary conditions,
- which is a uniform displacement of zero applied at all times.
-\end_layout
-
-\begin_layout Standard
 The fault example requires three additional database files that were not
  needed for the simple displacement examples.
  The first file (
@@ -1117,13 +1152,14 @@
 ) specifies 0.01 m of left-lateral fault slip for the entire fault.
  The data dimension is zero since the same data is applied to all points
  in the set.
- It is also necessary to specify the slip rate, which is done in the file
- 
+ It is also necessary to specify the peak slip rate, which is done in the
+ file 
 \family typewriter
 dislocation_sliprate.spatialdb
 \family default
 .
- The slip rate of 1.0e6 m/s is essentially instantaneous.
+ The peak slip rate of 1.0e6 m/s creates a step function for the slip time
+ history.
  Finally, we must provide the time at which slip begins.
  The elastic solution begins at 
 \begin_inset Formula $t=-dt$

Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4/twotet4.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4/twotet4.lyx	2008-03-16 22:03:37 UTC (rev 11453)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4/twotet4.lyx	2008-03-17 03:33:15 UTC (rev 11454)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.2 created this file. For more info see http://www.lyx.org/
 \lyxformat 276
 \begin_document
 \begin_header
@@ -41,6 +41,7 @@
 \tracking_changes false
 \output_changes false
 \author "" 
+\author "" 
 \end_header
 
 \begin_body
@@ -51,9 +52,49 @@
 
 \end_inset
 
-Tutorial Using Two Linear Tetrahedra and PyLith Mesh ASCII Format
+Tutorial Using Two Tetrahedra
 \end_layout
 
+\begin_layout Standard
+PyLith features discussed in this tutorial:
+\end_layout
+
+\begin_layout Itemize
+Quasi-static solution
+\end_layout
+
+\begin_layout Itemize
+Mesh ASCII format
+\end_layout
+
+\begin_layout Itemize
+Dirichlet boundary conditions
+\end_layout
+
+\begin_layout Itemize
+Kinematic fault interface conditions
+\end_layout
+
+\begin_layout Itemize
+Linearly elastic isotropic material
+\end_layout
+
+\begin_layout Itemize
+VTK output
+\end_layout
+
+\begin_layout Itemize
+Linear tetrahedral cells
+\end_layout
+
+\begin_layout Itemize
+SimpleDB spatial database
+\end_layout
+
+\begin_layout Itemize
+FixedDOFDB spatial database
+\end_layout
+
 \begin_layout Subsection
 Overview
 \end_layout
@@ -64,11 +105,11 @@
  boundary conditions, and is probably the simplest example of a 3D elastic
  problem.
  Due to the simple geometry of the problem, the mesh may be constructed
- by hand, using PyLith mesh ASCII format to describe the mesh.
+ by hand, using PyLith mesh ASCII format.
  In this tutorial, we will walk through the steps necessary to construct,
  run, and view two problems that use the same mesh.
- In addition to this manual, each of the files for the example problem is
- heavily documented to aid users in understanding the basic file formats.
+ In addition to this manual, each of the files for the example problem includes
+ extensive comments.
 \end_layout
 
 \begin_layout Subsection
@@ -225,14 +266,13 @@
 \family typewriter
 pylithapp.cfg
 \family default
-, the parameters for the material model are given in 
+, the physical properties for the material model are given in 
 \family typewriter
 matprops.spatialdb
 \family default
 .
  For this example, values describing three-dimensional elastic material
- properties are given at a single point, resulting in uniform material propertie
-s.
+ properties are given at a single point, resulting in uniform material properties.
 \end_layout
 
 \begin_layout Subsection
@@ -260,8 +300,7 @@
 \end_layout
 
 \begin_layout Description
-pylithapp.timedependent.bc.bc Defines which degrees of freedom are being constraine
-d (
+pylithapp.timedependent.bc.bc Defines which degrees of freedom are being constrained (
 \family typewriter
 x
 \family default
@@ -278,8 +317,7 @@
 twotet4.mesh
 \family default
 ) defining the points desired, assigns a label to the boundary condition
- set, and gives the name of the spatial database defining the boundary condition
-s (
+ set, and gives the name of the spatial database defining the boundary conditions (
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -305,7 +343,7 @@
 \end_layout
 
 \begin_layout Standard
-The boundary conditions are described in the file 
+The values for the Dirichlet boundary conditions are described in the file 
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -315,8 +353,7 @@
 \family default
 .
  The format of all spatial database files is similar.
- In this case, the desired displacement values are given at two points.
- Since data is being specified at points (rather than being uniform over
+ Because data is being specified using two control points (rather than being uniform over
  the mesh, for example), the data dimension is one.
 \end_layout
 
@@ -454,7 +491,7 @@
 \end_layout
 
 \begin_layout Standard
-The next example problem is left lateral fault slip applied between the
+The next example problem is left-lateral fault slip applied between the
  two tetrahedral cells using kinematic cohesive cells.
  The vertices away from the fault are held fixed in the 
 \family typewriter
@@ -511,9 +548,9 @@
 \family default
 ) defining the points desired, and assigns a label to the boundary condition
  set.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ Rather than specifying a spatial database file to define
+ the boundary conditions, we use the default spatial database (FixedDOFDB) for 
+ the Dirichlet boundary condition, which sets the displacements to zero.
 \end_layout
 
 \begin_layout Description
@@ -523,7 +560,7 @@
 \family default
 ) defining the points on the fault, provides quadrature information, and
  then gives database names for material properties (needed for conditioning),
- fault slip, fault slip rate, and fault slip time.
+ fault slip, peak fault slip rate, and fault slip time.
 \end_layout
 
 \begin_layout Description
@@ -554,12 +591,6 @@
 \end_layout
 
 \begin_layout Standard
-Rather than specifying the displacement boundary conditions in a spatial
- database file, we use the default behavior for Dirichlet boundary conditions,
- which is a uniform displacement of zero applied at all times.
-\end_layout
-
-\begin_layout Standard
 The fault example requires three additional database files that were not
  needed for the simple displacement examples.
  The first file (
@@ -569,13 +600,13 @@
 ) specifies 0.01 m of left-lateral fault slip for the entire fault.
  The data dimension is zero since the same data is applied to all points
  in the set.
- It is also necessary to specify the slip rate, which is done in the file
+ It is also necessary to specify the peak slip rate, which is done in the file
  
 \family typewriter
 dislocation_sliprate.spatialdb
 \family default
 .
- The slip rate of 1.0e6 m/s is essentially instantaneous.
+ The peak slip rate of 1.0e6 m/s creates a step function for the slip time history.
  Finally, we must provide the time at which slip begins.
  The elastic solution begins at 
 \begin_inset Formula $t=-dt$

Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4-geoproj/twotet4-geoproj.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4-geoproj/twotet4-geoproj.lyx	2008-03-16 22:03:37 UTC (rev 11453)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/twotet4-geoproj/twotet4-geoproj.lyx	2008-03-17 03:33:15 UTC (rev 11454)
@@ -52,10 +52,50 @@
 
 \end_inset
 
-Tutorial Using Two Linear Tetrahedra and PyLith Mesh ASCII Format in a Geoprojec
+Tutorial Using Two Tetrahedra with Georeferenced Coordinate Systems
 ted Mesh
 \end_layout
 
+\begin_layout Standard
+PyLith features discussed in this tutorial:
+\end_layout
+
+\begin_layout Itemize
+Quasi-static solution
+\end_layout
+
+\begin_layout Itemize
+Mesh ASCII format
+\end_layout
+
+\begin_layout Itemize
+Dirichlet boundary conditions
+\end_layout
+
+\begin_layout Itemize
+Kinematic fault interface conditions
+\end_layout
+
+\begin_layout Itemize
+Linearly elastic isotropic material
+\end_layout
+
+\begin_layout Itemize
+VTK output
+\end_layout
+
+\begin_layout Itemize
+Linear tetrahedral cells
+\end_layout
+
+\begin_layout Itemize
+SimpleDB spatial database with geographic coordinates
+\end_layout
+
+\begin_layout Itemize
+FixedDOFDB spatial database
+\end_layout
+
 \begin_layout Subsection
 Overview
 \end_layout
@@ -70,42 +110,37 @@
 
 ).
  The primary difference is in how the material properties are assigned.
- For this tutorial, we use the SCEC CVM-H database to assign material properties
-, as described in 
+ For this tutorial, the physical properties come from the SCEC CVM-H database (described in 
 \begin_inset LatexCommand ref
 reference "sub:SCECCVMH-Impl"
 
 \end_inset
-
-.
- Actually using the SCEC SVM-H database is very straightforward, requiring
+).
+ Using the SCEC SVM-H database is straightforward, requiring
  only a few modifications to 
 \family typewriter
 pylithapp.cfg
 \family default
 .
- Additional changes are required, however, because the database requires
- a geoprojected coordinate system.
- This requires changes to the mesh description, the spatial databases, and
- the 
-\family typewriter
-pylithapp.cfg
-\family default
- files.
- Since all aspects of this problem other than the material database and
- the coordinate system are identical to the examples in 
-\begin_inset LatexCommand ref
-reference "sec:Tutorial-Two-tet4"
 
+ Because the SCEC CVM-H database uses geographic coordinates, we must
+ also use geographic coordinates in the PyLith mesh ASCII file and
+ other spatial databases.
+ Note that all of these geographic coordinate
+ systems do not need to be the same. PyLith will automatically
+ transform from one geographic coordinate system to another using the
+ spatialdata package.
+ The spatial databases should all use a Cartesian
+ coordinate system, such as a geographic projection to insure
+ interpolation is performed properly.
+ Since all aspects of this
+ problem other than the material database and the coordinate system
+ are identical to the examples in \begin_inset LatexCommand ref
+ reference "sec:Tutorial-Two-tet4"
+
 \end_inset
 
 , we only describe the kinematic fault problem in this tutorial.
- Due to the simple geometry of the problem, the mesh may be constructed
- by hand, using PyLith mesh ASCII format to describe the mesh.
- In this tutorial, we will walk through the steps necessary to construct,
- run, and view two problems that use the same mesh.
- In addition to this manual, each of the files for the example problem is
- heavily documented to aid users in understanding the basic file formats.
 \end_layout
 
 \begin_layout Subsection
@@ -143,13 +178,15 @@
 
 \end_inset
 
-, you will notice that, although the mesh topology is the same, the vertex
- coordinates are significantly different.
- That is because the SCEC CVM-H database requires a UTM coordinate system
- in zone 11, using the NAD27 datum.
- If you want to use the SCEC CVM-H database, you will need to put your mesh
- in this coordinate system.
-\end_layout
+, you will notice that, although the mesh topology is the same, the
+ vertex coordinates are significantly different.
+ We use zone 11 UTM
+ coordinates with the NAD27 datum for the mesh.
+ Although we used the
+ same coordinate system as the SCEC CVM-H, we could have also used any
+ another geographic projection supported by spatialdata and Proj.4.
+ See appendix SPATIALDATA FILE FORMAT for other examples of using geographic coordinates.
+ \end_layout
 
 \begin_layout Standard
 \noindent
@@ -254,9 +291,9 @@
 \begin_layout Standard
 This problem has some unique aspects compared to the other tutorials.
  First, all of the other tutorials use a Cartesian coordinate system, while
- this one uses a geoprojected coordinate system.
+ this one uses a geographic coordinate system.
  In addition to using different vertex coordinates, we also define the coordinat
-e system in pylithapp.cfg:
+e system for the mesh in pylithapp.cfg:
 \end_layout
 
 \begin_layout LyX-Code
@@ -317,12 +354,8 @@
  coordinate system.
  We then provide the horizontal datum and vertical datum for the coordinate
  system, along with the ellipsoid to be used.
- Finally, we specify a utm projection, and specify zone 11 as the zone to
+ Finally, we specify a UTM projection, and specify zone 11 as the zone to
  be used.
- All of the coordinate transformations in the SpatialData package are perfomed
- using the proj projections library (http://remotesensing.org/proj), and
- additional projection options may be included using the proj-options parameter.
- See the proj documentation for additional information.
 \end_layout
 
 \begin_layout Standard
@@ -353,14 +386,14 @@
 \family default
  option defines 
 \family typewriter
-SCECCVMH
+SCECCVMHDB
 \family default
- as the database to be used.
+ as the spatial database to be used.
  The next line defines the location of the 
 \family typewriter
 vx53
 \family default
- executable, and must be changed to the location specified by the user when
+ data files, and must be changed to the location specified by the user when
  the package is installed.
  The package may be obtained from http://structure.harvard.edu/cvm-h.
 \end_layout
@@ -368,7 +401,7 @@
 \begin_layout Standard
 The final difference with the other examples is in the description of the
  spatial databases.
- These must also be defined as geoprojected databases.
+ They must also use geographic coordinates.
  Examining dislocation_slip.spatialdb, we find:
 \end_layout
 
@@ -420,56 +453,12 @@
 }
 \end_layout
 
-\begin_layout Standard
-Note that the description is somewhat more complex than the corresponding
- entry in 
-\begin_inset LatexCommand ref
-reference "sec:Tutorial-Two-tet4"
-
-\end_inset
-
-:
-\end_layout
-
-\begin_layout LyX-Code
-// We are specifying the data in a Cartesian coordinate system.
-\end_layout
-
-\begin_layout LyX-Code
-cs-data = cartesian {
-\end_layout
-
-\begin_layout LyX-Code
-  // Our units are already in meters, so we can just multiply by one.
-\end_layout
-
-\begin_layout LyX-Code
-  to-meters = 1.0
-\end_layout
-
-\begin_layout LyX-Code
-  // We are using a 3D Cartesian coordinate system.
-\end_layout
-
-\begin_layout LyX-Code
-  space-dim = 3
-\end_layout
-
-\begin_layout LyX-Code
-}
-\end_layout
-
-\begin_layout Standard
-Fortunately, it is quite easy to substitute the appropriate lines in an
- existing spatial database file, which is what we have done with this example.
-\end_layout
-
 \begin_layout Subsection
 Kinematic Fault Slip Example
 \end_layout
 
 \begin_layout Standard
-This example problem is left lateral fault slip applied between the two
+This example problem is left-lateral fault slip applied between the two
  tetrahedral cells using kinematic cohesive cells.
  Note that we vary the amount of fault slip for each vertex with this example,
  as described in 
@@ -477,19 +466,7 @@
 dislocation_slip.spatialdb
 \family default
 .
- The vertices away from the fault are held fixed in the 
-\family typewriter
-x
-\family default
-, 
-\family typewriter
-y
-\family default
-, and 
-\family typewriter
-z
-\family default
--directions.
+ The vertices away from the fault are held fixed in the x, y, and z directions.
  Parameter settings that override or augment those in 
 \family typewriter
 pylithapp.cfg
@@ -532,9 +509,8 @@
 \family default
 ) defining the points desired, and assigns a label to the boundary condition
  set.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ We use the default spatial database (FixedDOFDB) for the Dirichlet boundary
+ conditions, which sets the displacements to zero.
 \end_layout
 
 \begin_layout Description
@@ -544,7 +520,7 @@
 \family default
 ) defining the points on the fault, provides quadrature information, and
  then gives database names for material properties (needed for conditioning),
- fault slip, fault slip rate, and fault slip time.
+ fault slip, peak fault slip rate, and fault slip time.
 \end_layout
 
 \begin_layout Description
@@ -575,43 +551,10 @@
 \end_layout
 
 \begin_layout Standard
-Rather than specifying the displacement boundary conditions in a spatial
- database file, we use the default behavior for Dirichlet boundary conditions,
- which is a uniform displacement of zero applied at all times.
- There is one part of the fault examples that is slightly different from
- the other examples.
- Since the material properties are being defined using the SCEC CVM-H database,
- this same database should be used to condition the equations associated
- with the fault.
- We do this as follows:
-\end_layout
+ Recall that we condition problems with the kinematic fault interface using the material properties. Since the material properties are being defined using the SCEC CVM-H database,
+ this same database should be used as the material database for the faults. This also applies to the AbsorbingDampers boundary condition.
 
-\begin_layout LyX-Code
-[pylithapp.timedependent.interfaces.fault]
-\end_layout
-
-\begin_layout LyX-Code
-mat_db = spatialdata.spatialdb.SCECCVMH
-\end_layout
-
-\begin_layout LyX-Code
-mat_db.data_dir = /home/brad/data/sceccvm-h/vx53/bin
-\end_layout
-
 \begin_layout Standard
-This specifies the 
-\family typewriter
-SCECCVMH
-\family default
- implementation for the material database, and again provides the location
- of the 
-\family typewriter
-vx53
-\family default
- binary.
-\end_layout
-
-\begin_layout Standard
 The fault example requires three additional database files that were not
  needed for the simple displacement examples.
  The first file (
@@ -621,13 +564,13 @@
 ) specifies 0.01 m of left-lateral fault slip for the entire fault.
  Since we specify a different amount of slip for every vertex on the fault,
  the data dimension is one.
- It is also necessary to specify the slip rate, which is done in the file
+ It is also necessary to specify the peak slip rate, which is done in the file
  
 \family typewriter
 dislocation_sliprate.spatialdb
 \family default
 .
- The slip rate of 1.0e6 m/s is essentially instantaneous.
+ The peak slip rate of 1.0e6 m/s generates a step-function for the slip time history.
  Finally, we must provide the time at which slip begins.
  The elastic solution begins at 
 \begin_inset Formula $t=-dt$

Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/twotri3/twotri3.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/twotri3/twotri3.lyx	2008-03-16 22:03:37 UTC (rev 11453)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/twotri3/twotri3.lyx	2008-03-17 03:33:15 UTC (rev 11454)
@@ -1,4 +1,4 @@
-#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.2 created this file. For more info see http://www.lyx.org/
 \lyxformat 276
 \begin_document
 \begin_header
@@ -52,9 +52,49 @@
 
 \end_inset
 
-Tutorial Using Two Linear Triangles and PyLith Mesh ASCII Format
+Tutorial Using Two Triangles
 \end_layout
 
+\begin_layout Standard
+PyLith features discussed in this tutorial:
+\end_layout
+
+\begin_layout Itemize
+Quasi-static solution
+\end_layout
+
+\begin_layout Itemize
+Mesh ASCII format
+\end_layout
+
+\begin_layout Itemize
+Dirichlet boundary conditions
+\end_layout
+
+\begin_layout Itemize
+Kinematic fault interface conditions
+\end_layout
+
+\begin_layout Itemize
+Plane strain linearly elastic material
+\end_layout
+
+\begin_layout Itemize
+VTK output
+\end_layout
+
+\begin_layout Itemize
+Linear triangular cells
+\end_layout
+
+\begin_layout Itemize
+SimpleDB spatial database
+\end_layout
+
+\begin_layout Itemize
+FixedDOFDB spatial database
+\end_layout
+
 \begin_layout Subsection
 Overview
 \end_layout
@@ -68,8 +108,8 @@
  by hand, using PyLith mesh ASCII format.
  In this tutorial, we will walk through the steps necessary to construct,
  run, and view three problems that use the same mesh.
- In addition to this manual, each of the files for the example problem is
- heavily documented to aid users in understanding the basic file formats.
+ In addition to this manual, each of the files for the example problem includes
+ extensive comments.
 \end_layout
 
 \begin_layout Subsection
@@ -183,8 +223,8 @@
 \begin_layout Description
 pylithapp.timedependent.materials Settings that control the material type,
  specify which material IDs are to be associated with a particular material
- type, and give the name of the spatial database containing material parameters
- for the mesh.
+ type, and give the name of the spatial database containing the physical 
+ properties for the material.
  The quadrature information is also given.
 \end_layout
 
@@ -261,8 +301,8 @@
 twotri3.mesh
 \family default
 ) defining the points desired, assigns a label to the boundary condition
- set, and gives the name of the spatial database defining the boundary condition
-s (
+ set, and gives the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -288,7 +328,7 @@
 \end_layout
 
 \begin_layout Standard
-The boundary conditions are described in the file 
+The values for the Dirichlet boundary condition are given in the file 
 \family typewriter
 axialdisp.spatialdb
 \family default
@@ -471,8 +511,8 @@
 twotri3.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -491,8 +531,8 @@
 twotri3.mesh
 \family default
 ) defining the points desired, assigning a label to the boundary condition
- set, and giving the name of the spatial database defining the boundary
- conditions (
+ set, and giving the name of the spatial database with the values for the
+ Dirichlet boundary condition (
 \family typewriter
 sheardisp.spatialdb
 \family default
@@ -653,7 +693,7 @@
 \end_layout
 
 \begin_layout Standard
-The next example problem is left lateral fault slip applied between the
+The next example problem is left-lateral fault slip applied between the
  two triangular cells using kinematic cohesive cells.
  The lower left and upper right boundaries are held fixed in the x and y
  directions.
@@ -666,6 +706,8 @@
 dislocation.cfg
 \family default
 .
+ The solution corresponds to rigid body rotation of each triangular cell.
+ As a result, the tractions on the fault are zero.
  These settings are:
 \end_layout
 
@@ -687,9 +729,10 @@
 \family default
 ) defining the points desired, and assigns a label to the boundary condition
  set.
- In this case, rather than specifying a spatial database file to define
- the boundary conditions, the default for Dirichlet BC is used, which sets
- the displacements to zero for all time.
+ In this case, rather than specifying a spatial database file with the values
+ for the Dirichlet boundary condition.
+ The default database (FixedDOFDB) for Dirichlet boundary conditions is
+ used, which sets the displacements to zero.
 \end_layout
 
 \begin_layout Description
@@ -699,7 +742,7 @@
 \family default
 ) defining the points on the fault, provides quadrature information, and
  then gives database names for material properties (needed for conditioning),
- fault slip, fault slip rate, and fault slip time.
+ fault slip, peak fault slip rate, and fault slip time.
 \end_layout
 
 \begin_layout Description
@@ -732,7 +775,7 @@
 \begin_layout Standard
 Rather than specifying the displacement boundary conditions in a spatial
  database file, we use the default behavior for Dirichlet boundary conditions,
- which is a uniform displacement of zero applied at all times.
+ which is a uniform, constant displacement of zero.
 \end_layout
 
 \begin_layout Standard
@@ -745,13 +788,14 @@
 ) specifies 0.01 m of left-lateral fault slip for the entire fault.
  The data dimension is zero since the same data is applied to all points
  in the set.
- It is also necessary to specify the slip rate, which is done in the file
- 
+ It is also necessary to specify the peak slip rate, which is done in the
+ file 
 \family typewriter
 dislocation_sliprate.spatialdb
 \family default
 .
- The slip rate of 1.0e6 m/s is essentially instantaneous.
+ The peak slip rate of 1.0e6 m/s creates a step-function for the slip time
+ history.
  Finally, we must provide the time at which slip begins.
  The elastic solution begins at 
 \begin_inset Formula $t=-dt$



More information about the cig-commits mailing list