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

[tan2 at geodynamics.org]

Author: tan2
Date: 2007-09-28 11:56:39 -0700 (Fri, 28 Sep 2007)
New Revision: 8053

Modified:
   doc/CitcomS/manual/citcoms.lyx
Log:
Update the new features and ascii-gz output

Modified: doc/CitcomS/manual/citcoms.lyx
===================================================================
--- doc/CitcomS/manual/citcoms.lyx	2007-09-28 18:36:33 UTC (rev 8052)
+++ doc/CitcomS/manual/citcoms.lyx	2007-09-28 18:56:39 UTC (rev 8053)
@@ -590,15 +590,18 @@
 This release of CitComS (3.0) contains several new features: (1) two implementati
 ons of compressible convection, one by Wei Leng and Shijie Zhong and the
  other by Eh Tan; (2) the ability to resume computation from previous checkpoint
-s; (3) multi-component chemical convection; (4) compressed ASCII output
- by Thorsten Becker; (5) reading in initial temperature and tracer location
- from GRD files by Thorsten Becker; (6) an exchanger package for solver
- coupling; and (7) fixed non-Newtonian solver.
- Additional changes include: (1) the viscosity field at element level is
- not smoothed (this might slow down the convergence but will represent the
- viscosity field more accurately); (2) the Lenardic filter on temperature
- is disabled by default; (3) use of a better pseudo-random number generator
- to generate initial tracer; (4) and monitoring of maximum temperature.
+s; (3) multi-component chemical convection; (4) fixed non-Newtonian solver;
+ (5) a rheology option for pseudo-plasiticity by Thorsten Becker; (6) compositio
+n dependent viscosity and heat generation by Thorsten Becker; (7) compressed
+ ASCII output by Thorsten Becker; (8) an easier way for mesh refinement
+ for the radial coordinate by Thorsten Becker; (9) an exchanger package
+ for solver coupling; and (10) an option to disable monitoring of maximum
+ temperature.
+ Additional backward imcompatible changes include: (1) the viscosity field
+ at element level is not smoothed (this might slow down the convergence
+ but will represent the viscosity field more accurately); (2) the Lenardic
+ filter on temperature is disabled by default; (3) use of a better pseudo-random
+ number generator to generate initial tracer.
 \end_layout
 
 \begin_layout Section
@@ -2891,8 +2894,8 @@
 \end_inset
 
 .
- After you untar the package, configure and install Exchanger using these
- commands:
+ After you download and untar the package, you can configure and install
+ Exchanger using these commands:
 \end_layout
 
 \begin_layout LyX-Code
@@ -2913,7 +2916,7 @@
 
 \begin_layout Standard
 By default, CitComS will attempt to auto-detect your Exchanger installation
- and will disable HDF5 support if it is not found.
+ and will disable Exchanger support if it is not found.
  You may explicitly specify the location of your Exchanger installation
  by setting the PYTHONPATH environment variable to the appropriate installation
  prefix.
@@ -3860,12 +3863,6 @@
  (1) overrides only the built-in defaults.
 \end_layout
 
-\begin_layout Standard
-\noindent
-\align center
-
-\end_layout
-
 \begin_layout Section
 Uniprocessor Example
 \end_layout
@@ -4407,11 +4404,37 @@
 \end_layout
 
 \begin_layout Standard
-(TODO: ascii-gz output) Be warned that the post-process scripts do not understan
-d this output format.
+The ASCII output can potentially take a lot of disk space.
+ CitComS.py can write 
+\family typewriter
+gzip
+\family default
+ compressed output directly.
+ You can run the example script with:
 \end_layout
 
+\begin_layout LyX-Code
+$ citcoms 
+\family typewriter
+example1.cfg
+\family default
+ --solver.datadir=/home/
+\emph on
+username
+\emph default
+ 
+\backslash
+
+\newline
+--solver.output.output_format=ascii-gz
+\end_layout
+
 \begin_layout Standard
+Be warned that the post-process scripts do not understand this output format
+ yet.
+\end_layout
+
+\begin_layout Standard
 The last choice is the most powerful one.
  Instead of writing many ASCII files, CitComS.py can write its results into
  a single HDF5 (Hierarchical Data Format) file per timestep.