0_dumux-handbook.tex 4.06 KB
Newer Older
1
\documentclass[11pt,a4paper,headinclude,footinclude,DIV16]{scrreprt}
Thomas Fetzer's avatar
Thomas Fetzer committed
2
\usepackage[usenames,dvipsnames,table]{xcolor} % include at beginning because of compitibility issues
3
\usepackage[english]{babel}
Thomas Fetzer's avatar
Thomas Fetzer committed
4
\usepackage[utf8]{inputenc}
Thomas Fetzer's avatar
Thomas Fetzer committed
5
6
\usepackage[automark]{scrpage2}
\usepackage[normalem]{ulem}
Bernd Flemisch's avatar
Bernd Flemisch committed
7
8
\usepackage{amsmath}
\usepackage{amsfonts}
9
\usepackage{amssymb}
10
\usepackage{booktabs}
Thomas Fetzer's avatar
Thomas Fetzer committed
11
12
\usepackage{enumerate}
\usepackage{hyperref}
Bernd Flemisch's avatar
Bernd Flemisch committed
13
\usepackage{graphicx}
Thomas Fetzer's avatar
Thomas Fetzer committed
14
15
\usepackage{listings}
\usepackage{makeidx}
16
17
\usepackage{pdflscape}
\usepackage{rotating}
Thomas Fetzer's avatar
Thomas Fetzer committed
18
\usepackage{subfig}
19
\usepackage{tabularx}
Thomas Fetzer's avatar
Thomas Fetzer committed
20
21
\usepackage{theorem}
\usepackage{tikz}
Thomas Fetzer's avatar
Thomas Fetzer committed
22
\usepackage{tikz-qtree}
Thomas Fetzer's avatar
Thomas Fetzer committed
23
24
25
26
\usepackage{units}
\usepackage{url}
\usepackage{xspace}
\hypersetup{bookmarksdepth=3}
Thomas Fetzer's avatar
Thomas Fetzer committed
27
28
29
30
31
32
33
34
\usetikzlibrary{arrows}
\usetikzlibrary{backgrounds}
\usetikzlibrary{decorations.pathmorphing}
\usetikzlibrary{fit}
\usetikzlibrary{patterns}
\usetikzlibrary{positioning}
\usetikzlibrary{shapes}
\usetikzlibrary{trees}
Thomas Fetzer's avatar
Thomas Fetzer committed
35
\include{0_listingstyle}
Thomas Fetzer's avatar
Thomas Fetzer committed
36
37
38

\DeclareGraphicsExtensions{.pdf, .jpg}

Thomas Fetzer's avatar
Thomas Fetzer committed
39
% Dune and Dumux logo
Thomas Fetzer's avatar
Thomas Fetzer committed
40
41
42
43
44
\newcommand{\Dune}{{DUNE}\xspace}
\newcommand{\Dumux}{\texorpdfstring{Du\-Mu$^\text{x}$\xspace}{DuMuX\xspace}}
\newcommand{\DumuxVersion}{2.8}
\definecolor{dumuxYellow}{HTML}{E19417}
\definecolor{dumuxBlue}{HTML}{0C73CF}
Thomas Fetzer's avatar
Thomas Fetzer committed
45

Thomas Fetzer's avatar
Thomas Fetzer committed
46
% sytles
Thomas Fetzer's avatar
Thomas Fetzer committed
47
\newcommand{\nextline}{\par\phantom{a}\vspace*{0.1\textwidth}}
Thomas Fetzer's avatar
Thomas Fetzer committed
48
49
\newcommand{\snakeline}{\uwave{\mbox{}}}
\DeclareRobustCommand\Cplusplus{\texorpdfstring{C\nolinebreak[4]\hspace{-.05em}\raisebox{.4ex}{\tiny\bf ++}\xspace}{C++}}
Thomas Fetzer's avatar
Thomas Fetzer committed
50

Thomas Fetzer's avatar
Thomas Fetzer committed
51
% notation
52
53
54
\newcommand{\porosity}{\phi}
\newcommand{\saturation}{S}

