diff --git a/doc/handbook/0_dumux-handbook.tex b/doc/handbook/0_dumux-handbook.tex index 72b3a0c3108345b0dd45ffbf09f74e131ed00506..ed9e3ee8c7c04729c6c3b3c4d647abf6bba27557 100644 --- a/doc/handbook/0_dumux-handbook.tex +++ b/doc/handbook/0_dumux-handbook.tex @@ -115,7 +115,7 @@ your first \Dumux experience, including an install script with all necessary ins on how to very quickly install the latest release version of \Dumux. You should have a recent working Linux environment. If you need more information, please have a look at the detailed installation -instructions in the next chapter \ref{detailed-install}. +instructions in chapter \ref{detailed-install}. \input{2_quickinstall} \chapter{Detailed Installation, Documentation, and Externals}\label{detailed-install} diff --git a/doc/handbook/1_introduction.tex b/doc/handbook/1_introduction.tex index 7c1b42b8b6dd468d743fc42c987cc2227086828f..4dfd1ed2d807784dcfe0f30e9ad5b13590c5c63d 100644 --- a/doc/handbook/1_introduction.tex +++ b/doc/handbook/1_introduction.tex @@ -66,7 +66,7 @@ solving the generated systems. \Dumux comes in form of an additional module \texttt{dumux}. It depends on the \Dune core modules -\texttt{dune-common}, \texttt{dune-grid}, \texttt{dune-istl}, and \texttt{dune-localfunctions}. +\texttt{dune-common},\texttt{dune-geometry}, \texttt{dune-grid}, \texttt{dune-istl}, and \texttt{dune-localfunctions}. The main intention of \Dumux is to provide a framework for an easy and efficient implementation of new physical models for porous media flow problems, ranging from problem formulation and the selection of @@ -82,4 +82,4 @@ helping to update programs from version 3.0 to version 3.1, and giving an overvi It is available online: \url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/CHANGELOG.md}. We highly recommend all our users to transition with us to the most recent version of \Dumux -and wish everyone a brand-new and exciting simulation experience. +and wish everyone an exciting simulation experience. diff --git a/doc/handbook/2_quickinstall.tex b/doc/handbook/2_quickinstall.tex index 668f22ca4e4c04d96817dc24d0661b9d165d2b46..f829d901010acbdc56963d49bff1435059e7fe12 100644 --- a/doc/handbook/2_quickinstall.tex +++ b/doc/handbook/2_quickinstall.tex @@ -15,8 +15,7 @@ Copy the following lines into a text file named \texttt{installDumux.sh}: \lstinputlisting[style=DumuxCode, numbersep=5pt, firstline=1, firstnumber=1]{installDumux.sh} Place the \texttt{installDumux.sh} script in the directory where you want to install \Dumux and \Dune (a single -root folder \texttt{DUMUX} will be produced, so you do not need to provide one). -Run the script by typing into the terminal: \texttt{./installDumux.sh} +root folder \texttt{DUMUX} will be produced, so you do not need to provide one). Make \texttt{installDumux.sh} executable and run the script by typing into the terminal: \texttt{./installDumux.sh} Configuring \Dune and \Dumux is done by the command-line script \texttt{dunecontrol} using optimized configure options, see the line entitled \texttt{\# run build} in the \texttt{installDumux.sh} script. @@ -33,7 +32,7 @@ make -B test_1p_tpfa ./test_1p_tpfa params.input paraview *pvd \end{lstlisting} -The script \texttt{test\_dumux.sh} can be executed by typing into the terminal: \texttt{./test\_dumux.sh}. +After making \texttt{test\_dumux.sh} executable, it can be executed by typing into the terminal: \texttt{./test\_dumux.sh}. If everything works fine, a ParaView window with the result should open automatically, showing the initial -conditions. Advance ParaView to the next frame (green arrow button) and rescale to data range to admire +conditions. Advance ParaView to the next frame (green arrow button) and rescale to data range (green double arrow on top right) to admire the colorful pressure distribution. diff --git a/doc/handbook/3_detailedinstall.tex b/doc/handbook/3_detailedinstall.tex index f3d73ca50dd405fa3bb51886b0e1b3eaeb1e57b2..a4858e078e2b85b3def0039727944eb202732b6e 100644 --- a/doc/handbook/3_detailedinstall.tex +++ b/doc/handbook/3_detailedinstall.tex @@ -132,7 +132,7 @@ on the Dune grid interface, act similar. % $ path -p0 -R < ../dumux/patches/grid-2.3.1.patch % \end{lstlisting} -\section{Build of \Dune and \Dumux} +\section{Building \Dune and \Dumux} \label{buildIt} Configuring \Dune and \Dumux is done by the shell-command \texttt{dunecontrol} which is part of the \Dune build system. If you are interested in more details about the build system that is used, @@ -150,7 +150,7 @@ $ # make sure you are in the common root directory $ ./dune-common/bin/dunecontrol --configure-opts="CXXFLAGS=-fno-strict-aliasing" --use-cmake all \end{lstlisting} -Too many options can make life hard. That's why usually option files are being used together with \texttt{dunecontrol} and its sub-tools. +Too many options within the command line can make life hard. That's why usually option files are being used together with \texttt{dunecontrol} and its sub-tools. Larger sets of options are kept in them. If you are going to compile with modified options, the following can be a starting point: \begin{lstlisting}[style=Bash] @@ -179,7 +179,7 @@ All executables are compiled in the \texttt{build} sub-directories of \Dumux. If not specified differently in the options file, this is \texttt{build-cmake} as default. \begin{enumerate} -\item Enter the folder \texttt{porousmediumflow/2p/implicit/incompressible}.\\ Type \texttt{make test{\_}2p{\_}incompressible{\_}tpfa} +\item Enter the folder \texttt{test/porousmediumflow/2p/implicit/incompressible} within your build directory.\\ Type \texttt{make test{\_}2p{\_}incompressible{\_}tpfa} in order to compile the application\\\texttt{test{\_}2p{\_}incompressible{\_}tpfa}. To run the simulation, type \texttt{./test{\_}2p{\_}incompressible{\_}tpfa params.input} into the console. @@ -192,21 +192,21 @@ If not specified differently in the options file, this is \texttt{build-cmake} a files. It is possible to stop a running application by pressing $<$Ctrl$><$c$>$. \item You can display the results using the visualization tool ParaView (or alternatively VisIt). Just type \texttt{paraview} in the console and open the - PVD file. On the left hand side, you can choose the desired parameter to be displayed. + PVD file. On the upper left hand side, you can choose the desired parameter to be displayed. \end{enumerate} \section{Building Documentation} \label{sec:build-doc} -The building of included documentation like this handbook requires \LaTeX{} and auxiliary tools +Building the included documentation like this handbook requires \LaTeX{} and the auxiliary tool \texttt{bibtex}. One usually chooses a \LaTeX{} distribution like \texttt{texlive} for this purpose. -It is possible to switch off the building of the documentation by setting the switch \texttt{--disable-documentation} +It is possible to switch off building the documentation by setting the switch \texttt{--disable-documentation} in the \texttt{CONFIGURE\_FLAGS} of the building options, see section \ref{buildIt}. \subsection{Doxygen} \label{sec:build-doxy-doc} Doxygen documentation is done by specifically formatted comments integrated in the source code, which can get extracted by the program \texttt{doxygen}. Beside extracting these comments, -\texttt{doxygen} builds up a web-browsable code structure documentation +\texttt{doxygen} builds up a web-browsable code-structure documentation like class hierarchy of code displayed as graphs, see \url{http://www.stack.nl/~dimitri/doxygen/}. The Doxygen documentation of a module can be built if \texttt{doxygen} is installed, diff --git a/doc/handbook/installDumux.sh b/doc/handbook/installDumux.sh index 60295e5089cdf053438b69d0578a55c9b8df123f..fe06600aa2eb76805ee94991995be912093c5f90 100644 --- a/doc/handbook/installDumux.sh +++ b/doc/handbook/installDumux.sh @@ -14,7 +14,7 @@ for MOD in common geometry grid localfunctions istl; do done # dumux -git clone -b releases/3.0 https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git +git clone -b releases/3.1 https://git.iws.uni-stuttgart.de/dumux-repositories/dumux.git if [ $? -ne 0 ]; then echo "*************************************************"