[cig-commits] r8230 - doc/CitcomS/manual

[tan2 at geodynamics.org]

Author: tan2
Date: 2007-11-07 12:41:30 -0800 (Wed, 07 Nov 2007)
New Revision: 8230

Modified:
   doc/CitcomS/manual/citcoms.lyx
Log:
Document the post-processed opt and surf files. See issue122. Also documented that heating output is element based.

Modified: doc/CitcomS/manual/citcoms.lyx
===================================================================
--- doc/CitcomS/manual/citcoms.lyx	2007-11-07 19:54:56 UTC (rev 8229)
+++ doc/CitcomS/manual/citcoms.lyx	2007-11-07 20:41:30 UTC (rev 8230)
@@ -22184,7 +22184,13 @@
 \end_layout
 
 \begin_layout Section
-Postprocessed Cap Output
+Postprocessed Cap Output (
+\family typewriter
+\size large
+test-case.cap00.10
+\family default
+\size default
+)
 \end_layout
 
 \begin_layout Standard
@@ -22193,11 +22199,7 @@
 autocombine.py
 \family default
  produces 1 cap file for regional CitcomS.py and 12 cap files for the full
- CitcomS.py, e.g., 
-\family typewriter
-test-case.cap00.10
-\family default
-.
+ CitcomS.py.
  The first line of the cap file is a comment describing the node geometry
  (
 \family typewriter
@@ -22229,6 +22231,132 @@
 \end_layout
 
 \begin_layout Section
+Postprocessed Opt Output (
+\family typewriter
+\size large
+test-case.opt00.10
+\family default
+\size default
+)
+\end_layout
+
+\begin_layout Standard
+If the optional output contains node-based fields (e.g., 
+\family typewriter
+comp_nd
+\family default
+, 
+\family typewriter
+pressure
+\family default
+, and 
+\family typewriter
+stress
+\family default
+), the command 
+\family typewriter
+autocombine.py
+\family default
+ produces 1 opt file for regional CitcomS.py and 12 opt files for the full
+ CitcomS.py.
+ The first line of the opt file is a comment describing the node geometry
+ (
+\family typewriter
+nodex
+\family default
+ 
+\begin_inset Formula $\times$
+\end_inset
+
+ 
+\family typewriter
+nodey
+\family default
+ 
+\begin_inset Formula $\times$
+\end_inset
+
+ 
+\family typewriter
+nodez
+\family default
+).
+ The rest of the file is column-based, where the meaning of each column
+ is defined in the corresponding 
+\family typewriter
+.general
+\family default
+ file.
+ For example, if the 
+\family typewriter
+.general
+\family default
+ file contains these two lines, then, the first column in the opt file is
+ the composition, the 2nd column is the pressure, and the last six columns
+ are the stress.
+ 
+\end_layout
+
+\begin_layout LyX-Code
+
+\family typewriter
+field = composition, pressure, stress
+\newline
+structure = scalar, scalar, 6-vector
+\end_layout
+
+\begin_layout Section
+Postprocessed Surf Output (
+\family typewriter
+\size large
+test-case.surf0.10
+\family default
+\size default
+)
+\end_layout
+
+\begin_layout Standard
+An undocumented (and unmaintained) post processing script 
+\family typewriter
+batchsurf.py
+\family default
+ can combine the 
+\family typewriter
+coord
+\family default
+, 
+\family typewriter
+surf
+\family default
+, and 
+\family typewriter
+botm
+\family default
+ output.
+ The format of the combined surf file is listed for completion.
+ The first line of the surf file is a comment describing the node geometry
+ (
+\family typewriter
+nodex
+\family default
+ 
+\begin_inset Formula $\times$
+\end_inset
+
+ 
+\family typewriter
+nodey
+\family default
+).
+ The rest of the file is column-based, where the meaning of each column
+ is: 
+\end_layout
+
+\begin_layout LyX-Code
+colatitude longitude topography heatflux vel_colat vel_lon 
+\end_layout
+
+\begin_layout Section
 Time Output (
 \family typewriter
 \size large
@@ -22794,7 +22922,8 @@
 \end_layout
 
 \begin_layout Standard
-The first two lines of the file are the headers.
+These files contain various heating terms on the element.
+ The first two lines of the file are the headers.
  The rest of the file is column-based, where the meaning of the columns
  is:
 \end_layout