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

[walter at geodynamics.org]

Author: walter
Date: 2006-08-24 17:25:22 -0700 (Thu, 24 Aug 2006)
New Revision: 4430

Modified:
   long/3D/Gale/trunk/
   long/3D/Gale/trunk/documentation/gale.lyx
   long/3D/Gale/trunk/documentation/gale.pdf
Log:
 r700 at earth:  boo | 2006-08-24 17:23:26 -0700
 Update credits in manual and better described DumpSwarm plugin



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

Modified: long/3D/Gale/trunk/documentation/gale.lyx
===================================================================
--- long/3D/Gale/trunk/documentation/gale.lyx	2006-08-24 23:46:45 UTC (rev 4429)
+++ long/3D/Gale/trunk/documentation/gale.lyx	2006-08-25 00:25:22 UTC (rev 4430)
@@ -125,6 +125,8 @@
  The developers are Walter Landry of CIG and Luke Hodkinson of the Victorian
  Partnership for Advanced Computing (VPAC), as well as Louis Moresi's group
  at Monash University.
+ Gus Correa and Robert Bialas from the Lamont-Doherty Earth Observatory
+ provided valuable user testing.
  The GALE team requests that in your oral presentations and in your paper
  acknowledgements that you indicate your use of this code, the authors of
  the code, 
@@ -376,9 +378,8 @@
 \begin_layout Standard
 Walter Landry of CIG and Luke Hodkinson of the Victorian Partnership for
  Advanced Computing (VPAC) are the primary developers of GALE.
- Roger Buck and Robert Bialis of Columbia University and Chris Fuller of
- the University of Washington assisted in making the code useful to geoscientist
-s.
+ Roger Buck, Robert Bialis, and Gus Correa of Columbia University provided
+ valuable user testing.
  
 \begin_inset Float figure
 wide false
@@ -851,41 +852,82 @@
 \end_layout
 
 \begin_layout Standard
-The .txt files exist for the output of DumpSwarm, explained below.
+The .txt files are the output of 
+\family typewriter
+DumpSwarm
+\family default
+, explained below.
 \end_layout
 
 \begin_layout Section
-Using DumpSwarm for Particle Information
+Using 
+\family typewriter
+DumpSwarm
+\family default
+ for Particle Information
 \end_layout
 
 \begin_layout Standard
-Several binary files are found in 
+All of the particle information is output in the materialSwarm.*.dat files.
+ Unfortunately, they are just a binary dump of the particle structures,
+ so their format may vary depends on the machine architecture.
+ To get the particle information in a more friendly format, we provide a
+ plug-in called 
 \family typewriter
-output.sandbox
+DumpSwarm
 \family default
-, but they are not useful to examine.
- While they contain checkpointing, or a dump of the memory, accessing it
- 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 source in the directory
+.
+ The 
+\family typewriter
+DumpSwarm
+\family default
+ plugin is activated by adding the line
 \end_layout
 
 \begin_layout LyX-Code
-src/Underworld/plugins/Output/DumpSwarm/
+    <param>Underworld_DumpSwarm</param> 
 \end_layout
 
 \begin_layout Standard
-There you can get info about particles; the rest is about the mesh.
- At present, 
+to the list of plugins.
+ This line is already in simple-extension.xml.
+ At present, it outputs the files 
 \family typewriter
+yielding.*.txt
+\family default
+.
+ The format of the file is
+\end_layout
+
+\begin_layout LyX-Code
+x y z
+\family typewriter
+ yielded
+\end_layout
+
+\begin_layout Standard
+where yielded is either 
+\family typewriter
+0
+\family default
+ or 
+\family typewriter
+1
+\family default
+ depending on whether that particle has undergone mechanical failure.
+ If you want to print out some other property of the material, e.g., viscosity,
+ you can modify 
+\family typewriter
 DumpSwarm
 \family default
- 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 modify DumpSwarm to provide that information.
+ to provide that information.
+ The source for the plugin is found in the directory
 \end_layout
 
+\begin_layout LyX-Code
+src/Underworld/plugins/Output/DumpSwarm/
+\end_layout
+
 \begin_layout Section
 Postprocessing
 \end_layout

Modified: long/3D/Gale/trunk/documentation/gale.pdf
===================================================================
(Binary files differ)