[cig-commits] r6120 - geodyn/3D/MAG/trunk/doc

sue at geodynamics.org sue at geodynamics.org
Mon Feb 26 16:57:27 PST 2007


Author: sue
Date: 2007-02-26 16:57:27 -0800 (Mon, 26 Feb 2007)
New Revision: 6120

Modified:
   geodyn/3D/MAG/trunk/doc/mag_book.lyx
Log:
some typos and formatting fixes

Modified: geodyn/3D/MAG/trunk/doc/mag_book.lyx
===================================================================
--- geodyn/3D/MAG/trunk/doc/mag_book.lyx	2007-02-26 23:35:58 UTC (rev 6119)
+++ geodyn/3D/MAG/trunk/doc/mag_book.lyx	2007-02-27 00:57:27 UTC (rev 6120)
@@ -85,7 +85,7 @@
 
 \end_inset
 
-
+x
 \end_layout
 
 \begin_layout Standard
@@ -1162,10 +1162,15 @@
 \end_layout
 
 \begin_layout Standard
-Procedure MAGTS.pro and MAGXY.pro take data from l-files generated by MAG
- and creates time series plots and statistics.
+Procedures MAGTS.pro and MAGXY.pro take data from l-files generated by MAG
+ and create time series plots and statistics.
  This version reads an l-file consisting of 17 time series, the first record
- being dimensionless time (see Appendix C for details on output file format).
+ being dimensionless time (see Appendix 
+\begin_inset LatexCommand \ref{cha:MAG-Output-File}
+
+\end_inset
+
+ for details on output file format).
  Energies and rms magnetic field and velocity are scaled as in MAG; tilt
  is dipole vector colatitude; pole longitude is dipole vector longitude.
  Figures 
@@ -1260,24 +1265,16 @@
  produced by MAG.
  This version uses modified IDL color tables and assumes formatted input.
  It creates either postscript .ps or .gif files.
- If other output file formats are required, modification of 
-\begin_inset Quotes sld
-\end_inset
-
-LABELOUT
-\begin_inset Quotes srd
-\end_inset
-
- are required.
- MAGSYM has many plot options: map, closeup, equator, slice...
- etc.
- Producing each plot is straightforward by choosing from the option menu.
+ If other output file formats are required, you must modify ``LABELOUT.''
+ MAGSYM has many plot options: map, closeup, equator, slice, etc.
+ Producing each plot is straightforward and accomplished by choosing from
+ the option menu.
  Figure 
 \begin_inset LatexCommand \ref{fig:IDL-figure-with}
 
 \end_inset
 
-is ploted with the map option.
+is plotted with the map option.
  
 \end_layout
 
@@ -1318,7 +1315,7 @@
 
 \begin_layout Standard
 MAGVOL.pro is another interactive IDL procedure to display volume results
