Commit 195673c6 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

adapted handbook to use of Dune 2.1

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/releases/2.0.2@5993 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent b1c2ba69
......@@ -60,7 +60,7 @@ The subversion (svn) software repositories can be accessed with help of a subver
contained in Apache Subversion of version $\geqslant$ 1.6.0 \cite{APACHE-SUBVERSION-HP}.
\subsection{Obtaining source code for \Dune and \Dumux}
As stated before, the \Dumux release 2.0 is based on the \Dune release 2.0, comprising the core modules
As stated before, the \Dumux release 2.0.2 is based on the \Dune release 2.1, comprising the core modules
\texttt{dune-common}, \texttt{dune-grid}, \texttt{dune-istl}, \texttt{dune-localfunctions} and the external dune
module \texttt{dune-pdelab}. Thus, for a proper \Dumux installation these modules are required.
......@@ -76,25 +76,25 @@ of the software revision control system to provide access to different versions
\paragraph{Obtaining the software by installing tar-files}
The slightly old-fashioned named tape-archive-file shortly named tar-file or tarball is a common file format for distributing collections of files contained within these archives.
The extraction from the tar-files is done as follows:
Download the tarballs from the respective \Dune (version 2.0) and \Dumux websites to a certain folder in your file system.
Download the tarballs from the respective \Dune (version 2.1) and \Dumux websites to a certain folder in your file system.
Create the {\Dune} root directory, named DUMUX in the example below. Then extract the content of the tar-files, e.g. with the command-line program \texttt{tar}.
This can be achieved by the following shell commands. Replace \texttt{path\_to\_tarball} with the directory name where the downloaded files are actually located.
After extraction, the actual name of the dumux root directory is \texttt{dumux-2.0}.
After extraction, the actual name of the dumux root directory is \texttt{dumux-2.0.2}.
\begin{lstlisting}[style=Bash]
$ mkdir DUMUX
$ cd DUMUX
$ tar xzvf path_to_tarball_of/dune-common-2.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-grid-2.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-istl-2.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-localfunctions-2.0.tar.gz
$ tar xzvf path_to_tarball_of/dumux-2.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-common-2.1.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-grid-2.1.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-istl-2.1.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-localfunctions-2.1.0.tar.gz
$ tar xzvf path_to_tarball_of/dumux-2.0.2.tar.gz
\end{lstlisting}
Furthermore, if you wish to install the optional \Dune Grid-Howto which provides a tutorial on the Dune grid interface:
\begin{lstlisting}[style=Bash]
$ tar xzvf path_to_tarball_of/dune-grid-howto-2.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-grid-howto-2.1.tar.gz
\end{lstlisting}
However, the required \Dune-module \texttt{dune-pdelab} is not available as tar-file.
......@@ -102,7 +102,7 @@ It can be installed from a software repository via svn.
If \texttt{svn} is available in the command line, it can be done as follows:
\begin{lstlisting}[style=Bash]
$ svn co https://svn.dune-project.org/svn/dune-pdelab/branches/2.0snapshot dune-pdelab
$ svn co https://svn.dune-project.org/svn/dune-pdelab/branches/2.1snapshot dune-pdelab
\end{lstlisting}
\paragraph{Obtaining \Dune and \Dumux from software repositories}
......@@ -121,26 +121,26 @@ The installation procedure is done as follows:
Create a {\Dune} root directory, named DUMUX in the lines below.
Then, enter the previously created directory and check out the desired modules.
As you see below, the check-out uses two different servers for getting the sources, one for \Dune and one for {\Dumux}.
The \Dune modules of the stable 2.0 release are checked out as described on the \Dune website \cite{DUNE-DOWNLOAD-SVN}:
The \Dune modules of the stable 2.1 release are checked out as described on the \Dune website \cite{DUNE-DOWNLOAD-SVN}:
\begin{lstlisting}[style=Bash]
$ mkdir DUMUX
$ cd DUMUX
$ svn co https://svn.dune-project.org/svn/dune-common/releases/2.0 dune-common
$ svn co https://svn.dune-project.org/svn/dune-grid/releases/2.0 dune-grid
$ svn co https://svn.dune-project.org/svn/dune-istl/releases/2.0 dune-istl
$ svn co https://svn.dune-project.org/svn/dune-localfunctions/releases/2.0 dune-localfunctions
$ svn co https://svn.dune-project.org/svn/dune-pdelab/branches/2.0snapshot dune-pdelab
$ svn co https://svn.dune-project.org/svn/dune-common/releases/2.1.0 dune-common
$ svn co https://svn.dune-project.org/svn/dune-grid/releases/2.1.0 dune-grid
$ svn co https://svn.dune-project.org/svn/dune-istl/releases/2.1.0 dune-istl
$ svn co https://svn.dune-project.org/svn/dune-localfunctions/releases/2.1.0 dune-localfunctions
$ svn co https://svn.dune-project.org/svn/dune-pdelab/branches/2.1snapshot dune-pdelab
\end{lstlisting}
The newest (unstable) developments are also provided in these repositories, usually in a folder called ``trunk''. Please check the \Dune website \cite{DUNE-DOWNLOAD-SVN} for further information. However, the current \Dumux release is based on the stable 2.0 release and it will not compile without further adaptations using the the newest versions of \Dune.
The newest (unstable) developments are also provided in these repositories, usually in a folder called ``trunk''. Please check the \Dune website \cite{DUNE-DOWNLOAD-SVN} for further information. However, the current \Dumux release is based on the stable 2.1 release and it probably will not compile without further adaptations using the the newest versions of \Dune.
The additional module \texttt{dune-grid-howto} is a tutorial which provides information about the \Dune grid interface.
It may give you an idea how some abstractions in \Dune are done.
The \texttt{dune-grid-howto} is not required by \Dumux, the installation is optional. It is done by:
\begin{lstlisting}[style=Bash]
$ svn co https://svn.dune-project.org/svn/dune-grid-howto/releases/2.0 dune-grid-howto
$ svn co https://svn.dune-project.org/svn/dune-grid-howto/releases/2.1.0 dune-grid-howto
\end{lstlisting}
The \texttt{dumux} module is checked out as described below (see also the \Dumux website \cite{DUMUX-HP}).
......@@ -238,7 +238,7 @@ Too many options can make life hard, that's why usually option-files are being u
Larger sets of options are kept in them. If you are going to compile with options suited for debugging of the code, the following
can be a starting point:
%Below in command-line make sure to insert the right name of dumux' root directory, which is in case of installation from tar-files \texttt{dumux-2.0} or in case of installation from subversion just \texttt{dumux}. For a developer it is also possible to take options file from \texttt{dumux-devel}.
%Below in command-line make sure to insert the right name of dumux' root directory, which is in case of installation from tar-files \texttt{dumux-2.0.2} or in case of installation from subversion just \texttt{dumux}. For a developer it is also possible to take options file from \texttt{dumux-devel}.
\begin{lstlisting}[style=Bash]
$ # make sure you are in the directory DUNE-Root
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment