Commit caada348 authored by Beatrix Becker's avatar Beatrix Becker
Browse files

[handbook] cleanup, add tag 3.0.0-alpha, add TODOs

parent 2353135c
......@@ -41,7 +41,7 @@
% Dune and Dumux logo
\newcommand{\Dune}{{DUNE}\xspace}
\newcommand{\Dumux}{\texorpdfstring{Du\-Mu$^\text{x}$\xspace}{DuMuX\xspace}}
\newcommand{\DumuxVersion}{3.0-alpha}
\newcommand{\DumuxVersion}{3.0}
\definecolor{dumuxYellow}{HTML}{E19417}
\definecolor{dumuxBlue}{HTML}{0C73CF}
......
......@@ -32,6 +32,8 @@ in the root directory of the respective module. This should not be changed by th
Two possibilities exist to get the source code of \Dune and \Dumux.
Firstly, \Dune and \Dumux can be downloaded as tar files from the respective \Dune and \Dumux website.
They have to be extracted as described in the next paragraph.
% TODO: alpha version was not released with a tarball. For the next releases the following lines need to be deleted again
There is no tar file for the current \DumuxVersion~release.
Secondly, a method to obtain the most recent source code (or, more generally, any of its previous revisions) by direct access
to the software repositories of the revision control system is described in the subsequent part.
Be aware that you cannot get \texttt{dumux-devel} or the external libraries from \texttt{dumux-external} unless
......@@ -40,34 +42,35 @@ you have an GitLab account with the right privileges.
In section \ref{sec:prerequisites} we list some prerequisites for running \Dune and \Dumux.
Please check in said paragraph whether you can fulfill them before continuing.
\paragraph{Obtaining the software by installing tar files}
The slightly old-fashionedly 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.5) and \Dumux websites
to a certain folder in your file system.
Create the common root directory, named \texttt{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 subdirectory is \texttt{dumux-\DumuxVersion}
(or whatever version you downloaded).
\begin{lstlisting}[style=Bash]
$ mkdir DUMUX
$ cd DUMUX
$ tar xzvf path_to_tarball_of/dune-common-2.5.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-geometry-2.5.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-grid-2.5.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-istl-2.5.0.tar.gz
$ tar xzvf path_to_tarball_of/dune-localfunctions-2.5.0.tar.gz
$ tar xzvf path_to_tarball_of/dumux-3.0-alpha.tar.gz
\end{lstlisting}
Furthermore, if you wish to install the optional \Dune Grid-Howto which provides a tutorial
on the Dune grid interface, act similar.
% TODO: alpha version was not released with a tarball. For the next releases the following lines need to be uncommented again
% \paragraph{Obtaining the software by installing tar files}
% The slightly old-fashionedly 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.5) and \Dumux websites
% to a certain folder in your file system.
% Create the common root directory, named \texttt{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 subdirectory is \texttt{dumux-\DumuxVersion}
% (or whatever version you downloaded).
%
% \begin{lstlisting}[style=Bash]
% $ mkdir DUMUX
% $ cd DUMUX
% $ tar xzvf path_to_tarball_of/dune-common-2.5.0.tar.gz
% $ tar xzvf path_to_tarball_of/dune-geometry-2.5.0.tar.gz
% $ tar xzvf path_to_tarball_of/dune-grid-2.5.0.tar.gz
% $ tar xzvf path_to_tarball_of/dune-istl-2.5.0.tar.gz
% $ tar xzvf path_to_tarball_of/dune-localfunctions-2.5.0.tar.gz
% $ tar xzvf path_to_tarball_of/dumux-3.0-alpha.tar.gz
% \end{lstlisting}
%
% Furthermore, if you wish to install the optional \Dune Grid-Howto which provides a tutorial
% on the Dune grid interface, act similar.
\paragraph{Obtaining \Dune and \Dumux from software repositories}
Direct access to a software revision control system for downloading code can be of advantage later on.
......@@ -95,7 +98,7 @@ $ git clone -b releases/2.5 https://gitlab.dune-project.org/core/dune-geometry.g
$ git clone -b releases/2.5 https://gitlab.dune-project.org/core/dune-grid.git
$ git clone -b releases/2.5 https://gitlab.dune-project.org/core/dune-istl.git
$ git clone -b releases/2.5 https://gitlab.dune-project.org/core/dune-localfunctions.git
$ git clone -b releases/3.0-alpha https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git
$ git clone -b 3.0.0-alpha https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git
\end{lstlisting}
The newest and maybe unstable developments of \Dune and \Dumux are also provided in these repositories and can be found in the \emph{master} branch.
......
......@@ -17,8 +17,8 @@ of the DGF format and some examples can be found in the \Dune doxygen documentat
complex DGF files, we recommend to write your own scripts, e.g in \Cplusplus, Matlab or Python.
The DGF format can also used to read in spatial parameters defined on the grid. These parameters can
be defined on nodes as well as on the elements. An example for predefined parameters on a grid is
the \texttt{test\_boxco2} or \texttt{test\_cco2} in the \texttt{dumux/test/porousmediumflow/co2/implicit/} folder.
be defined on nodes as well as on the elements. An example for predefined parameters on a grid
can be found in the \texttt{dumux/test/porousmediumflow/co2/implicit/} folder.
\subsubsection{Gmsh Mesh Format}
Gmsh is an open-source flexible grid generator for unstructured finite-element meshes (\cite{GEUZAINE2009}, \url{http://geuz.org/gmsh/}).
......@@ -93,8 +93,8 @@ For all available parameters see the Doxygen documentation.
\subsection{Other grid formats and customized grid creators}
Other grid formats than DGF and MSH have to be converted to DGF or MSH to be read into \Dumux. A second possiblity (advanced \Cplusplus) is to write your own
\texttt{GridCreator}. For examples have a look at the \texttt{CubeGridCreator} for a simple and the \texttt{ArtGridCreator} for a more complex example.
It follows a (non-comprehensive) list of hints for some other common grid formats.
\texttt{GridCreator}.
A (non-comprehensive) list of hints for some other common grid formats follows.
\subsubsection{Petrel}
Grids from Petrel (in ASCII format with the extension *.GRDECL) can be imported into \Dumux in two ways:
......@@ -132,3 +132,6 @@ For complex geometries a graphical tool to create grids might be appropriate. On
geometry data is the commercial software \href{http://www.ansys.com/Products/Other+Products/ANSYS+ICEM+CFD/}{ANSYS ICEM
CFD}. A very detailed, but outdated description can be found at the LH2 internal wiki. A more recent best practice guide is available
in dumux-devel at dumux-devel/util/gridconverters/Documentation\_ICEM\_CFD\_create\_mesh.odt. At LH2 exists a script which converts the ICEM mesh into the DGF.
% \subsubsection{Cornerpoint grids}
% TODO
......@@ -17,14 +17,8 @@ point of view.
\subsection{Structure -- by Content}
\label{content}
% by means of this enumerated list, the connection between algorithm and content
% can be achieved by references to the labels of this list.
This list shows the algorithmic outline of a typical \Dumux run. Each item stands
for a characteristic step within the modeling framework.
%\clearpage
In Figure \ref{fig:algorithm}, the algorithmic representations of both approaches, the fully
implicit and the sequential one are illustrated down to the element level.
In Figure \ref{fig:algorithm}, the algorithmic representations of a monolithical
solution solution scheme is illustrated down to the element level.
\begin{figure}[hbt]
% \begin{tabular}{ l | l }
......@@ -71,7 +65,7 @@ implicit and the sequential one are illustrated down to the element level.
%
% &
% TODO: revise
% TODO: revise second figure
% \begin{minipage}[t]{0.48\textwidth}
% \setcounter{thingCounter}{0}
%
......
......@@ -22,11 +22,11 @@ done
# dumux
if [ ! -d "dumux" ]; then
git clone -b releases/3.0-alpha https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git
git clone -b 3.0.0-alpha https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git
else
echo "Skip cloning dumux because the folder already exists."
cd dumux
git checkout releases/3.0-alpha
git checkout 3.0.0-alpha
cd ..
fi
......
Supports Markdown
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