- from rotating convection, magnetoconvection & dynamo calculations (written
+ from rotating convection, magnetoconvection and dynamo calculations (written
  by P.
  Olson).
  It uses G-FILES produced by MAG (some longitudinal symmetry may be assumed
@@ -1459,7 +1456,7 @@
 \begin_inset Formula $E,$
 \end_inset
 
- ie 
+ i.e., 
 \begin_inset Formula $Ra=Ra$
 \end_inset
 
@@ -1483,19 +1480,44 @@
 \begin_inset Formula $lmax=32$
 \end_inset
 
- and a four-fold symmetry is assumed in the longitudinal direction (param.f
- should be linked to param32s4.f when compile MAG).
- The input parameter files are par.bench0 for case 0 and par.bench1 in case
- 1, both files resides in ~/src directory.
+ and a four-fold symmetry is assumed in the longitudinal direction (
+\family typewriter
+param.f
+\family default
+ should be linked to 
+\family typewriter
+param32s4.f
+\family default
+ when you compile MAG).
+ The input parameter files are 
+\family typewriter
+par.bench0
+\family default
+ for case 0 and 
+\family typewriter
+par.bench1
+\family default
+ in case 1; both files reside in the 
+\family typewriter
+~/src
+\family default
+ directory.
 \end_layout
 
 \begin_layout Standard
-The output files of the benchmark cases are stored in the directory ~/bench-data
-/data_bench0 and ~/bench-data/data-bench1 respectively.
- In the folloing tabel we see the solutions from MAG agree with the benchmark
- suggested value with small differece margin.
+The output files of the benchmark cases are stored in the directory 
+\family typewriter
+~/bench-data/data_bench0
+\family default
+ and 
+\family typewriter
+~/bench-data/data-bench1
+\family default
+ respectively.
+ In the following table we see the solutions from MAG agree with the benchmark
+ suggested value with a small difference margin.
  In both case 0 and case 1, the values listed were obtained with low resolution
- and relatively short run of MAG.
+ and a relatively short run of MAG.
  
 \end_layout
 
@@ -1928,9 +1950,21 @@
 
 \begin_layout Standard
 In this example, we produce a magnetic field reversal using MAG.
- The input parameter for this case in the source directory is ~/src/par.Rev.
- There is no longitudinal symmetry in this case, therefore when compile
- MAG use param32s1.f linking to param.f.
+ The input parameter for this case in the source directory is 
+\family typewriter
+~/src/par.Rev
+\family default
+.
+ There is no longitudinal symmetry in this case, so when you compile MAG,
+ use 
+\family typewriter
+param32s1.f
+\family default
+ linking to 
+\family typewriter
+param.f
+\family default
+.
  The Ekman number is 
 \begin_inset Formula $E=0.02$
 \end_inset
@@ -1944,7 +1978,7 @@
 \end_inset
 
 .
- Rayleigh number is 
+ The Rayleigh number is 
 \begin_inset Formula $Ea=12000$
 \end_inset
 
@@ -1956,23 +1990,23 @@
 \end_layout
 
 \begin_layout Standard
-This case has been ran on 32 bit and 64 bit intel processors.
+This case has run on 32-bit and 64-bit Intel processors.
  Figure 
 \begin_inset LatexCommand \ref{fig:Field-Plot1}
 
 \end_inset
 
- shows a plot of mean velocity Vrms, mean magnetic field Brms, axial dipole
- and dipole tilt on outer boundary.
- It indicated a magnetic field reversal between time 25-30.
+ shows a plot of mean velocity Vrms, mean magnetic field Brms, the axial
+ dipole and the dipole tilt on the outer boundary.
+ It indicated a magnetic field reversal between time steps 25 and 30.
  Figure 
 \begin_inset LatexCommand \ref{fig:Field-Plot2}
 
 \end_inset
 
- shows a longer run of MAG, we see the magnetic field reversed again.
- At this time, magnetic field has weakened substantially.
- On the Figure
+ shows a longer run of MAG, where we see the magnetic field reversed again.
+ At this time, the magnetic field had weakened substantially.
+ In Figure
 \begin_inset LatexCommand \ref{fig:The-pole}
 
 \end_inset
@@ -2492,49 +2526,41 @@
  mpg.pro runs with the following parameters:
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 prefix string(required) A string specifying the prefix of the images to
  read included the path, for example "/home/data/images/Image"
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 suffix string(required) A string specifying the suffix of the images to
  read, for example "jpg".
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 n_start integer(required) An integer specifying the first image in the sequence.
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 n_end integer(required) An integer specifying the last image in the sequence.
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 digits integer(required) An integer specifying the number of digits of the
  number field in the sequence, for example image00001.jpg would require digits=5.
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 dims integer(optional) An integer array specifying the size of the output
  image.
  If not specified the size of the first image is used.
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 format integer(optional) An integer with values 0 for MPEG1 and 1 for MPEG2.
  Default is MPEG1.
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 frame_rate integer(optional) An integer with values.
 \end_layout
 
@@ -2570,14 +2596,12 @@
 8 = 60 frames/sec: double frame rate NTSC
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 mpeg_file string(optional) A string specifying the output MPEG file (default
  outfile.mpg).
 \end_layout
 
-\begin_layout List
-\labelwidthstring 00.00.0000
+\begin_layout Description
 tmp_dir string(optional) A string specifying temporary directory to use
  for the temporary image files.
 \end_layout



More information about the cig-commits mailing list