[cig-commits] r6378 - mc/3D/CitcomS/trunk/doc/manual

[tan2 at geodynamics.org]

Author: tan2
Date: 2007-03-23 14:06:06 -0700 (Fri, 23 Mar 2007)
New Revision: 6378

Modified:
   mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
Log:
Added description to the tracer and composition input/output files

Modified: mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
===================================================================
--- mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2007-03-23 21:00:49 UTC (rev 6377)
+++ mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2007-03-23 21:06:06 UTC (rev 6378)
@@ -8997,7 +8997,7 @@
 
 \family typewriter
 \size small
-output_optional="surf,botm"
+output_optional="surf,botm,tracer,comp_el"
 \end_layout
 
 \end_inset
@@ -9042,12 +9042,18 @@
 connectivity
 \family default
 \size default
-, and 
+, 
 \family typewriter
 \size small
-horiz_avg
+horiz_avg, tracer, comp_el
 \family default
 \size default
+ and
+\family typewriter
+\size small
+ comp_nd
+\family default
+\size default
 .
 \end_layout
 
@@ -17369,25 +17375,19 @@
 \end_layout
 
 \begin_layout Standard
-In this version of CitComS.py, the implementation of tracer is neither paralleliz
-ed, nor has it been tested.
- We strongly advise you not to use this feature.
- The format of 
-\family typewriter
-tracer_file
-\family default
- is described here for completion.
- The first line is the number of tracers in the file.
- The rest is the location of the tracers.
- 
+This file contains the initial location of all tracers.
+ The first line is the number of tracers and the number of columns in the
+ file.
+ The first three columns are the coordinates of the tracers.
+ The fourth column, if present, indicates the flavor of the tracers.
 \end_layout
 
 \begin_layout LyX-Code
 
 \series bold
-num_tracers
+num_tracers num_columns
 \newline
-type x y z
+theta phi radius [flavor]
 \end_layout
 
 \begin_layout Chapter
@@ -17919,6 +17919,66 @@
  is the associated Legendre polynomials.
 \end_layout
 
+\begin_layout Subsection
+Tracer Output (
+\family typewriter
+\size normal
+test-case.tracer.0.10
+\family default
+\size default
+)
+\end_layout
+
+\begin_layout Standard
+The first line of the file is a header.
+ The second field in the header is the number of tracers in the file.
+ The third field in the header is the number of columns in the file.
+ The rest of the file is column-based, where the meaning of the columns
+ are:
+\end_layout
+
+\begin_layout LyX-Code
+theta phi radius [flavor]
+\end_layout
+
+\begin_layout Subsection
+Composition Output (
+\family typewriter
+\size normal
+test-case.comp_el.0.10
+\family default
+\size default
+ and 
+\family typewriter
+\size normal
+test-case.comp_nd.0.1
+\family default
+\size default
+)
+\end_layout
+
+\begin_layout Standard
+These files contain the composition field either on the element (
+\family typewriter
+comp_el
+\family default
+) or on the node (
+\family typewriter
+comp_nd
+\family default
+).
+ The format of the files are the same.
+ The first line of the file is a header.
+ The fourth field in the header is the bulk sum of the current composition.
+ The fifth field in the header is the bulk sum of the initial composition.
+ The rest of the file is column-based, where the meaning of the only columns
+ is:
+\end_layout
+
+\begin_layout LyX-Code
+composition
+\end_layout
+
 \begin_layout Section
 HDF5 Output (
 \family typewriter