From 41f45abf3e3d316aefc650fd30280e11b53ffb7a Mon Sep 17 00:00:00 2001 From: Klaus Mosthaf Date: Fri, 1 Aug 2008 07:07:43 +0000 Subject: [PATCH] subdivided dumux-handbook.tex into several sub-texs, startet to work on the quickstart-guide --- doc/handbook/dumux-handbook.tex | 32 +++++++---------------------- doc/handbook/getting-started.tex | 3 +++ doc/handbook/intro.tex | 3 +++ doc/handbook/quickstart-guide.tex | 12 +++++++++++ doc/handbook/tutorial-coupled.tex | 11 ++++++++++ doc/handbook/tutorial-decoupled.tex | 3 +++ 6 files changed, 39 insertions(+), 25 deletions(-) create mode 100644 doc/handbook/getting-started.tex create mode 100644 doc/handbook/intro.tex create mode 100644 doc/handbook/quickstart-guide.tex create mode 100644 doc/handbook/tutorial-coupled.tex create mode 100644 doc/handbook/tutorial-decoupled.tex diff --git a/doc/handbook/dumux-handbook.tex b/doc/handbook/dumux-handbook.tex index f5a3b8d7f..90afc9f83 100644 --- a/doc/handbook/dumux-handbook.tex +++ b/doc/handbook/dumux-handbook.tex @@ -17,7 +17,7 @@ \DeclareGraphicsExtensions{.eps, .jpg} \newcommand{\Dune}{{\sf\bfseries DUNE}} -\newcommand{\Dumux}{DuMu$^\text{x}$ } +\newcommand{\Dumux}{DuMu$^\text{x}$} %The theorems \theorembodyfont{\upshape} @@ -56,32 +56,14 @@ Universit\"at Stuttgart, Paffenwaldring 61, D-70569 Stuttgart, Germany}\\ \tableofcontents - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\chapter{Introduction} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\chapter{Getting started} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - - -\begin{lst}[File dune-mux/test/twophase/test\_twophase.cc] \mbox{} -\lstinputlisting[basicstyle=\ttfamily\scriptsize,numbers=left, -numberstyle=\tiny, numbersep=5pt]{../../test/twophase/test_twophase.cc} -\end{lst} - -In line \ref{tp:material}, the material law to be used is specified. - +\input{intro} +\input{getting-started} +\input{quickstart-guide} +\input{tutorial-coupled} +\input{tutorial-decoupled} \bibliographystyle{plain} -\bibliography{dumux-handbook} +%\bibliography{dumux-handbook} \printindex diff --git a/doc/handbook/getting-started.tex b/doc/handbook/getting-started.tex new file mode 100644 index 000000000..fb6262737 --- /dev/null +++ b/doc/handbook/getting-started.tex @@ -0,0 +1,3 @@ +\chapter{Getting started} + +TODO: getting started \ No newline at end of file diff --git a/doc/handbook/intro.tex b/doc/handbook/intro.tex new file mode 100644 index 000000000..8cbc91ff4 --- /dev/null +++ b/doc/handbook/intro.tex @@ -0,0 +1,3 @@ +\chapter{Introduction} + +TODO: introduction to DUNE + DUMUX, installation and quick explanation of the external components \ No newline at end of file diff --git a/doc/handbook/quickstart-guide.tex b/doc/handbook/quickstart-guide.tex new file mode 100644 index 000000000..0ea2efa9e --- /dev/null +++ b/doc/handbook/quickstart-guide.tex @@ -0,0 +1,12 @@ +\chapter[Quick start guide]{Quick start guide: The first run of a test application} + +PRELIMINARY DRAFT, tbc.: In the previous chapter, it was explained how to install and compile \Dumux. This chapter shall give a very brief introduction, how to run a first test application and to visualize the first output files. The rough steps will be described here. More detailed explanations can be found in the tutorials. + +\begin{enumerate} + \item Go to the directory dune-mux/test. There, various test application folders can be found. Let us consider the test{\_}twophase example. + \item Enter the folder test{\_}twophase and type for example 'test{\_}twophase grids/unitcube2.dgf 1000 10'. The parameters that occur here are the external grid (in this case a 2D square), the end time of the simulation and the initial timestep. + \item Then, the simulation starts and produces some .vtu output files and also a .pvd file. This .pvd file can be used to examine time series and contains information about several .vtu-files. + \item You can display the results using the previously installed visualization tool ParaView. Just type paraview into the console. +\end{enumerate} + + diff --git a/doc/handbook/tutorial-coupled.tex b/doc/handbook/tutorial-coupled.tex new file mode 100644 index 000000000..b3280ea68 --- /dev/null +++ b/doc/handbook/tutorial-coupled.tex @@ -0,0 +1,11 @@ +\chapter[Tutorial: Fully-coupled model]{Tutorial: Fully-coupled model} + +TODO: describe the fully coupled model in detail + + +\begin{lst}[File dune-mux/test/twophase/test\_twophase.cc] \mbox{} +\lstinputlisting[basicstyle=\ttfamily\scriptsize,numbers=left, +numberstyle=\tiny, numbersep=5pt]{../../test/twophase/test_twophase.cc} +\end{lst} + +In line \ref{tp:material}, the material law to be used is specified. diff --git a/doc/handbook/tutorial-decoupled.tex b/doc/handbook/tutorial-decoupled.tex new file mode 100644 index 000000000..9954a64f8 --- /dev/null +++ b/doc/handbook/tutorial-decoupled.tex @@ -0,0 +1,3 @@ +\chapter[Tutorial: Decoupled model]{Tutorial: Decoupled model} + +TODO: describe a decoupled model in detail \ No newline at end of file