From 3c12387c90211e3d76e7ebc6bf1fb042a51c60af Mon Sep 17 00:00:00 2001
From: Andreas Lauser <and@poware.org>
Date: Tue, 14 Feb 2012 16:33:33 +0000
Subject: [PATCH] handbook: be a bit more verbose about Dumux::start() in the
coupled tutorial
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7773 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/handbook/tutorial-coupled.tex | 44 ++++++++++++++++++-------------
1 file changed, 25 insertions(+), 19 deletions(-)
diff --git a/doc/handbook/tutorial-coupled.tex b/doc/handbook/tutorial-coupled.tex
index a081d2d9dd..f7d8115fe4 100644
--- a/doc/handbook/tutorial-coupled.tex
+++ b/doc/handbook/tutorial-coupled.tex
@@ -70,13 +70,32 @@ types can be retrieved via the \Dumux property system and only depend
on this single type tag. For a more thourough introduction to the
\Dumux property system, see chapter~\ref{sec:propertysystem}.
-After this \Dumux' default startup routine is called on line
-\ref{tutorial-coupled:call-start}. To provide an error message, the
-usage message which is displayed to the user if the simulation is
-called incorrectly, is printed via the custom function which is defined
-on line~\ref{tutorial-coupled:usage-function}.
+After this \Dumux' default startup routine \texttt{Dumux::start()} is
+called on line \ref{tutorial-coupled:call-start}. This function deals
+with parsing the command line arguments, reading the parameter file,
+setting up the infrastructure necessary for \Dune, loads the grid, and
+starts the simulation. When it comes to parameters, all parameters can
+be either specified by command line arguments of the form
+(\texttt{-ParameterName ParameterValue}), in the file specified by the
+\texttt{-parameterFile} argument, or if the latter is not specified,
+in the file \texttt{tutorial\_coupled.input}. If a parameter gets
+specified on the command line as well as in the parameter file, the
+values provided in the command line have
+precedence. Listing~\ref{tutorial-coupled:parameter-file} shows the
+default parameter file for the tutorial problem.
+
+\begin{lst}[File tutorial/tutorial\_coupled.input]\label{tutorial-coupled:parameter-file} \mbox{}
+\lstinputlisting[basicstyle=\ttfamily\scriptsize,numbers=left,numberstyle=\tiny]{../../tutorial/tutorial_coupled.input}
+\end{lst}
+
+To provide an error message, the usage message which is displayed to
+the user if the simulation is called incorrectly, is printed via the
+custom function which is defined on
+line~\ref{tutorial-coupled:usage-function}. In this function the usage
+message is customized to the problem at hand. This means that at least
+the necessary parameters are listed here. For more information about
+the input file please refer to section \ref{sec:inputFiles}.
-In this function the usage message is customized to the problem at hand. This means that at least the necessary parameters are listed here. For more information about the input file please refer to section \ref{sec:inputFiles}.
\subsection{The Problem Class}
@@ -315,19 +334,6 @@ access / set functions as well as the rest of the implementation of
the material description can be found in
\verb+dumux/material/fluidmatrixinteractions/2p+.
-\subsection{Definition of Run-Time Parameters}\label{tutorial-coupled:runtime-parameters}
-
-Some parameters need to be specified at runtime. These can either be
-specified directly via command line optioms or they can be collected in
-a parameter file. The parameter file which \Dumux uses by default has
-the name of the program with ``.input'' appended. The parameter file
-for the coupled tutorial is thus named \verb+tutorial_coupled.input+
-and has the content shown in listing~\ref{tutorial-coupled:parameter-file}.
-
-\begin{lst}[File tutorial/tutorial\_coupled.input]\label{tutorial-coupled:parameter-file} \mbox{}
-\lstinputlisting[basicstyle=\ttfamily\scriptsize,numbers=left,numberstyle=\tiny]{../../tutorial/tutorial_coupled.input}
-\end{lst}
-
\subsection{Exercises}
\label{tutorial-coupled:exercises}
The following exercises will give you the opportunity to learn how you
--
GitLab