[cig-commits] r14218 - doc/cigma/manual
sue at geodynamics.org
sue at geodynamics.org
Tue Mar 3 15:53:15 PST 2009
Date: 2009-03-03 15:53:15 -0800 (Tue, 03 Mar 2009)
New Revision: 14218
fixed double appendix; typos; inserted todos in some prob areas
--- doc/cigma/manual/cigma.lyx 2009-03-03 23:04:24 UTC (rev 14217)
+++ doc/cigma/manual/cigma.lyx 2009-03-03 23:53:15 UTC (rev 14218)
@@ -190,16 +190,6 @@
-\begin_inset CommandInset include
\begin_inset CommandInset bibitem
--- doc/cigma/manual/main2.lyx 2009-03-03 23:04:24 UTC (rev 14217)
+++ doc/cigma/manual/main2.lyx 2009-03-03 23:53:15 UTC (rev 14218)
@@ -43,6 +43,18 @@
+\begin_layout Plain Layout
@@ -77,7 +89,7 @@
Computational Infrastructure for Geodynamics (CIG) is making this source
code available to you in the hope that the software will enhance your research
- This is a brand-new code and at present no papers are published or press.
+ This is a brand-new code and at present no papers are published or in press.
Please cite this manual as follows:
@@ -184,8 +196,8 @@
In this section we discuss how to install each of the software libraries
necessary for building Cigma.
- We recommend that you obtain binaries for these dpendencies from your package
- manager of choice, or from the corresponding website.
+ We recommend that you obtain binaries for these dependencies from your
+ package manager of choice, or from the corresponding website.
When using a package manager, make sure to install the associated development
headers along with the library, as these tend to be distributed separately
from the library package itself.
@@ -344,7 +356,16 @@
-and modifying the comma-delimited list passed to the
+[TODO something wrong with second half of this sentence.
+\begin_inset Quotes eld
+and by modifying
+\begin_inset Quotes erd
+?] and modifying the comma-delimited list passed to the
@@ -361,8 +382,8 @@
the transfer of numerical data between computers.
Cigma depends on the C++ API of the HDF5 library, so it is important to
enable C++ support when running the configure script below.
- We recommend you install the library version 1.8, or higher, due to the
- improved metadata API in those versions.
+ We recommend you install the library version 1.8 or higher, due to the improved
+ metadata API in those versions.
The latest source can be obtained from The HDF Group
\begin_inset Flex URL
@@ -374,7 +395,7 @@
-, and use the following sequence of commands to build the library.
+, and it uses the following sequence of commands to build the library.
@@ -615,8 +636,8 @@
running various internal consistency checks during every build.
You will need this library if you want to modify the Cigma source and want
to make certain guarantees about your additions to the code.
- After obtaining the obtaining the latest source release, you may build
- CppUnit by using the following sequence of steps.
+ After obtaining the latest source release, you may build CppUnit by using
+ the following sequence of steps:
@@ -672,7 +693,7 @@
- For this section, you will need an Subversion client, as well as the GNU
+ For this section, you will need a Subversion client, as well as the GNU
tools Autoconf, Automake, and Libtool.
To check if you have a Subversion client installed, type
@@ -690,7 +711,7 @@
-To check for the presence of the GNU Autotools, use the following commands
+To check for the presence of the GNU Autotools, use the following commands:
@@ -707,7 +728,7 @@
Using the source repository directly is recommended for users who want to
- extend Cigma
+ extend Cigma.
@@ -989,7 +1010,7 @@
can then be replaced by a weighed sum evaluated at a finite set of points.
This integral will be valid up to a certain accuracy.
- In later chapters, we will discuss in more detail how choose the location
+ In later chapters, we will discuss in more detail how to choose the location
and values for the integration points and weights which give optimal accuracy.
@@ -1991,7 +2012,7 @@
-command, and the information
+command, and the information [TODO this sentence does not end]/
@@ -2494,8 +2515,10 @@
-may specify options (M1) and (M2) separately by pointing directly to the
- arrays corresponding to the coordinates and connectivity information.
+[TODO i know you mean the data above to lead in your sentence but how can
+ we refer to it, to make this a real sentence beginning? ] may specify options
+ (M1) and (M2) separately by pointing directly to the arrays corresponding
+ to the coordinates and connectivity information.
The node ordering on the connectivity dataset is described in Appendix
@@ -2796,7 +2819,7 @@
Cigma will accept two kinds of function arguments: (1) an analytic function
chosen from a pre-defined list, or (2) an array of coefficients describing
a finite element field.
- Both of these
+ Both of these [TODO this sentence does not end]
@@ -4362,7 +4385,7 @@
By default it will read and write all information in binary form as HDF5
files, which is format optimal for archiving data with minimal redundancy.
VTK files are also sometimes used by finite element software, due to the
- ease with which the solution fields can be visualize.
+ ease with which the solution fields can be visualized.
Lastly, ExodusII mesh files generated by the CUBIT mesh generation package
can also be used directly as integration meshes.
@@ -4378,8 +4401,8 @@
- allows to add or modify any scalar metadata attributes to any HDF5 group
- or array.
+ allows you to add or modify any scalar metadata attributes to any HDF5
+ group or array.
@@ -4393,9 +4416,10 @@
\begin_inset Float table
\begin_layout Plain Layout
@@ -5902,7 +5926,8 @@
As described in Chapter 4, an integration rule is specified by a list of
points and associated weights.
- The points are given on natural coordinate system of the reference element.
+ The points are given on [TODO - the?] natural coordinate system of the
+ reference element.
\begin_inset Newline newline
@@ -7077,12 +7102,12 @@
- Here will only note that using VTK files is convenient due to the fact
+ Here we will only note that using VTK files is convenient due to the fact
that the mesh is always required by the file format.
You typically only need to provide the file name, and the name of the dataset
inside the file that you wish to use in the comparison operation, although
- if you may safely omit the dataset name if your VTK file contains only
- a single point dataset.
+ you may safely omit the dataset name if your VTK file contains only a single
+ point dataset.
Perhaps one of the most important things to keep in mind, when using VTK
files with the current version of Cigma, is that unstructured datasets
will need to consist of cells of a single type.
@@ -7102,8 +7127,8 @@
numbers as the product of the two dimensions given in the first line, all
separated by whitespace.
These numbers should be formatted as integer or floating point, depending
- on whether you are describing coordinates or coefficients, or whether are
- referring to a connectivity array.
+ on whether you are describing coordinates or coefficients, or whether you
+ are referring to a connectivity array.
More information about the CIG-COMMITS