OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

subdivided dumux-handbook.tex into several sub-texs, startet to work on the quickstart-guide

Browse Source
This commit is contained in:
Klaus Mosthaf 2008-08-01 07:07:43 +00:00 committed by Andreas Lauser
parent d43c51fce2
commit 41f45abf3e
6 changed files with 39 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/handbook/dumux-handbook.tex
View File

@ -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

3
doc/handbook/getting-started.tex Normal file
View File

@ -0,0 +1,3 @@
\chapter{Getting started}
TODO: getting started

3
doc/handbook/intro.tex Normal file
View File

@ -0,0 +1,3 @@
\chapter{Introduction}
TODO: introduction to DUNE + DUMUX, installation and quick explanation of the external components

12
doc/handbook/quickstart-guide.tex Normal file
View File

@ -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}

11
doc/handbook/tutorial-coupled.tex Normal file
View File

@ -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.

3
doc/handbook/tutorial-decoupled.tex Normal file
View File

@ -0,0 +1,3 @@
\chapter[Tutorial: Decoupled model]{Tutorial: Decoupled model}
TODO: describe a decoupled model in detail