[cig-commits] r4258 - in long/3D/Gale/trunk: . documentation

[walter at geodynamics.org]

Author: walter
Date: 2006-08-10 06:14:52 -0700 (Thu, 10 Aug 2006)
New Revision: 4258

Modified:
   long/3D/Gale/trunk/
   long/3D/Gale/trunk/documentation/gale.lyx
Log:
 r587 at earth:  boo | 2006-08-10 06:12:58 -0700
 Update manual



Property changes on: long/3D/Gale/trunk
___________________________________________________________________
Name: svk:merge
   - 3a629746-de10-0410-b17b-fd6ecaaa963e:/cig:586
   + 3a629746-de10-0410-b17b-fd6ecaaa963e:/cig:587

Modified: long/3D/Gale/trunk/documentation/gale.lyx
===================================================================
--- long/3D/Gale/trunk/documentation/gale.lyx	2006-08-10 13:14:47 UTC (rev 4257)
+++ long/3D/Gale/trunk/documentation/gale.lyx	2006-08-10 13:14:52 UTC (rev 4258)
@@ -82,7 +82,7 @@
 Computational Infrastructure for Geodynamics (CIG) is making this source
  code available to you in the hope that the software will enhance your research
  in geophysics.
- The underlying C code for the finite element package were donated to CIG
+ The underlying C code for the finite element package was donated to CIG
  in July of 2005.
  A number of individuals have contributed a significant portion of their
  careers toward the development of GALE.
@@ -138,7 +138,7 @@
 GALE development is supported by a grant from the National Science Foundation
  to CIG, managed by the Caltech Institute of Technology.
  However, most of the software components below GALE have been developed
- by the Victoria Partnership for Advanced Computing (VPAC).
+ by the Victoria Partnership for Advanced Computing (VPAC) and Monash University.
 \end_layout
 
 \begin_layout Chapter
@@ -181,6 +181,7 @@
 
 \begin_layout Standard
 There are eight basic steps to GALE's computational approach.
+ Note that not all of these steps have been implemented yet.
 \end_layout
 
 \begin_layout Enumerate
@@ -562,10 +563,6 @@
 \end_layout
 
 \begin_layout Standard
-
-\end_layout
-
-\begin_layout Standard
 \begin_inset Float figure
 wide false
 sideways false
@@ -604,15 +601,16 @@
 \end_layout
 
 \begin_layout Standard
-Gale has been written for Unix environments.
+Gale works on a variety of platforms.
  It requires Petsc, MPI, and libxml2 headers and development libraries.
  It also requires Python 2.2.1 or greater to build.
 \end_layout
 
 \begin_layout Standard
 Gale has been tested on workstations running Mac OS X 10.4.6 (G4 and G5),
- RedHat Fedora Core 5 (x86), OpenSuse 10.0 (x86), Gentoo (x86), Debian stable
- (x86 and AMD64), testing (x86) and unstable (x86).
+ Windows 2000 and XP SP2, RedHat Fedora Core 5 (x86), OpenSuse 10.0 (x86),
+ Gentoo (x86), Debian stable (x86 and AMD64), testing (x86) and unstable
+ (x86).
  Gale has also been tested on clusters running Redhat 7.2 (x86) and RedHat
  Enterprise Linux 3 (EM64T).
 \end_layout
@@ -665,8 +663,8 @@
 
 \begin_layout Standard
 Installation instructions are available in the tarball in the file INSTALL.
- For some platforms (Mac OS X, RedHat Fedora Core 5, OpenSuse 10.0, Debian
- stable, testing, and unstable) there are platform specific installation
+ For some platforms (Mac OS X, Windows, RedHat Fedora Core 5, OpenSuse 10.0,
+ Debian stable, testing, and unstable) there are platform specific installation
  instructions.
  Generally, the hardest part is not installing Gale itself, but Petsc.
 \end_layout
@@ -736,7 +734,12 @@
 \end_layout
 
 \begin_layout Standard
-This should run for 500 time steps and then exit.
+This should run for 500 time steps and generate a great deal of output in
+ the 
+\family typewriter
+output.sandbox
+\family default
+ directory.
 \end_layout
 
 \begin_layout Section
@@ -754,7 +757,7 @@
 \family default
  in which you will find a number of different output files.
  The default setting is to print once for every time step.
- You can change the frequency of that setting, e.g., have it print more frequently
+ You can change the frequency of that setting, e.g., have it print less frequently
 , by modifying 
 \family typewriter
 simple-extension.xml
@@ -850,23 +853,22 @@
  depends on how the memory is set up.
  Since all particle information is there, which has the material properties,
  we provide a plug-in called DumpSwarm to access that information.
- DumpSwarm is found in the CIG Software Repository at
+ DumpSwarm is found in the source in the directory
 \end_layout
 
 \begin_layout LyX-Code
-/cig/long/3D/Gale/trunk/src/Underworld/plugins/Output/DumpSwarm/
+src/Underworld/plugins/Output/DumpSwarm/
 \end_layout
 
 \begin_layout Standard
 There you can get info about particles; the rest is about the mesh.
- Using 
+ At present, 
 \family typewriter
-DumpSwarm.c
+DumpSwarm
 \family default
- you can find out whether a particular particle has yielded or not.
+ only prints whether a particular particle has yielded or not.
  If you want to print out some other property of the material, e.g., viscosity,
- you can check DumpSwarm which will provide that information in addition
- to whether the particle has yielded.
+ you can modify DumpSwarm to provide that information.
 \end_layout
 
 \begin_layout Section
@@ -874,7 +876,7 @@
 \end_layout
 
 \begin_layout Standard
-gLucifer? OpenDX?
+OpenDX? Mayavi?
 \end_layout
 
 \begin_layout Chapter
@@ -975,11 +977,11 @@
 \end_layout
 
 \begin_layout Standard
-This excerpt is taken from the 
+This excerpt is taken from the file 
 \family typewriter
-MaterialViscosity.c
+src/Underworld/Rheology/src/MaterialViscosity.c
 \family default
- rheology file.
+.
  It has been inherited from the Rheology class and thus possesses a virtual
  method named 
 \family typewriter