[SCM] Gerris Flow Solver branch, upstream, updated. b3aa46814a06c9cb2912790b23916ffb44f1f203

[Stephane Popinet]

The following commit has been merged in the upstream branch:
commit a94b5ce60723a4d46194d68231dfc48e7606a5ca
Author: Stephane Popinet <popinet at users.sf.net>
Date:   Thu Jun 30 19:46:27 2005 +1000

    Updated reference manual
    
    darcs-hash:20050630094627-d4795-d4f61db100d1e698efd11b1f0a93b88559aed629.gz

diff --git a/doc/tmpl/init.sgml b/doc/tmpl/init.sgml
index 5348735..0964aed 100644
--- a/doc/tmpl/init.sgml
+++ b/doc/tmpl/init.sgml
@@ -6,7 +6,7 @@ Used for initial conditions
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-GfsInit can be used to set initial conditions for each primitive variable. The initial conditions can be either constants or functions of space.
+GfsInit can be used to set initial conditions for a set of variables. The initial conditions can be either constants or functions.
 </para>
 <para>
 The syntax in parameter files is as follows:
@@ -17,6 +17,9 @@ The syntax in parameter files is as follows:
 </informalexample>
 where V1, V2, ... are variable names.
 </para>
+<para>
+If the variables do not already exist at the time of initialisation, they are created.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
diff --git a/doc/tmpl/init_vorticity.sgml b/doc/tmpl/init_vorticity.sgml
index 5b7b5a7..1de6578 100644
--- a/doc/tmpl/init_vorticity.sgml
+++ b/doc/tmpl/init_vorticity.sgml
@@ -2,11 +2,22 @@
 Vorticity initialisation
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Initialising 2D velocities from a prescribed vorticity distribution
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+GfsInitVorticity uses the given vorticity distribution to compute a 2D streamfunction and the corresponding velocity field.
+</para>
+<para>
+Due to limitations in the type of boundary conditions for the streamfunction-vorticity equation, the vorticity field given as argument must vanish before reaching the boundaries of the domain.
+</para>
+<para>
+The syntax in parameter files is as follows:
+<informalexample>
+<programlisting>
+[ #GfsGenericInit ] [ #GfsFunction ]
+</programlisting>
+</informalexample>
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
diff --git a/doc/tmpl/output_location.sgml b/doc/tmpl/output_location.sgml
index 544c77e..2a696e0 100644
--- a/doc/tmpl/output_location.sgml
+++ b/doc/tmpl/output_location.sgml
@@ -2,11 +2,11 @@
 Location output
 
 <!-- ##### SECTION Short_Description ##### -->
-Writing the values of variables at a specified location
+Writing the values of variables at specified locations
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-GfsOutputLocation writes the values of all permanent variables at a given location. The first time GfsOutputLocation is called it writes a comment describing the fields being written.
+GfsOutputLocation writes the values of all permanent variables at a set of given locations. The first time GfsOutputLocation is called it writes a comment describing the fields being written.
 </para>
 <para>
 The values are linearly interpolated to the given location using gfs_interpolate().
@@ -20,6 +20,25 @@ The syntax in parameter files is as follows:
 </informalexample>
 where X, Y and Z are the coordinates of the location.
 </para>
+<para>
+or:
+<informalexample>
+<programlisting>
+[ #GfsOutput ] FILE
+</programlisting>
+</informalexample>
+where FILE is the name of a text file containing the space-separated
+X, Y and Z coordinates of a set of locations.
+</para>
+<para>
+or:
+<informalexample>
+<programlisting>
+[ #GfsOutput ] { X1 Y1 Z1 ... XN YN ZN }
+</programlisting>
+</informalexample>
+where the Xi, Yi and Zi are the coordinates of the set of locations.
+</para>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
diff --git a/doc/tmpl/output_simulation.sgml b/doc/tmpl/output_simulation.sgml
index 5587835..cacb034 100644
--- a/doc/tmpl/output_simulation.sgml
+++ b/doc/tmpl/output_simulation.sgml
@@ -34,7 +34,7 @@ with
 
 <row>
 <entry><structfield>binary</structfield></entry>
-<entry>An optional parameter specifying if a binary format should be used. Binary files allow faster reading of simulation files. The default is a more portable ASCII format.</entry>
+<entry>An optional parameter specifying if a binary format should be used. Binary files allow faster reading of simulation files and are the default. Setting binary to 0 will use a more portable ASCII format.</entry>
 </row>
 
 <row>
diff --git a/doc/tmpl/source.sgml b/doc/tmpl/source.sgml
index b9333b0..d9afeed 100644
--- a/doc/tmpl/source.sgml
+++ b/doc/tmpl/source.sgml
@@ -12,7 +12,7 @@ GfsSource is used to associate a source term (possibly a function of space and t
 The syntax in parameter files is as follows:
 <informalexample>
 <programlisting>
-[ #GfsGenericSource ] [ #GfsFunction ]
+[ #GfsSourceGeneric ] [ #GfsFunction ]
 </programlisting>
 </informalexample>
 </para>

-- 
Gerris Flow Solver