[SCM] Gerris Flow Solver branch, upstream, updated. b3aa46814a06c9cb2912790b23916ffb44f1f203
Stephane Popinet
s.popinet at niwa.co.nz
Fri May 15 02:52:10 UTC 2009
The following commit has been merged in the upstream branch:
commit 1a25ccf12dcb347424a7d07439f7da4db0c4936a
Author: Stephane Popinet <s.popinet at niwa.co.nz>
Date: Mon Jul 4 14:11:14 2005 +1000
Updated tutorial
darcs-hash:20050704041114-fbd8f-26676c291c773f8229c93712e45a532e4189761f.gz
diff --git a/doc/tutorial/Makefile.am b/doc/tutorial/Makefile.am
index 1ea48ea..d1f648d 100644
--- a/doc/tutorial/Makefile.am
+++ b/doc/tutorial/Makefile.am
@@ -41,7 +41,7 @@ tutorial.pdf: tutorial1.dvi
/usr/local/grace/bin/xmgrace -noask -hardcopy -hdevice EPS -printfile $@ $<
%.eps: %.fig
- fig2dev -L ps $< > $@ ; ./epsbbox.sh $@
+ fig2dev -L ps $< > $@ ; sh epsbbox.sh $@
%.eps: %.jpeg
convert $< $@.gif
diff --git a/doc/tutorial/tutorial.tex b/doc/tutorial/tutorial.tex
index 6f2b5f1..f3da2b6 100644
--- a/doc/tutorial/tutorial.tex
+++ b/doc/tutorial/tutorial.tex
@@ -90,10 +90,27 @@ compile Gerris from source) type:
\end{verbatim}
In all cases, this will also install the required version of Glib.
+\subsubsection{Which sources?}
+
+When installing from source, you will need to decide which version of
+Gerris you want to install. Installing from the current official
+release (by following the {\em Download Gerris x.x.x} link on the Gerris
+web site) should be safe. If you don't want to wait for official
+releases, you can install more current versions of Gerris by following
+the {\em Gerris snapshot} link. These snapshots are generated
+automatically every night (when the code changes). They are more
+experimental than the official release but are tested both for correct
+compilation and correct execution by runnning the automated
+\htmladdnormallinkfoot{test
+ suite}{\gfsweb/gerris/tests/tests/index.html}. If you
+choose to install from the snapshot, you will also need to install and
+regularly update GTS from the corresponding snapshots on the GTS web
+site.
+
\subsubsection{Installing from source}
\label{build_source}
-If you choose to install everything from source, you will now need to
+If you choose to install everything from source, you will need to
install the {\sc GNU} Triangulated Surface Library ({\sc GTS}). To do
that, go on the \htmladdnormallink{{\sc GTS} web
site}{http://gts.sf.net} and download a recent source file package.
@@ -156,9 +173,7 @@ We are now ready to start. Just to check that everything is okay try:
\subsubsection{Installing from the version control system}
\label{build_darcs}
-If you want to keep up with the most recent version of Gerris without
-having to wait for tarball releases, you will need to install from the
-version control system. This is also the preferred way of installing
+Installing from the version control system is the preferred way of installing
Gerris if you want to change the code and submit changes for inclusion
in the main Gerris distribution. I currently use
\htmladdnormallinkfoot{darcs}{http://abridgegame.org/darcs/}, a very
@@ -200,11 +215,15 @@ If you make changes to the source code and want to record these in darcs type:
% darcs record
\end{verbatim}
-You may also need to track the changes made to the GTS library if they
+You will also need to track the changes made to the GTS library if they
are used by the current version of Gerris. I also use darcs to store
GTS changes. To install GTS just repeat the instructions using {\tt
http://gts.sf.net/darcs/gts-mainline} as source repository.
+Note that whenever you update/re-install GTS, you will need to rebuild
+Gerris. Just changing to the source directory of Gerris and typing
+{\tt make} will rebuild Gerris if GTS has been reinstalled.
+
\subsection{Simulation file}
Gerris is a console-based program. It takes a {\em parameter} or {\em
@@ -448,8 +467,8 @@ the following lines to {\tt vorticity.gfs}:
GfsTime { end = 50 }
GfsRefine 6
GfsInit {} {
- U = { return 0.5 - rand()/(double)RAND_MAX; }
- V = { return 0.5 - rand()/(double)RAND_MAX; }
+ U = (0.5 - rand()/(double)RAND_MAX)
+ V = (0.5 - rand()/(double)RAND_MAX)
}
}
GfsBox {}
@@ -468,7 +487,7 @@ numbers between -0.5 and 0.5.
This is a powerful feature of the parameter file. In most cases where Gerris requires a number (such as the {\tt GfsRefine 6} line, a function of space and time can be used instead. For example, a valid parameter file could include:
\begin{verbatim}
...
- GfsRefine { return 6.*(1. - sqrt (x*x + y*y)); }
+ GfsRefine 6.*(1. - sqrt (x*x + y*y))
...
\end{verbatim}
which would define a mesh refined in concentric circles.
@@ -543,8 +562,8 @@ We now add the following to our simulation file:
GfsTime { end = 50 }
GfsRefine 6
GfsInit {} {
- U = { return 0.5 - rand()/(double)RAND_MAX; }
- V = { return 0.5 - rand()/(double)RAND_MAX; }
+ U = (0.5 - rand()/(double)RAND_MAX)
+ V = (0.5 - rand()/(double)RAND_MAX)
}
GfsOutputTime { istep = 10 } stdout
GfsOutputProjectionStats { istep = 10 } stdout
@@ -638,8 +657,8 @@ We can now use this in our simulation file:
GfsTime { end = 50 }
GfsRefine 6
GfsInit {} {
- U = { return 0.5 - rand()/(double)RAND_MAX; }
- V = { return 0.5 - rand()/(double)RAND_MAX; }
+ U = (0.5 - rand()/(double)RAND_MAX)
+ V = (0.5 - rand()/(double)RAND_MAX)
}
GfsOutputTime { istep = 10 } stdout
GfsOutputProjectionStats { istep = 10 } stdout
@@ -696,8 +715,8 @@ time). We can fix that like this:
GfsTime { end = 50 }
GfsRefine 6
GfsInit {} {
- U = { return 0.5 - rand()/(double)RAND_MAX; }
- V = { return 0.5 - rand()/(double)RAND_MAX; }
+ U = (0.5 - rand()/(double)RAND_MAX)
+ V = (0.5 - rand()/(double)RAND_MAX)
}
GfsOutputTime { istep = 10 } stdout
GfsOutputProjectionStats { istep = 10 } stdout
@@ -1010,8 +1029,13 @@ already installed. You will also need the
\htmladdnormallinkfoot{GtkGlExt}{http://gtkglext.sourceforge.net/}
OpenGL extension to Gtk+.
+If you are running a Debian-based system, you can install these packages using
+\begin{verbatim}
+% apt-get install libgtkglext1-dev
+\end{verbatim}
+
If you then download a recent version of GfsView from the Gerris web
-site and do the now classical:
+site (either an official release or a snapshot) and do the now classical:
\begin{verbatim}
% gunzip gfsview.tar.gz
% tar xvf gfsview.tar
@@ -1355,7 +1379,7 @@ file like this:
GfsTime { end = 9 }
GfsRefine 7
GtsSurfaceFile half-cylinder.gts
- GfsVariableTracer T
+ GfsVariableTracer {} T
...
GfsOutputPPM { step = 0.02 } tracer.ppm {
min = 0 max = 1 v = T
@@ -1804,8 +1828,6 @@ specified in the {\tt read} method of our class.
\section{Running Gerris in parallel}
-\section{Running the test suite}
-
\section{Learning more}
While this tutorial should give you a good overview of Gerris, it is
@@ -1820,6 +1842,8 @@ You should also have a look at the \htmladdnormallinkfoot{Gerris
use Gerris for a range of problems. The parameter files are
cross-linked with the reference manual.
+Another source of more advanced examples is the \htmladdnormallinkfoot{Gerris test suite}{\gfsweb/tests/tests/index.html}.
+
If things are still unclear you can ask for help on the
\htmladdnormallinkfoot{{\tt gfs-users} mailing
list}{\gfsweb/mailinglists.html}. Please note that you
diff --git a/test/euler/template.tex b/test/euler/template.tex
index 9e97f51..8206911 100644
--- a/test/euler/template.tex
+++ b/test/euler/template.tex
@@ -23,7 +23,7 @@
\section{Introduction}
This document is automatically generated from the results obtained
-when running the Gerris test suite. The test suite is ran daily on the
+when running the Gerris test suite. The test suite is run daily on the
current stable branch of the version-controlled source code.
\section{Euler}
--
Gerris Flow Solver
More information about the debian-science-commits
mailing list