Thomas Fetzer's avatar
Thomas Fetzer committed
55
% a new counter you can give a label to it and thus reference it
56
% syntax: \numberThis{printedTextToBeLabeled}{label}
Bernd Flemisch's avatar
Bernd Flemisch committed
57
58
59
60
61
62
63
64
65
66
67
68
69
% if you wanted a \newline after a numbered thing, you could just add a empty line after ``\label{#2}''
\newcounter{thingCounter}
\renewcommand{\thethingCounter}{\arabic{thingCounter}}
\newcommand{\numberThis}[2]{%
        \refstepcounter{thingCounter}%
        \thethingCounter.\ #1 \label{#2}
}

%The theorems
\theorembodyfont{\upshape}
\theoremheaderfont{\sffamily\bfseries}
\newtheorem{lst}{Listing}

Thomas Fetzer's avatar
Thomas Fetzer committed
70
\DeclareMathOperator{\grad}{\bf grad}
Bernd Flemisch's avatar
Bernd Flemisch committed
71
72
73
74
75
76
77
\DeclareMathOperator{\curl}{curl}
\DeclareMathOperator{\Div}{div}

\pagestyle{scrheadings}

\title{
\begin{center}
78
\includegraphics[width=0.7\textwidth]{../logo/dumux_logo_hires_whitebg.png}
Bernd Flemisch's avatar
Bernd Flemisch committed
79
80
81
82
83
84
85
\\[3cm]
{\Huge Handbook}
\end{center}
}

\author{}

Thomas Fetzer's avatar
Thomas Fetzer committed
86
\date{Version \DumuxVersion}
Bernd Flemisch's avatar
Bernd Flemisch committed
87
88
89
90
91
92
93

\publishers{%
\vspace{10mm}
{\normalsize Lehrstuhl f\"ur Hydromechanik und Hydrosystemmodellierung, \\
Universit\"at Stuttgart, Paffenwaldring 61, D-70569 Stuttgart, Germany}\\
%
\bigskip
Bernd Flemisch's avatar
Bernd Flemisch committed
94
{\normalsize \texttt{\url{http://dumux.org}}}\\
Bernd Flemisch's avatar
Bernd Flemisch committed
95
96
97
98
99
100
101
102
}

\makeindex

\begin{document}

\maketitle

Thomas Fetzer's avatar
Thomas Fetzer committed
103
\setcounter{tocdepth}{1}
Bernd Flemisch's avatar
Bernd Flemisch committed
104
\tableofcontents
Thomas Fetzer's avatar
Thomas Fetzer committed
105
\newpage
Thomas Fetzer's avatar
Thomas Fetzer committed
106
107

\chapter{Introduction}
Thomas Fetzer's avatar
Thomas Fetzer committed
108
\input{1_introduction}
Thomas Fetzer's avatar
Thomas Fetzer committed
109
110

\chapter{Getting started}
111
112
First, we briefly describe the installation procedure.
Then we provide a quick start guide for the first \Dumux experience.
Thomas Fetzer's avatar
Thomas Fetzer committed
113
114
115
116
117
\input{2_quickinstall}
\input{2_quickstartguide}
\input{2_detailedinstall}

\chapter{Tutorial}\label{chp:tutorial}
Thomas Fetzer's avatar
Thomas Fetzer committed
118
\input{3_tutorial}
Thomas Fetzer's avatar
Thomas Fetzer committed
119
120
\input{3_tutorialcoupled}
\input{3_tutorialdecoupled}
Thomas Fetzer's avatar
Thomas Fetzer committed
121
\input{3_furtherpractice}
Thomas Fetzer's avatar
Thomas Fetzer committed
122
123

\chapter{Overview and Infrastructure}
Thomas Fetzer's avatar
Thomas Fetzer committed
124
125
126
This chapter provides an overview of the general structure in \Dumux \ref{sc_structure}
and gives help for basic work with \Dumux
(\ref{sc_newfoldersetup},\ref{sc_parameterfiles},\ref{sc_restartsimulations},\ref{sc_guidelines},\ref{sc_developingdumux}).
127
Further it presents useful external tools \ref{sc_externaltools} and basic
128
concepts \ref{sc_linearsystem}.
Thomas Fetzer's avatar
Thomas Fetzer committed
129
130
131
\input{4_structure}
\input{4_newfoldersetup}
\input{4_parameterfiles}
Thomas Fetzer's avatar
Thomas Fetzer committed
132
\input{4_restartsimulations}
Thomas Fetzer's avatar
Thomas Fetzer committed
133
\input{4_guidelines}
Thomas Fetzer's avatar
Thomas Fetzer committed
134
135
\input{4_developingdumux}
\input{4_externaltools}
Thomas Fetzer's avatar
Thomas Fetzer committed
136
137
138
139
140
141
142
\input{4_newtoninanutshell}

\chapter{Advanced \Dumux\ -- Detailed Instructions}
This chapter contains detailed information for those who are interested
in deeper modifications of underlying \Dumux models, classes, functions, etc.
\input{5_models}
\input{5_spatialdiscretizations}
Thomas Fetzer's avatar
Thomas Fetzer committed
143
\input{5_stepsofasimulation}
Thomas Fetzer's avatar
Thomas Fetzer committed
144
145
\input{5_propertysystem}
\input{5_fluidframework}
Thomas Fetzer's avatar
Thomas Fetzer committed
146
\input{5_grids}
Bernd Flemisch's avatar
Bernd Flemisch committed
147
148
149
150
151

\bibliographystyle{plain}
\bibliography{dumux-handbook}
\printindex
\end{document}