[cig-commits] r11608 - in short/3D/PyLith/trunk/doc/userguide: benchmarks benchmarks/strikeslip boundaryconditions install materials runpylith tutorials/3dhex8 tutorials/3dtet4
sue at geodynamics.org
sue at geodynamics.org
Thu Mar 27 12:01:41 PDT 2008
Author: sue
Date: 2008-03-27 12:01:40 -0700 (Thu, 27 Mar 2008)
New Revision: 11608
Modified:
short/3D/PyLith/trunk/doc/userguide/benchmarks/benchmarks.lyx
short/3D/PyLith/trunk/doc/userguide/benchmarks/strikeslip/strikeslip.lyx
short/3D/PyLith/trunk/doc/userguide/boundaryconditions/boundaryconditions.lyx
short/3D/PyLith/trunk/doc/userguide/install/install.lyx
short/3D/PyLith/trunk/doc/userguide/materials/materials.lyx
short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
short/3D/PyLith/trunk/doc/userguide/tutorials/3dhex8/3dhex8.lyx
short/3D/PyLith/trunk/doc/userguide/tutorials/3dtet4/3dtet4.lyx
Log:
various typos, style improvements to tables, and other small changes
Modified: short/3D/PyLith/trunk/doc/userguide/benchmarks/benchmarks.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/benchmarks/benchmarks.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/benchmarks/benchmarks.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -64,13 +64,25 @@
Earthquake Center and the Short-Term Tectonics Working Group within CIG
developed a suite of benchmarks to test the accuracy and peformance of
3D numerical codes.
- The benchmark definitions are posted on the CIG website at http://www.geodynamic
-s.org/cig/workinggroups/short/workarea/benchmarks/.
+ The benchmark definitions are posted on the CIG website at
+\begin_inset LatexCommand htmlurl
+name "Short-Term Tectonics Benchmarks"
+target "geodynamics.org/cig/workinggroups/short/workarea/benchmarks/"
+
+\end_inset
+
+.
These benchmarks permit evaluating the relative performance of different
- types of basis functions, quadrature schemes, and discretizations for
- geophysical applications.
- The files needed to run the benchmarks are in the CIG SVN repository at
- http://geodynamics.org/svn/cig/short/3D/PyLith/benchmarks.
+ types of basis functions, quadrature schemes, and discretizations for geophysic
+al applications.
+ The files needed to run the benchmarks are in the
+\begin_inset LatexCommand htmlurl
+name "CIG SVN Repository"
+target "geodynamics.org/svn/cig/short/3D/PyLith/benchmarks"
+
+\end_inset
+
+.
\end_layout
\begin_layout Standard
Modified: short/3D/PyLith/trunk/doc/userguide/benchmarks/strikeslip/strikeslip.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/benchmarks/strikeslip/strikeslip.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/benchmarks/strikeslip/strikeslip.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -57,9 +57,9 @@
\begin_layout Standard
This benchmark problem computes the viscoelastic (Maxwell) relaxation of
- stresses from a single, finite, strike-slip earthquake in 3-D without gravity.
+ stresses from a single, finite, strike-slip earthquake in 3D without gravity.
Dirichlet boundary conditions equal to the analytical elastic solution
- are imposed on the sides of a cube with sides of length 24 km.
+ are imposed on the sides of a cube with sides of length 24 km.
Anti-plane strain boundary conditions are imposed at y = 0, so the solution
is equivalent to that for a domain with a 48 km length in the y direction.
\end_layout
@@ -79,7 +79,7 @@
\end_inset
- shows the geometry of the strike-slip fault (red surface) embeded in the
+ shows the geometry of the strike-slip fault (red surface) embeded in the
cube consisting of an elastic material (yellow block) over a Maxwell viscoelast
ic material (blue block).
Modified: short/3D/PyLith/trunk/doc/userguide/boundaryconditions/boundaryconditions.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/boundaryconditions/boundaryconditions.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/boundaryconditions/boundaryconditions.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.2 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -354,6 +354,8 @@
\end_layout
\begin_layout Standard
+\noindent
+\align center
\begin_inset Float table
placement H
wide false
@@ -830,6 +832,8 @@
\end_layout
\begin_layout Standard
+\noindent
+\align center
\begin_inset Float table
placement H
wide false
Modified: short/3D/PyLith/trunk/doc/userguide/install/install.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/install/install.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/install/install.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -74,6 +74,11 @@
\end_layout
\begin_layout Section
+\begin_inset LatexCommand label
+name "sec:Getting-Help-and"
+
+\end_inset
+
Getting Help and Reporting Bugs
\end_layout
Modified: short/3D/PyLith/trunk/doc/userguide/materials/materials.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/materials/materials.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/materials/materials.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -448,6 +448,8 @@
\begin_inset Text
\begin_layout Standard
+
+\series bold
Model
\end_layout
@@ -457,6 +459,8 @@
\begin_inset Text
\begin_layout Standard
+
+\series bold
Properties
\end_layout
@@ -466,6 +470,8 @@
\begin_inset Text
\begin_layout Standard
+
+\series bold
State Variables
\end_layout
Modified: short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/runpylith/runpylith.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.4 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -1780,47 +1780,23 @@
\begin_layout Description
output_freq Flag indicating whether to write output based on the time or
number of time steps since the last output.
- Permissible values are
-\begin_inset Quotes eld
-\end_inset
-
-time_step
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- (default).
+ Permissible values are ``time_step'' and ``skip'' (default).
\end_layout
\begin_layout Description
-time_step Minimum time between output if output_freq is set to
-\begin_inset Quotes eld
-\end_inset
-
-time_step
-\begin_inset Quotes erd
-\end_inset
-
-.
+time_step Minimum time between output if
+\family typewriter
+output_freq
+\family default
+ is set to ``time_step''.
\end_layout
\begin_layout Description
-skip Number of time steps between output if output_freq is set to
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
-.
+skip Number of time steps between output if
+\family typewriter
+output_freq
+\family default
+ is set to ``skip''.
A value of 0 means every time step is written.
\end_layout
@@ -1853,8 +1829,11 @@
\end_layout
\begin_layout Standard
-An example of setting the output parameters for a material in a .cfg file
- is
+An example of setting the output parameters for a material in a
+\family typewriter
+.cfg
+\family default
+ file is
\end_layout
\begin_layout LyX-Code
@@ -1909,15 +1888,8 @@
\end_layout
\begin_layout Description
-vertex_data_fields Names of vertex data fields to output (default is [
-\begin_inset Quotes eld
-\end_inset
-
-displacements
-\begin_inset Quotes erd
-\end_inset
-
-]).
+vertex_data_fields Names of vertex data fields to output (default is [``displace
+ments'']).
\end_layout
\begin_layout Subsection
@@ -2006,7 +1978,7 @@
\end_layout
\begin_layout Description
-timeFormat C style format string for time stamp in filename.
+timeFormat C-style format string for time stamp in filename.
The decimal point in the time stamp will be removed for compatibility with
VTK visualization packages that provide seamless animation of data from
multiple VTK files.
@@ -2026,7 +1998,7 @@
\end_layout
\begin_layout Itemize
-Start with a uniform resolution, coarse mesh to debug the problem setup.
+Start with a uniform-resolution coarse mesh to debug the problem setup.
Increase the resolution as necessary to resolve the solution fields of
interest (resolving stresses/strains may require a higher resolution than
that for resolving displacements).
@@ -2039,9 +2011,20 @@
\end_layout
\begin_layout Itemize
-If you encounter errors or warnings, use the --help, --help-components,
- and --help-properties command line arguments to check the parameters to
- make sure PyLith is using the parameters you intended.
+If you encounter errors or warnings, use the
+\family typewriter
+--help
+\family default
+,
+\family typewriter
+--help-components
+\family default
+, and
+\family typewriter
+--help-properties
+\family default
+ command line arguments to check the parameters to make sure PyLith is using
+ the parameters you intended.
\end_layout
\begin_layout Itemize
@@ -2152,11 +2135,16 @@
A segmentation fault might be caused by an error that wasn't trapped or
a bug in the code.
Please report these cases so that we can fix these problems (either trap
- the error and provide the user with an informative error message or fix
+ the error and provide the user with an informative error message, or fix
the bug).
If this occurs with any of the problems distributed with PyLith, simply
- submit a bug report (see Section ) indicating which problem you ran and
- your platform.
+ submit a bug report (see Section
+\begin_inset LatexCommand ref
+reference "sec:Getting-Help-and"
+
+\end_inset
+
+) indicating which problem you ran and your platform.
If the crash occurs for a problem you created, it is a great help if you
can try to reproduce the crash with a very simple problem (e.g., adjust the
boundary conditions or other parameters of one of the examples to reproduce
@@ -2183,7 +2171,7 @@
\end_layout
\begin_layout Quote
-To use valgrind to detect the memory error, first, go to your working directory
+To use valgrind to detect the memory error, first go to your working directory
and run the problem with
\family typewriter
--launcher.dry
Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/3dhex8/3dhex8.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/3dhex8/3dhex8.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/3dhex8/3dhex8.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -730,13 +730,13 @@
\family typewriter
shearxy-statevars-lower_info.vtk
\family default
-) are exactly analagous to the corresponding files for the upper elastic
+) are exactly analogous to the corresponding files for the upper elastic
material.
The final file (
\family typewriter
shearxy-groundsurf_t0000000.vtk
\family default
-) is analagous to
+) is analogous to
\family typewriter
shearxy_t0000000.vtk
\family default
@@ -1100,7 +1100,7 @@
\family typewriter
dislocation-statevars-lower_info.vtk
\family default
-) are exactly analagous to the corresponding files for the upper elastic
+) are exactly analogous to the corresponding files for the upper elastic
material.
The sixth file (
\family typewriter
@@ -1108,7 +1108,7 @@
\newline
surf_t0000000.vtk
\family default
-) is analagous to
+) is analogous to
\family typewriter
dislocation_t0000000.vtk
\family default
Modified: short/3D/PyLith/trunk/doc/userguide/tutorials/3dtet4/3dtet4.lyx
===================================================================
--- short/3D/PyLith/trunk/doc/userguide/tutorials/3dtet4/3dtet4.lyx 2008-03-27 04:39:21 UTC (rev 11607)
+++ short/3D/PyLith/trunk/doc/userguide/tutorials/3dtet4/3dtet4.lyx 2008-03-27 19:01:40 UTC (rev 11608)
@@ -1,4 +1,4 @@
-#LyX 1.5.3 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
\lyxformat 276
\begin_document
\begin_header
@@ -146,7 +146,7 @@
For more detailed information on using LaGriT, refer to the
\begin_inset LatexCommand htmlurl
name "LaGriT web site"
-target "lagrit.lanl..gov"
+target "lagrit.lanl.gov"
\end_inset
@@ -163,7 +163,7 @@
\family sans
\family default
-example directory (
+examples directory (
\family typewriter
examples/3d/tet4
\family default
@@ -218,8 +218,12 @@
\family typewriter
mesh_tet4_1000m.lagrit
\family default
-, you will eventually end up with the files tet4_1000m_binary.gmv,
+, you will eventually end up with the files
\family typewriter
+tet4_1000m_binary.gmv
+\family default
+,
+\family typewriter
tet4_1000m_ascii.gmv
\family default
,
@@ -252,7 +256,7 @@
.pset
\family default
files specify the vertices corresponding to each boundary used in the problem,
- including the fault as well as external boundaries to with boundary conditions
+ including the fault as well as external boundaries to which boundary conditions
are applied.
This mesh may then be used for the examples described below.
\end_layout
@@ -883,7 +887,7 @@
\family typewriter
shearxy-groundsurf_t0000000.vtk
\family default
-) is analagous to
+) is analogous to
\family typewriter
shearxy_t0000000.vtk
\family default
@@ -1104,8 +1108,12 @@
\begin_layout Description
pylithapp.timedependent.materials.elastic_pos1.output Gives the base filename
- for state variable output files for the elastic_pos1 material set (
+ for state variable output files for the
\family typewriter
+elastic_pos1
+\family default
+ material set (
+\family typewriter
dislocation-statevars-pos1.vtk
\family default
), and causes state variables to be averaged over all quadrature points
@@ -1128,8 +1136,12 @@
\begin_layout Description
pylithapp.timedependent.materials.elastic_pos2.output Gives the base filename
- for state variable output files for the elastic_pos2 material set (
+ for state variable output files for the
\family typewriter
+elastic_pos2
+\family default
+ material set (
+\family typewriter
dislocation-statevars-pos2.vtk
\family default
), and causes state variables to be averaged over all quadrature points
@@ -1275,7 +1287,7 @@
\family typewriter
dislocation-groundsurf_t0000000.vtk
\family default
-) is analagous to
+) is analogous to
\family typewriter
dislocation_t0000000.vtk
\family default
More information about the cig-commits
mailing list