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

[tan2 at geodynamics.org]

Author: tan2
Date: 2009-06-15 10:55:13 -0700 (Mon, 15 Jun 2009)
New Revision: 15266

Modified:
   doc/CitcomS/manual/citcoms.lyx
Log:
Added instruction for configureing with ggrd

Modified: doc/CitcomS/manual/citcoms.lyx
===================================================================
--- doc/CitcomS/manual/citcoms.lyx	2009-06-15 17:38:50 UTC (rev 15265)
+++ doc/CitcomS/manual/citcoms.lyx	2009-06-15 17:55:13 UTC (rev 15266)
@@ -1,4 +1,4 @@
-#LyX 1.5.1 created this file. For more info see http://www.lyx.org/
+#LyX 1.5.5 created this file. For more info see http://www.lyx.org/
 \lyxformat 276
 \begin_document
 \begin_header
@@ -660,7 +660,7 @@
  Also, the norms of div(u), u, and p are no longer dependent on the grid
  size; Adding self-gravitational effect on geoid and adding Consistent-Boundary-
 Flux (CBF) method to compute dynamic topography, contributed by Shijie Zhong;
- Adding GMT/netcdf grd input for surface velocity boundary conditions, initial
+ Adding GMT/NetCDF grd input for surface velocity boundary conditions, initial
  temperature, material dependence and local Rayleigh number in surface layers,
  contributed by Thorsten Becker; Adding capability to read in time- and
  geographic-dependent, top surface temperature boundary conditions, contributed
@@ -2687,7 +2687,7 @@
 \noindent
 \align center
 \begin_inset Tabular
-<lyxtabular version="3" rows="6" columns="2">
+<lyxtabular version="3" rows="7" columns="2">
 <features>
 <column alignment="center" valignment="top" leftline="true" width="1in">
 <column alignment="left" valignment="top" leftline="true" rightline="true" width="3.5in">
@@ -2871,7 +2871,7 @@
 \end_inset
 </cell>
 </row>
-<row topline="true" bottomline="true">
+<row topline="true">
 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 \begin_inset Text
 
@@ -2885,7 +2885,7 @@
 \begin_inset Text
 
 \begin_layout Standard
-linker flags; e.g., 
+Linker flags; e.g., 
 \family typewriter
 -L<dir>
 \family default
@@ -2895,6 +2895,26 @@
 \end_inset
 </cell>
 </row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+LIBS
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+Library flags; e.g., -l<lib> if additional library is needed
+\end_layout
+
+\end_inset
+</cell>
+</row>
 </lyxtabular>
 
 \end_inset
@@ -3375,6 +3395,68 @@
 \end_layout
 
 \begin_layout Section
+GGRD Configuration (Optional)
+\end_layout
+
+\begin_layout Standard
+CitcomS can read data from files for initial temperature, boundary conditions,
+ material control and others.
+ By default, these files are in ASCII format, and the data in the files
+ must be ordered in the same way of the node ordering.
+ As a result, whenever the mesh is changed, these data files need to be
+ regenerated to satisfy the ordering requirement.
+ This restriction can be lifted if using GRD data files.
+ GRD files are binary files in NetCDF format (Network Common Data Form).
+ GRD files are widely used in GMT (Generic Mapping Tools) as well.
+\end_layout
+
+\begin_layout Standard
+The GRD file support can be enabled at configuration time.
+ It requires the installation of HC package (
+\begin_inset LatexCommand url
+name "HC homepage"
+target "http://www.geodynamics.org/cig/software/packages/mc/hc"
+
+\end_inset
+
+), a 1-D global mantle circulation solver which can compute velocities,
+ tractions, and geoid for simple density distributions and plate velocities.
+ To install HC, you will also need the GMT and NetCDF packages (library
+ and header files).
+ See the 
+\family typewriter
+README.TXT
+\family default
+ file in HC for instructions of installation.
+ After HC is installed, mark the directory (for example: 
+\family typewriter
+$HOME/cig/HC-1_0
+\family default
+) of HC installation, and executing these commands:
+\end_layout
+
+\begin_layout LyX-Code
+$ export HC_HOME=$HOME/cig/HC-1_0
+\end_layout
+
+\begin_layout LyX-Code
+$ ./configure --with-ggrd
+\end_layout
+
+\begin_layout Standard
+You may need to set 
+\family typewriter
+GMTHOME
+\family default
+ and 
+\family typewriter
+NETCDFHOME
+\family default
+ environment variables if these packages is not installed in the system
+ directory.
+\end_layout
+
+\begin_layout Section
 \begin_inset LatexCommand label
 name "sec:Batch-System-Configuration"