Commit 3e12df57 authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[handbook]

updated todo list with changes from last meeting
improved the structure of the model section



git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@15190 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 5ab127ce
......@@ -2,9 +2,11 @@
\todo[inline]{Ihr konnt die todo Befehle benutzen um Dinge zu markieren, die euch
auffallen, dann können wir die beim nachsten Mal besprechen}
\section*{Beschlossene ToDos}
DEADLINE: 29.07.15
DEADLINE: 01.09.15
\begin{itemize}
\item Modelle raus, Liste rein (Christoph)
\item steps of dumux simulations - flow chart/Grafik (Gaby + Thomas)
\item Fluidstate/Fluidsystem -$>$ Abstrakte Klassen einführen für doxygen (Natalie)
\item Modelle raus, Liste rein (Christoph, Beatrix)
\item Neues Gitterkapitel (Natalie)
\begin{itemize}
\item gmesh (Timo)
......@@ -13,63 +15,57 @@ DEADLINE: 29.07.15
\item[x] dgf (kurz kommentieren)
\item[x] icemcfd (nicolas)
\end{itemize}
\item Wiki
\begin{itemize}
\item[+] behandla, Mailing list (LH2), external Modules, lectures, tests
teilweise schon erledigt -$>$ Rest (Vishal)
\item[+] Infos fur neue Doktoranden (Christoph)
\end{itemize}
\item Hinweis auf tests, lecture und feature list am Ende von Tutorial
(Gaby)
\item[x] Doxygen (main page - link auf modules, featureList und parameterList)
(Kilian)
\item Newton etwas ausfuhrlicher und Dumux spezifischer, schematische
Skizze der Matrix (Christoph)
\item Rechtschreibung - pdf in word öffnen (?)
\end{itemize}
% \section*{Offene Fragen}
% \begin{itemize}
% \item Was kann ins Wiki ausgelagert werden?
% \item Was kann ins doxygen ausgelagert werden?
% \item Alles was (nicht?) LH2 spezifische raus?
% \item Fur listOfProperties und listOfFeatures auf doxygen verweisen! (kommt
% unter doxygen main pages)
% \item Modelbeschreibungen rausschmeißen?
% \item bennenung der ausgelagerten tex dateien mit kapitelnummer (nur eine nummer)
% beginnend
% \item Neue Kapitel/Abschnitte
% \begin{itemize}
% \item Wie kann ich Gitter erstellen (externe tools), /einlesen (dune), wo
% kann ich bei dune nachschauen. Welche Dateien werden uberhaupt unterstutzt?
% in Kap 5 (jemanden finden, der sich auskennt Alex, Timo, Bernd)
% \end{itemize}
% \item Tutorials:
% \begin{itemize}
% \item Noch aktuell, noch funktioniert?
% \item Welche Features, Modelle brauchten auch ein Tutorial? Wie konnen wir
% den Einstieg leicht machen und fur uns den Aufwand gering halten?
% \item Verweis auf lecture fur realistischere Anwendungen
% \end{itemize}
% \end{itemize}
\section*{Erledigt}
\begin{itemize}
\item[x] Kapitel 4 weiter aufräumen (Christoph+Thomas)
\begin{itemize}
\item Tips und Tricks weiter integrieren
\item Reihenfolge der Unterkapitel
\item[x] Tips und Tricks weiter integrieren
\item[x] Reihenfolge der Unterkapitel
\end{itemize}
\item[x] Kapitel 5 weiter aufräumen (Christoph+Thomas)
\begin{itemize}
\item Reihenfolge der Unterkapitel
\item \Dumux aus den Uberschriften in Kap 5 rausnehmen
\item[x] Reihenfolge der Unterkapitel
\item[x] \Dumux aus den Uberschriften in Kap 5 rausnehmen
\end{itemize}
\item[x] release manager tasks + tutorials anschauen/testen (Thomas)
\item Rechtschreibung - pdf in word öffnen
\end{itemize}
\section*{Weitere ToDos}
\begin{itemize}
\item Kapitel 5: Unterkapitel aufteilen -$>$ weiter aufräumen (s. Todos)
\end{itemize}
\section*{Offene Fragen}
\begin{itemize}
\item Was kann ins Wiki ausgelagert werden?
\item Was kann ins doxygen ausgelagert werden?
\item Alles was (nicht?) LH2 spezifische raus?
\item Fur listOfProperties und listOfFeatures auf doxygen verweisen! (kommt
unter doxygen main pages)
\item Modelbeschreibungen rausschmeißen?
\item bennenung der ausgelagerten tex dateien mit kapitelnummer (nur eine nummer)
beginnend
\item Neue Kapitel/Abschnitte
\begin{itemize}
\item Wie kann ich Gitter erstellen (externe tools), /einlesen (dune), wo
kann ich bei dune nachschauen. Welche Dateien werden uberhaupt unterstutzt?
in Kap 5 (jemanden finden, der sich auskennt Alex, Timo, Bernd)
\end{itemize}
\item Tutorials:
\item[x] Hinweis auf tests, lecture und feature list am Ende von Tutorial
(Gaby)
\item[x] Doxygen (main page - link auf modules, featureList und parameterList)
(Kilian)
\item[x] Wiki
\begin{itemize}
\item Noch aktuell, noch funktioniert?
\item Welche Features, Modelle brauchten auch ein Tutorial? Wie konnen wir
den Einstieg leicht machen und fur uns den Aufwand gering halten?
\item Verweis auf lecture fur realistischere Anwendungen
\item[x] behandla, Mailing list (LH2), external Modules, lectures, tests
teilweise schon erledigt -$>$ Rest (Vishal)
\item[x] Infos fur neue Doktoranden (Christoph)
\end{itemize}
\end{itemize}
\section*{Erledigt}
\begin{itemize}
\item leer
\end{itemize}
......@@ -37,7 +37,7 @@ can lead to a speedup of factor up to ten!
In contrast programs that are compiled with optimization can hardly be debugged.
You can modify the files and add third-party dependencies or additional compiler flags.
\todo{Hinweis/Beispiel, wie ein anderer Compiler eingebunden werden kann}
\todo{Hinweis/Beispiel, wie ein anderer Compiler eingebunden werden kann (Thomas)}
\paragraph{Dunecontrol for selected modules}
A complete build using \texttt{dunecontrol} takes some time. In many cases not all modules need to be re-built.
......
......@@ -63,6 +63,7 @@
\item \texttt{tutorial}: contains the tutorials described in Chapter \ref{chp:tutorial}.
\end{itemize}
% \begin{figure}
\begin{sidewaysfigure}
\begin{tikzpicture}[>=latex,inner xsep=0.15cm,rounded corners]
\node [minimum height=0.7cm,draw,inner xsep=0.94cm,rotate=90,thick] (d) at(-2,0) {dumux};
......@@ -178,6 +179,9 @@
{Files for parallel programming.};
\end{tikzpicture}
\caption{Structure of the directory \texttt{dumux} containing the \Dumux source files.
\todo[inline]{Diese Skizze ist NICHT mehr aktuell}}
\todo[inline]{Diese Skizze ist NICHT mehr aktuell. Hochkant passt sie wahrscheinlich besser auf die Seite.
Neue Tikz Templates sollten eingführt werden. Eventuell Grafik/Schrift verkleinern und einpassen.
Eventuell mit nur relative Platzierung der Boxen mit lower-of ... (Thomas)}}
\label{fig:dumux-structure}
\end{sidewaysfigure}
% \end{figure}
\section{Steps of a \Dumux Simulation}
\label{flow}
\todo[inline]{I think here we can delete some portion of text}
\todo[inline]{Hier könnte man den Text auch etwas abspecken}
This chapter is supposed to show how things are ``handed around'' in \Dumux. This
is not a comprehenisve guide through the modeling framework of \Dumux, but
hopefully it will help getting to grips with it.
......@@ -32,6 +31,9 @@ There are extensive comments regarding the formating in the tex file: so feel fr
to enhance this description.
\subsection{Structure -- by Content}
\todo[inline]{Mehr Farbe, z.B bei den Levels, statt den Links}
\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.
......@@ -159,6 +161,7 @@ name is given and not the full signature (arguments...) .
Comments regarding the events within one step-stone are set \scriptsize{smaller}.
\todo[inline]{Workflow übersichtlicher gestalten}
\begin{landscape}
%switch off headings and footer in order to get more space for the flowchart
......
\section{Fluid Framework}
\label{sec:fluidframework}
\todo[inline]{Wie kann dieses Kapitel besser mit doxygen vereinbart werden? Evtl. durch generische
Klassen in dumux, die dann automatische im doxygen auftauchen.}
This chapter discusses the \Dumux fluid framework. \Dumux users who
do not want to write new models and who do not need new fluid
configurations may skip this chapter.
......@@ -62,23 +65,18 @@ The \Dumux fluid framework currently features the following concepts
\end{description}
\subsection{Fluid States}
\todo[inline]{übersichtlicher gestalten}
Fluid state objects express the complete thermodynamic state of a
system at a given spatial and temporal position.
\subsubsection{Exported Constants}
{\bf All} fluid states {\bf must} export the following constants:
All fluid states must export the following constants:
\begin{description}
\item[numPhases:] The number of fluid phases considered.
\item[numComponents:] The number of considered chemical
species or pseudo-species.
\item[numComponents:] The number of considered chemical species or pseudo-species.
\end{description}
\subsubsection{Accessible Thermodynamic Quantities}
Also, {\bf all} fluid states {\bf must} provide the following methods:
Also, all fluid states must provide the following methods:
\begin{description}
\item[temperature():] The absolute temperature $T_\alpha$ of
a fluid phase $\alpha$.
......@@ -161,7 +159,8 @@ Also, {\bf all} fluid states {\bf must} provide the following methods:
\end{description}
\subsubsection{Available Fluid States}
\todo{könnte aufs doxygen ausgelagert werden}
\todo{Diese Liste von verfügbaren \emph{FluidStates} sollte eigentlich so und
in gleicher Ausfgührlichkeit im doxygen möglich sein -$>$ deshalb raus.}
Currently, the following fluid states are provided by \Dumux:
\begin{description}
\item[NonEquilibriumFluidState:] This is the most general fluid state
......@@ -353,7 +352,8 @@ such fluid systems cannot be used for models that depend on those
methods.
\subsubsection{Available Fluid Systems}
\todo{könnte aufs doxygen ausgelagert werden}
\todo{Diese Liste von verfügbaren \emph{FluidSystems} sollte eigentlich so und
in gleicher Ausfgührlichkeit im doxygen möglich sein -$>$ deshalb raus.}
Currently, the following fluid systems are available in \Dumux:
\begin{description}
......
......@@ -33,8 +33,8 @@ can be found for example in the dissertation of \href{http://elib.uni
-stuttgart.de/opus/frontdoor.php?source_opus=8047&la=de}{Tatomir}, pp. 68.
\subsection{ICEM}
\todo[inline]{Detailierte Beschreibung im Wiki? Links entfernen, die nicht funktionieren. Text überarbeiten. (Natalie)}
For complex geometries a graphical tool to create grids might be appropriate. One possibility to mesh for example CAD
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 \href{http://www.hydrosys.uni
-stuttgart.de/Intern/tiki/tiki-index.php?page=Netzgenerierung}{wiki} \todo{link tut nicht - wollen wir überhaupt interne links}. A more recent best practice guide is available at
\url{XXX} \todo{wenn der link nicht tut rausschmeißen}. At LH2 exists a script which converts the ICEM mesh into the DGF \todo{können wir das skript in \texttt{util} aufnehmen?}.
CFD}. A very detailed, but outdated description can be found at the LH2 internal wiki. A more recent best practice guide is available at
\url{XXX}. At LH2 exists a script which converts the ICEM mesh into the DGF.
\section{Models}
\todo{die abschnitte im einzelnen überarbeiten}
\todo{die abschnitte im einzelnen überarbeiten (Thomas)}
\subsection{Basic Definitions and Assumptions}
Characteristic of compositional multiphase models is that the phases
are not only matter of a single chemical substance. Instead, their
......@@ -12,16 +12,52 @@ three-phase three-component system water-NAPL-gas
systems is straightforward and can be found, e.\ g., in
\cite{A3:bielinski:2006,A3:acosta:2006}.
\textbf{Components:}
\begin{description}
\item[Components:]
The term {\it component} stands for constituents of the phases which
can be associated with a unique chemical species, or, more generally, with
a group of species exploiting similar physical behavior. In this work, we
assume a water-gas-NAPL system composed of the phases water (subscript
$\text{w}$), gas ($\text{g}$), and NAPL ($\text{n}$). These phases are
composed of the components water (superscript $\text{w}$), air
($\text{a}$), and the organic contaminant ($\text{c}$) (see Fig.\
($\text{a}$), and the organic contaminant ($\text{c}$) (see Fig.
\ref{fig:phaseMassEnergyTransfer}).
\item[Equilibrium:]
For the non-isothermal multiphase processes in porous media under
consideration, we state that the assumption of local thermal
equilibrium is valid since flow velocities are small. We neglect
chemical reactions and biological decomposition and assume chemical
equilibrium. Mechanical equilibrium is not valid in a porous medium,
since discontinuities in pressure can occur across a fluid-fluid
interface due to capillary effects.
\item[Notation:]
The index $\alpha \in \{\text{w}, \text{n}, \text{g}\}$ refers
to the phase, while the superscript $\kappa \in \{\text{w}, \text{a}, \text{c}\}$ refers
to the component.
\end{description}
\begin{table}
\begin{tabular}{llll}
$p_\alpha$ & phase pressure & $\phi$ & porosity \\
$T$ & temperature & $K$ & absolute permeability tensor \\
$S_\alpha$ & phase saturation & $\tau$ & tortuosity \\
$x_\alpha^\kappa$ & mole fraction of component $\kappa$ in phase $\alpha$ & $\boldsymbol{g}$ & gravitational acceleration \\
$X_\alpha^\kappa$ & mass fraction of component $\kappa$ in phase $\alpha$ & $q^\kappa_\alpha$ & volume source term of $\kappa$ in $\alpha$ \\
$\varrho_{\text{mol},\alpha}$ & molar density of phase $\alpha$ & $u_\alpha$ & specific internal energy \\
$\varrho_{\alpha}$ & mass density of phase $\alpha$ & $h_\alpha$ & specific enthalpy \\
$M$ & molar mass of a phase or component & $c_\text{s}$ & specific heat enthalpy \\
$k_{\text{r}\alpha}$ & relative permeability & $\lambda_\text{pm}$ & heat conductivity \\
$\mu_\alpha$ & phase viscosity & $q^h$ & heat source term \\
$D_\alpha^\kappa$ & diffusivity of component $\kappa$ in phase $\alpha$ & $\boldsymbol{v}_{a,\alpha}$ & advective velocity \\
$\boldsymbol{v}_\alpha$ & velocity (Darcy or free flow)& & \\
\end{tabular}
\caption{Notation list for most of the variables and indices used in \Dumux.}
\todo[inline]{Diese Liste macht ohne ausführliche Beschreibung der Modelle eigentlich keinen Sinn mehr.
Sollen wir sie auch irgendwie auf das doxygen packen?}
\end{table}
\begin{figure}
\centering
\begin{tikzpicture} [>=latex,scale=0.6, every node/.style={transform shape}]
......@@ -84,36 +120,8 @@ composed of the components water (superscript $\text{w}$), air
\label{fig:phaseMassEnergyTransfer}
\end{figure}
\textbf{Equilibrium:}
For the non-isothermal multiphase processes in porous media under
consideration, we state that the assumption of local thermal
equilibrium is valid since flow velocities are small. We neglect
chemical reactions and biological decomposition and assume chemical
equilibrium. Mechanical equilibrium is not valid in a porous medium,
since discontinuities in pressure can occur across a fluid-fluid
interface due to capillary effects.
\textbf{Notation:} The index $\alpha \in \{\text{w}, \text{n}, \text{g}\}$ refers
to the phase, while the superscript $\kappa \in \{\text{w}, \text{a}, \text{c}\}$ refers
to the component. \\
\begin{tabular}{llll}
$p_\alpha$ & phase pressure & $\phi$ & porosity \\
$T$ & temperature & $K$ & absolute permeability tensor \\
$S_\alpha$ & phase saturation & $\tau$ & tortuosity \\
$x_\alpha^\kappa$ & mole fraction of component $\kappa$ in phase $\alpha$ & $\boldsymbol{g}$ & gravitational acceleration \\
$X_\alpha^\kappa$ & mass fraction of component $\kappa$ in phase $\alpha$ & $q^\kappa_\alpha$ & volume source term of $\kappa$ in $\alpha$ \\
$\varrho_{\text{mol},\alpha}$ & molar density of phase $\alpha$ & $u_\alpha$ & specific internal energy \\
$\varrho_{\alpha}$ & mass density of phase $\alpha$ & $h_\alpha$ & specific enthalpy \\
$M$ & molar mass of a phase or component & $c_\text{s}$ & specific heat enthalpy \\
$k_{\text{r}\alpha}$ & relative permeability & $\lambda_\text{pm}$ & heat conductivity \\
$\mu_\alpha$ & phase viscosity & $q^h$ & heat source term \\
$D_\alpha^\kappa$ & diffusivity of component $\kappa$ in phase $\alpha$ & $\boldsymbol{v}_{a,\alpha}$ & advective velocity \\
$\boldsymbol{v}_\alpha$ & velocity (Darcy or free flow)& & \\
\end{tabular}
\subsection{Available Models}
\todo{modelliste einfügen}
\todo{auf doxygen verweisen}
\todo{modelliste einfügen, auf doxygen verweisen, Text überarbeiten (Christoph)}
The following description of the available models is automatically extracted
from the Doxygen documentation.
......@@ -121,7 +129,7 @@ from the Doxygen documentation.
\subsection{Implicit and Decoupled Models}
\subsubsection{Fully-Implicit Models}
\todo{überarbeiten}
\todo{überarbeiten (Christoph)}
The fully-implicit models described in this section are using the box or the
cell centered finite volume method as described in section \ref{box} and \ref{cc}
for spatial and the implicit Euler
......@@ -129,7 +137,7 @@ method as temporal discretization. The models themselves are located in
subdirectories of \texttt{dumux/implicit} of the \Dumux distribution.
\subsubsection{Decoupled Models}
\todo{überarbeiten}
\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
pressure and equations for phase-/component-/etc. transport. The pressure equation
......
......@@ -19,7 +19,6 @@ property has a so-called \emph{property tag} which labels its name.
Just like normal classes, properties can be arranged in hierarchies. In
the context of the \Dumux property system, nodes of the inheritance
hierarchy are called \emph{type tags}.
\end{description}
It also supports \emph{property nesting} and
\emph{introspection}. Property nesting means that the definition of
......
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