[cig-commits] r6119 - long/3D/Gale/trunk/documentation
sue at geodynamics.org
sue at geodynamics.org
Mon Feb 26 15:36:01 PST 2007
Author: sue
Date: 2007-02-26 15:35:58 -0800 (Mon, 26 Feb 2007)
New Revision: 6119
Modified:
long/3D/Gale/trunk/documentation/gale.lyx
long/3D/Gale/trunk/documentation/gale.pdf
Log:
typos fixed, todo's added in order to begin improving user manual flow
Modified: long/3D/Gale/trunk/documentation/gale.lyx
===================================================================
--- long/3D/Gale/trunk/documentation/gale.lyx 2007-02-26 22:01:47 UTC (rev 6118)
+++ long/3D/Gale/trunk/documentation/gale.lyx 2007-02-26 23:35:58 UTC (rev 6119)
@@ -1017,7 +1017,7 @@
\begin_layout Standard
If you downloaded binaries for your platform, you can run the Gale executable
directly.
- For example
+ For example,
\end_layout
\begin_layout LyX-Code
@@ -1025,7 +1025,7 @@
\end_layout
\begin_layout Standard
-This will output
+will output
\end_layout
\begin_layout LyX-Code
@@ -1053,7 +1053,9 @@
\end_layout
\begin_layout Standard
-If you do not specify an input file, you will get a cryptic error
+If you do not specify an input file, you will get a cryptic error (TODO:
+ need better description.
+ If cryptic, why not fix it?)
\end_layout
\begin_layout LyX-Code
@@ -1071,7 +1073,15 @@
\end_layout
\begin_layout Standard
-If Gale can not find the file, you will get a better error
+If Gale cannot find the file, you will get a better error (TODO:
+\begin_inset Quotes sld
+\end_inset
+
+better
+\begin_inset Quotes srd
+\end_inset
+
+ error awkward, need some other description)
\end_layout
\begin_layout LyX-Code
@@ -1089,8 +1099,7 @@
\begin_layout Standard
Due to quirks in some implementations of MPI, you may have to specify the
- complete path to the input file (e.g.
-
+ complete path to the input file (e.g.,
\family typewriter
./Gale-1_1_1 /home/juser/gale/input/extension.xml
\family default
@@ -1116,9 +1125,8 @@
\end_layout
\begin_layout Standard
-If you compiled Gale yourself, then you can run it from where you installed
- it.
- If running in parallel, then just prepend
+If you compile Gale yourself, you run it from where you installed it.
+ If running in parallel, prepend
\family typewriter
mpirun
\family default
@@ -1127,14 +1135,33 @@
mpiexec
\family default
.
- The extension example should run for 500 time steps and generate a great
- deal of output in the
+ The
\family typewriter
+extension.xml
+\family default
+ example should run for 500 time steps and generate a great deal of output
+ in the
+\family typewriter
output.extension
\family default
directory.
- There are also examples of shortening, subduction, and relaxation of a
- sinusoid.
+ There [TODO:
+\begin_inset Quotes sld
+\end_inset
+
+you will find
+\begin_inset Quotes srd
+\end_inset
+
+ instead of
+\begin_inset Quotes sld
+\end_inset
+
+are also
+\begin_inset Quotes srd
+\end_inset
+
+?] are also examples of shortening, subduction, and relaxation of a sinusoid.
\end_layout
\begin_layout Standard
@@ -1172,23 +1199,15 @@
\color none
.vtk
\family default
- files
-\color default
-.
-
-\color none
-The formats of the
+ files.
+ The formats of the
\family typewriter
-\color default
.dat
\family default
-\color none
and
\family typewriter
-\color default
.txt
\family default
-\color none
files are described fully in Appendix
\begin_inset LatexCommand \ref{cha:Output-File-Format}
@@ -1242,19 +1261,20 @@
\end_layout
\begin_layout Standard
+(TODO: example of what changing dumpEvery will look like.)
+\end_layout
+\begin_layout Standard
+
\color none
There are a number of different options for visualizing the data.
The easiest way is to use the
\family typewriter
-\color default
.vtk
\family default
-\color none
files.
These files are in a standard, self-describing file format that can be
- easily visualized with several different visualization programs (e.g.
-
+ easily visualized with several different visualization programs, e.g.,
\begin_inset LatexCommand \htmlurl[ParaView]{paraview.org}
\end_inset
@@ -1269,7 +1289,7 @@
\end_inset
-).
+.
\end_layout
\begin_layout Standard
@@ -1285,6 +1305,7 @@
\begin_layout Standard
The last option is to use a spreadsheet program such as Excel.
This is very limited.
+ (TODO: in what way?)
\end_layout
\begin_layout Subsection
@@ -1449,7 +1470,6 @@
\color none
fields.00010.vtk
\family default
-\color default
, graying it out.
\newline
@@ -1464,8 +1484,8 @@
\end_layout
\begin_layout Enumerate
-Now you can plot the velocity as arrows on top of the pressure by first
- clicking on the ``Glyph'' symbol
+Now you can plot the velocity as arrows on top of the pressure: Click on
+ the ``Glyph'' symbol
\newline
\newline
@@ -1479,7 +1499,8 @@
\newline
\newline
-and then pressing the green ``Accept'' button.
+and then press the green ``Accept'' button.
+ The result will look like this:
\end_layout
\begin_deeper
@@ -1510,13 +1531,13 @@
\end_deeper
\begin_layout Enumerate
-You can also visualize the Strain Rate Invariant.
- You start by clicking on the greyed-out eye next to
+You can also visualize the Strain Rate Invariant: Click on the grayed-out
+ eye next to
\family typewriter
\color none
fields.00010.vtk
\family default
- and then clicking on the ``Display'' tab.
+, and then click on the ``Display'' tab.
\end_layout
\begin_deeper
@@ -1547,8 +1568,8 @@
\end_deeper
\begin_layout Enumerate
-You finish by clicking on the drop down list to the right of ``Color by''
- and selecting ``Point StrainRateInvariantField.''
+Finish by clicking on the drop down list to the right of ``Color by'' and
+ selecting ``Point StrainRateInvariantField.''
\end_layout
\begin_deeper
@@ -1579,7 +1600,7 @@
\end_deeper
\begin_layout Enumerate
-The last thing to look at is the particles.
+Now look at the particles.
Starting over, open
\family typewriter
\color none
@@ -1722,8 +1743,7 @@
PlotGaleOutput
\end_layout
-\end_deeper
-\begin_layout Standard
+\begin_layout Enumerate
Using Octave to visualize the 10th step of
\family typewriter
input/extension.xml
@@ -1731,6 +1751,7 @@
results in
\end_layout
+\begin_deeper
\begin_layout Standard
\begin_inset Graphics
filename images/Octave_fig1.png
@@ -1766,10 +1787,12 @@
\end_layout
-\begin_layout Standard
+\end_deeper
+\begin_layout Enumerate
Using Matlab results in
\end_layout
+\begin_deeper
\begin_layout Standard
\begin_inset Graphics
filename images/Matlab_fig111.png
@@ -1792,6 +1815,8 @@
\end_layout
+\end_deeper
+\end_deeper
\begin_layout Subsection
Visualization with Excel
\end_layout
@@ -2023,6 +2048,10 @@
\end_layout
+\begin_layout Section
+Introduction
+\end_layout
+
\begin_layout Standard
In this chapter, you will edit a template file (
\family typewriter
@@ -2031,13 +2060,17 @@
) to create customized input files.
You should be able to use the template file as a basis for most of your
own input files.
- The two things that might need modification are that the force of gravity
- is set to 1, and the normal velocities on all boundaries except the top
- are set to zero.
+ There are two things in the template file, however, that might need modificatio
+n: the force of gravity, which by default is set to 1, and the normal velocities
+ on all boundaries except the top, which are set to zero.
Beyond that, you only need to add where different materials are placed
initially.
\end_layout
+\begin_layout Subsection
+Adding Lines to the Template File
+\end_layout
+
\begin_layout Standard
Unless otherwise specified, when you are instructed to add something
\begin_inset Foot
@@ -2074,6 +2107,10 @@
in the middle of another component, although indentation is not critical.
\end_layout
+\begin_layout Subsection
+Adding Variables to the Template File
+\end_layout
+
\begin_layout Standard
When you are instructed to add a variable, you must add it at the end of
the file before the closing line
@@ -2084,7 +2121,7 @@
\end_layout
\begin_layout Standard
-Finished versions of all of these examples are in
+Finished versions of all of these examples are found` in
\family typewriter
input/cookbook
\family default
@@ -2101,7 +2138,7 @@
\end_layout
\begin_layout Standard
-This example just fills up the computational domain with a single viscous
+This example simply fills up the computational domain with a single viscous
material.
\end_layout
@@ -2289,7 +2326,7 @@
In this example, you will make the material extend by having the right
boundary move.
This simple model is the basis for many problems of current interest involving
- lithospheric and crustal extension.
+ lithospheric and crustal extensions.
\end_layout
\begin_layout Enumerate
@@ -2466,7 +2503,7 @@
\end_inset
-Strain rate invariant and velocities of viscous material in extension.
+Strain rate invariant and velocities of viscous material in extension
\end_layout
\end_inset
@@ -2657,7 +2694,7 @@
Warning:
\series default
\color none
-Do not add it in the list named
+Do not add them in the list named
\family typewriter
``variables
\family default
@@ -2856,7 +2893,7 @@
\begin_layout Standard
and add the variables at the end of the file (just before
\family typewriter
-</StGermain/Data>
+</StGermainData>
\family default
)
\end_layout
@@ -2979,14 +3016,15 @@
Normally, Gale looks at nearby particles and replicates them.
However, nearby material has already changed a little from the boundary,
so replicating them will not give the new particles the correct properties.
-\newline
-To
- fix that, create a thin layer next to the boundary where material is created
- anew.
+\end_layout
+
+\begin_deeper
+\begin_layout Standard
+To fix that, create a thin layer next to the boundary where material is
+ created anew.
To do that, first create this shape
\end_layout
-\begin_deeper
\begin_layout LyX-Code
<struct name="leftBoundaryShape">
\end_layout
@@ -3092,7 +3130,7 @@
\end_inset
-Strain rate invariant and velocities with inflow/outflow boundaries.
+Strain rate invariant and velocities with inflow/outflow boundaries
\end_layout
\end_inset
@@ -3716,7 +3754,7 @@
\end_inset
-Strain rate invariant and velocities with multiple viscous materials.
+Strain rate invariant and velocities with multiple viscous materials
\end_layout
\end_inset
@@ -4018,7 +4056,7 @@
\end_inset
-Strain rate invariant and velocities of yielding material in extension.
+Strain rate invariant and velocities of yielding material in extension
\end_layout
\end_inset
Modified: long/3D/Gale/trunk/documentation/gale.pdf
===================================================================
(Binary files differ)
More information about the cig-commits
mailing list