From 6eefd8d02106be3b526cd92e7a0c829932eb5abd Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Fri, 31 Jul 2015 11:36:26 +0000
Subject: [PATCH] [handbook] Remove broken references, white-space changes.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@15208 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/handbook/0_dumux-handbook.tex | 2 +-
doc/handbook/3_tutorialcoupled.tex | 26 ++++++++++----------------
doc/handbook/3_tutorialdecoupled.tex | 14 ++------------
doc/handbook/4_newtoninanutshell.tex | 4 ++--
doc/handbook/5_models.tex | 2 +-
5 files changed, 16 insertions(+), 32 deletions(-)
diff --git a/doc/handbook/0_dumux-handbook.tex b/doc/handbook/0_dumux-handbook.tex
index 575dbb280b..a588d41a8b 100644
--- a/doc/handbook/0_dumux-handbook.tex
+++ b/doc/handbook/0_dumux-handbook.tex
@@ -129,7 +129,7 @@ This chapter provides an overview of the general structure in \Dumux \ref{sc_str
and gives help for basic work with \Dumux
(\ref{sc_newfoldersetup},\ref{sc_parameterfiles},\ref{sc_restartsimulations},\ref{sc_guidelines},\ref{sc_developingdumux}).
Further it present useful external tools \ref{sc_externaltools} and basic
-concepts \ref{sc_newtoninanutshell}.
+concepts \ref{sc_linearsystem}.
\input{4_structure}
\input{4_newfoldersetup}
\input{4_parameterfiles}
diff --git a/doc/handbook/3_tutorialcoupled.tex b/doc/handbook/3_tutorialcoupled.tex
index 3189a9ae33..3e90b0ffd9 100644
--- a/doc/handbook/3_tutorialcoupled.tex
+++ b/doc/handbook/3_tutorialcoupled.tex
@@ -1,4 +1,5 @@
-\section[Fully-Implicit Model]{Solving a Problem Using a Fully-Coupled Model}\label{tutorial-coupled}
+\section[Fully-Implicit Model]{Solving a Problem Using a Fully-Coupled Model}
+\label{tutorial-coupled}
The process of setting up a problem using \Dumux can be roughly divided into four parts:
\begin{enumerate}
@@ -63,7 +64,6 @@ The solved equations are the mass balances of water and oil:
\end{align}
\subsection{The Main File}
-
Listing \ref{tutorial-coupled:mainfile} shows the main application file
\texttt{tutorial/tutorial\_coupled.cc} for the coupled two-phase
model. This file has to be compiled and executed in order to solve the problem described
@@ -109,11 +109,9 @@ custom function which is defined on
line~\ref{tutorial-coupled:usage-function} in the main file.
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}\label{tutorial-coupled:problem}
+\subsection{The Problem Class}
+\label{tutorial-coupled:problem}
When solving a problem using \Dumux, the most important file is the
so-called \textit{problem file} as shown in
listing~\ref{tutorial-coupled:problemfile}.
@@ -194,7 +192,7 @@ available:
discretization. This inhibits the specification of two different
boundary condition types for one equation at one sub-control
volume. Be aware that the second parameter is a Dune grid entity
- with the codimension \texttt{dim}.
+ with the co-dimension \texttt{dim}.
\end{description}
To ensure that no boundaries are undefined, a small safeguard value
@@ -237,8 +235,8 @@ maximum values of each global coordinate of the grid. This method
and the analogous \texttt{bBoxMin()} method are provided by the base
class \texttt{Dumux::BoxProblem<TypeTag>}.
-\subsection{Defining Fluid Properties}\label{tutorial-coupled:description-fluid-class}
-
+\subsection{Defining Fluid Properties}
+\label{tutorial-coupled:description-fluid-class}
The \Dumux distribution includes some common substances which can be
used out of the box. The properties of the pure substances (such as
the components nitrogen, water, or the pseudo-component air) are
@@ -255,8 +253,8 @@ interactions are defined by {\em fluid systems}, which are located in
% In this example, a class for the definition of a two-phase system is used. This allows for the choice
% of the two components oil and water and for access of the parameters that are relevant for the two-phase model.
-\subsection{Defining Spatially Dependent Parameters}\label{tutorial-coupled:description-spatialParameters}
-
+\subsection{Defining Spatially Dependent Parameters}
+\label{tutorial-coupled:description-spatialParameters}
In \Dumux, many properties of the porous medium can depend on the
spatial location. Such properties are the \textit{intrinsic
permeability}, the parameters of the \textit{capillary pressure} and
@@ -597,7 +595,6 @@ initial time-step size of $\unit[100]{s}$. Then, you can compile the program.
\end{itemize}
\subsubsection{Exercise 3: Parameter File Input}
-
As you have experienced, compilation takes quite some time. Therefore,
\Dumux provides a simple method to read in parameters at run-time
via \textit{parameter input files}.
@@ -617,10 +614,9 @@ can be done as shown in the files \texttt{ex3\_tutorialproblem\_coupled.diff}
and \texttt{ex3\_tutorialspatialparams\_coupled.diff} in the \texttt{solutions\_coupled} folder. Add some (for
example \texttt{Newton.MaxSteps} and \texttt{Problem.EnableGravity}) to the
parameter file \texttt{tutorial\_coupled.input} and observe what
-happens if they are modified. For more information about the input file please refer to section \ref{sec:inputFiles}.
+happens if they are modified.
\subsubsection{Exercise 4: Create a New Component}
-
Create a new file for the benzene component called \texttt{benzene.hh}
and implement a new component. (You may get a hint by looking at
existing components in the directory \verb+/dumux/material/components+). \\
@@ -628,9 +624,7 @@ Use benzene as a new fluid and run the model of Exercise 2 with water
and benzene. Benzene has a density of $\unitfrac[889.51]{kg}{m^3}$ and
a viscosity of $\unit[0.00112]{Pa \, s}$.
-
\subsubsection{Exercise 5: Time Dependent Boundary Conditions}
-
In this exercise we want to investigate the influence of time dependent boundary
conditions. For this, redo the steps of exercise 2 and create a new problem and
spatial parameters file.
diff --git a/doc/handbook/3_tutorialdecoupled.tex b/doc/handbook/3_tutorialdecoupled.tex
index 8b91139787..14992c5144 100644
--- a/doc/handbook/3_tutorialdecoupled.tex
+++ b/doc/handbook/3_tutorialdecoupled.tex
@@ -94,8 +94,7 @@ the user if the simulation is called incorrectly, is printed via the
custom function which is defined on
line~\ref{tutorial-decoupled: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}.
+the necessary parameters are listed here.
\subsection{The Problem Class}
\label{decoupled_problem}
@@ -405,7 +404,7 @@ compile the program.
\item Further increase the CFL-factor to 2 and investigate the saturation.
\end{itemize}
-\subsubsection{Exercise 3: Parameter file input.}
+\subsubsection{Exercise 3: Parameter file input}
As you have experienced, compilation takes quite some time. Therefore, \Dumux
provides a simple method to read in parameters (such as simulation end time or
modelling parameters) via \texttt{Paramter Input Files}. The tests in the Test-folder
@@ -436,7 +435,6 @@ and benzene. Benzene has a density of $889.51 \, \text{kg} / \text{m}^3$
and a viscosity of $0.00112 \, \text{Pa} \, \text{s}$.
\subsubsection{Exercise 5: Time Dependent Boundary Conditions}
-
In this exercise we want to investigate the influence of time dependent boundary
conditions. For this, redo the steps of exercise 2 and create a new problem and
spatial parameters file.
@@ -531,10 +529,7 @@ no matter if we model coupled or decoupled. Try to formulate a spatial parameter
file that works with both problems, the coupled and the decoupled. Therein, only
use functions at the position.
-
-
\section{Further Practice}\label{tutorial-furtherpractice}
-
If there is a request for further practice, we refer here to the problems, that are already implemented in \Dumux.
Several examples for coupled and decoupled models can be found in the test-directory.
An overview of the available tests cases can be found ...
@@ -556,8 +551,3 @@ The \Dumux-lecture module can be obtained as follows:
$ # make sure you are in DUMUX-Root
$ svn checkout --username=anonymous --password='' svn://svn.iws.uni-stuttgart.de/DUMUX/dumux-lecture/trunk dumux-lecture
\end{lstlisting}
-
-%%% Local Variables:
-%%% mode: latex
-%%% TeX-master: "dumux-handbook"
-%%% End:
diff --git a/doc/handbook/4_newtoninanutshell.tex b/doc/handbook/4_newtoninanutshell.tex
index 9b5ad11744..a258e99a0c 100644
--- a/doc/handbook/4_newtoninanutshell.tex
+++ b/doc/handbook/4_newtoninanutshell.tex
@@ -1,5 +1,5 @@
-\section{Newton in a Nutshell}
-\label{sc_newtoninanutshell}
+\section{Assembling the linear system}
+\label{sc_linearsystem}
Coming back to the example of chapter \ref{flow} the following mass conservation
equation is to be solved:
diff --git a/doc/handbook/5_models.tex b/doc/handbook/5_models.tex
index 0cfafa8c36..76a39062ca 100644
--- a/doc/handbook/5_models.tex
+++ b/doc/handbook/5_models.tex
@@ -139,7 +139,7 @@ subdirectories of \texttt{dumux/implicit} of the \Dumux distribution.
\subsubsection{Decoupled Models}
\todo{überarbeiten (Christoph)}
The basic idea the so-called decoupled models have in common is to reformulate the
-equations of multi-phase flow (e.g. Eq. \ref{A3:eqmass1}) into one equation for
+equations of multi-phase flow into one equation for
pressure and equations for phase-/component-/etc. transport. The pressure equation
is the sum of the mass balance equations and thus considers the total flow of the
fluid system. The new set of equations is considered as decoupled (or weakly coupled)
--
GitLab