mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
handbook updated
This commit is contained in:
Bernd Flemisch
committed by
Andreas Lauser
Andreas Lauser
parent
7cabd8a2a8
commit
e1ea7bc027
@@ -1,8 +1,8 @@
|
||||
# $id: $
|
||||
|
||||
EPS_FILES = EPS/tutorial-problemconfiguration.eps
|
||||
#EPS_FILES = EPS/tutorial-problemconfiguration.eps
|
||||
|
||||
DOCSOURCE = dumux-handbook.tex navigation.html css.html
|
||||
DOCSOURCE = dumux-handbook.tex intro.tex navigation.html css.html
|
||||
|
||||
MAINDOCS = dumux-handbook.dvi dumux-handbook.pdf dumux-handbook.ps
|
||||
|
||||
@@ -14,7 +14,8 @@ if TEX4HT
|
||||
HTDOCS = navigation.html css.html dumux-handbook.html
|
||||
endif
|
||||
|
||||
EXTRA_DIST = dumux-handbook.pdf Makefile.dist.in Makefile.dist.am
|
||||
EXTRA_DIST = dumux-handbook.pdf
|
||||
#Makefile.dist.in Makefile.dist.am
|
||||
|
||||
if BUILD_DOCS
|
||||
if CONVERT
|
||||
@@ -51,9 +52,9 @@ dumux-handbook.html: $(DOCSOURCE) dune.cfg tex4ht.env
|
||||
$(T4HT) dumux-handbook.tex
|
||||
$(TEX) dumux-handbook.tex
|
||||
|
||||
dist-hook:
|
||||
sed $(srcdir)/Makefile.dist.am -e 's/Makefile\.dist/Makefile/g' > $(distdir)/Makefile.am
|
||||
sed $(srcdir)/Makefile.dist.in -e 's/Makefile\.dist/Makefile/g' > $(distdir)/Makefile.in
|
||||
#dist-hook:
|
||||
# sed $(srcdir)/Makefile.dist.am -e 's/Makefile\.dist/Makefile/g' > $(distdir)/Makefile.am
|
||||
# sed $(srcdir)/Makefile.dist.in -e 's/Makefile\.dist/Makefile/g' > $(distdir)/Makefile.in
|
||||
|
||||
EXTRA_TEXINPUTS:=$(top_srcdir)
|
||||
|
||||
|
||||
@@ -1 +1,483 @@
|
||||
@book{ANDERSON-CFD-95,
|
||||
author = {J. D. Anderson},
|
||||
title = {Computational Fluid Mechanics},
|
||||
publisher = {McGraw-Hill},
|
||||
year = {1995},
|
||||
edition = {1},
|
||||
subtitle = {The Basics with Applications}
|
||||
}
|
||||
|
||||
@book{BRONSTEIN-93,
|
||||
author = {I.N. Bronstein and K.A. Semendjajew and G. Musiol and H. M\"{u}hlig},
|
||||
title = {Taschenbuch der Mathematik},
|
||||
publisher = {Verlag Harri Deutsch},
|
||||
year = {1993},
|
||||
edition = {6},
|
||||
|
||||
}
|
||||
|
||||
@book{PRANTL-02,
|
||||
author = {L. Prantl and H. Oertel},
|
||||
title = {F\"{u}hrer durch die Str\"{o}mungslehre},
|
||||
publisher = {Vieweg},
|
||||
year = {2002},
|
||||
edition = {11},
|
||||
|
||||
}
|
||||
|
||||
@book{SAENDIG-05,
|
||||
author = {A.-M. S{\"{a}}ndig},
|
||||
key={Sae05},
|
||||
title = {Mathematische Methoden in der Kontinuumsmechanik},
|
||||
publisher = {Institut f\"{u}r Angewandte Analysis und Numerische Simulation},
|
||||
year = {2005},
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@book{ARFKEN2005,
|
||||
author = {G. B. Arfken and H. J. Weber},
|
||||
title = {Mathematical Methods for Physicists},
|
||||
publisher = {Academic Press},
|
||||
year = {2005},
|
||||
edition = {6},
|
||||
|
||||
}
|
||||
|
||||
@misc{DUNE-HP,
|
||||
key = {DUNE},
|
||||
title = {The {DUNE} Project: \url{http://www.dune-project.org/}},
|
||||
|
||||
}
|
||||
|
||||
@misc{UG-HP,
|
||||
key = {UG},
|
||||
title = {The {UG} Homepage: \url{http://sit.iwr.uni-heidelberg.de/~ug/}},
|
||||
|
||||
}
|
||||
|
||||
@misc{ALBERTA-HP,
|
||||
key = {ALBERTA},
|
||||
title = {The {ALBERTA} Website: \url{http://www.alberta-fem.de/}},
|
||||
|
||||
}
|
||||
|
||||
@misc{ALUGRID-HP,
|
||||
key = {ALU},
|
||||
title = {The {ALU}-{G}rid Website: \url{http://www.mathematik.uni-freiburg.de/IAM/Research/alugrid/}},
|
||||
|
||||
}
|
||||
|
||||
@phdthesis{CLASS2001,
|
||||
author = {H. Class},
|
||||
title = {Theorie und numerische Modellierung nichtisothermer Mehrphasenprozesse in NAPL-kontaminierten por\"{o}sen Medien.},
|
||||
school = {University of Stuttgart},
|
||||
year = 2001,
|
||||
|
||||
}
|
||||
|
||||
@phdthesis{SHETA1999,
|
||||
author = {H. Sheta},
|
||||
title = {Simulation von Mehrphasenvorg\"{a}engen in por\"{o}sen Medien unter Einbeziehung von Hystereseeffekten},
|
||||
school = {University of Stuttgart},
|
||||
year = 1999,
|
||||
|
||||
}
|
||||
|
||||
@phdthesis{HUBER2000,
|
||||
author = {R. U. Huber},
|
||||
title = {Compositional Multiphase Flow and Transport in Heterogeneous Porous Media},
|
||||
school = {University of Stuttgart},
|
||||
year = 2000,
|
||||
|
||||
}
|
||||
|
||||
@phdthesis{PAPAFOTIOU2008,
|
||||
author = {A. Papafotiou},
|
||||
title = {Numerical investigations of the role of hysteresis in heterogeneous two-phase flow systems},
|
||||
school = {University of Stuttgart},
|
||||
year = 2008,
|
||||
|
||||
}
|
||||
|
||||
@book{HELMIG1997,
|
||||
author = {R. Helmig},
|
||||
title = {Multiphase Flow and Transport Processes in the Subsurface: A Contribution to the Modeling of Hydrosystems},
|
||||
publisher = {Springer},
|
||||
year = 1997,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@book{BASTIAN1999,
|
||||
author = {P. Bastian},
|
||||
title = {Numerical Computation of Multiphase Flows in Porous Media},
|
||||
publisher = {Habilitationsschrift, University of Kiel},
|
||||
year = 1999,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@article{MUALEM1976,
|
||||
author = {Y. Mualem},
|
||||
title = {A new model for predicting the hydraulic conductivity of unsaturated porous media},
|
||||
journal = {Water Resources Research},
|
||||
year = 1976,
|
||||
volume = {12},
|
||||
number = 3,
|
||||
pages = {513--522},
|
||||
|
||||
}
|
||||
|
||||
@article{WHITAKER1985,
|
||||
author = {S. Whitaker},
|
||||
title = {Flow in porous media I: A theoretical derivation of Darcy's law},
|
||||
journal = {Transport in Porous Media},
|
||||
year = {1985},
|
||||
volume = {1},
|
||||
number = {1},
|
||||
pages = {3--25},
|
||||
|
||||
}
|
||||
|
||||
@article{MUCCINO1998,
|
||||
author = {J. C. Muccino and W. G. G. Gray and L. A. Ferrand},
|
||||
title = {Toward an Improved Understanding of Multiphase Flow in Porous Media},
|
||||
journal = {Reviews of Geophysics},
|
||||
year = {1998},
|
||||
volume = {36},
|
||||
number = {3},
|
||||
pages = {401--422},
|
||||
|
||||
}
|
||||
|
||||
@misc{DARCY1856,
|
||||
key = {Dar1856},
|
||||
author = {H. Darcy},
|
||||
title = {Les Fontaines publiques de la ville de Dijon},
|
||||
howpublished = {Paris},
|
||||
year = 1856,
|
||||
|
||||
}
|
||||
|
||||
@article{DITTERICH1996,
|
||||
author = {E. Ditterich},
|
||||
title = {Wirbel um den Bodenschutz},
|
||||
journal = {Umweltmagazin},
|
||||
year = 1996,
|
||||
number = 4,
|
||||
pages = {46--48},
|
||||
|
||||
}
|
||||
|
||||
@article{VANGENUCHTEN1980,
|
||||
author = {M. T. {van Genuchten}},
|
||||
title = {A Closed-form Equation for Predicting the Hydraulic Conductivity of Unsaturated Soils},
|
||||
journal = {Journal of the Soil Science Society of America},
|
||||
year = 1980,
|
||||
key = {Gen80},
|
||||
number = 44,
|
||||
pages = {892--898},
|
||||
|
||||
}
|
||||
|
||||
@article{AGRAWAL2001,
|
||||
author = {K. Agrawal and P. N. Loezos and M. Syamlal and S. Sundaresan},
|
||||
title = {The Role of Meso-Scale Structures in Rapid Gas-Solid Flows},
|
||||
journal = {Journal of Fluid Mechanics},
|
||||
year = {2001},
|
||||
number = {445},
|
||||
pages = {151--185},
|
||||
|
||||
}
|
||||
|
||||
@article{BEAUCHEMIN1995,
|
||||
author = {S. S. Beauchemin and J. L. Barron},
|
||||
title = {The computation of optical flow},
|
||||
journal = {ACM Computing Surveys},
|
||||
year = {1995},
|
||||
volume = {27},
|
||||
number = {3},
|
||||
pages = {433--466},
|
||||
|
||||
}
|
||||
|
||||
@book{MEYBERG2000,
|
||||
author = {K. Meyberg and P. Vachenauer},
|
||||
title = {H\"{o}here Mathematik 1},
|
||||
publisher = {Springer},
|
||||
year = 2001,
|
||||
edition = {6},
|
||||
|
||||
}
|
||||
|
||||
@book{GLADROW2000,
|
||||
author = {D. A. Wolf-Gladrow},
|
||||
title = {Lattice-Gas Cellular Automata and Lattice Boltzmann Models: An Introduction},
|
||||
publisher = {Springer},
|
||||
year = 2000,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@book{GRIEBEL2003,
|
||||
author = {M. Griebel and S. Knapek and G. Zumbusch and A. Caglar},
|
||||
title = {Numerische Simulation in der Molek\"{u}ldynamik},
|
||||
publisher = {Springer},
|
||||
year = 2003,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@book{KARNIADAKIS2005,
|
||||
author = {G. Karniadakis and A. Be{\c c}k\"{o}k and N. R. Aluru},
|
||||
title = {Microflows and Nanoflows: Fundamentals and Simulation},
|
||||
publisher = {Springer},
|
||||
year = 2005,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@book{MUSKAT1937,
|
||||
author = {M. Muskat},
|
||||
title = {The Flow of Homogeneous Fluids Through Porous Media},
|
||||
publisher = {McGraw-Hill},
|
||||
year = 1937,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@article{BURDINE1953,
|
||||
author = {N.T. Burdine},
|
||||
title = {Relative permeability calculations from pore size distribution data},
|
||||
journal = {Transactions of the American Institute of Mining and Metallurgical Engineers},
|
||||
year = 1953,
|
||||
volume = {198},
|
||||
pages = {71--78},
|
||||
|
||||
}
|
||||
|
||||
@article{TENG2000,
|
||||
author = {H. Teng and T.S. Zhao},
|
||||
title = {An extension of Darcy's law to non-Stokes flow in porous media},
|
||||
journal = {Chemical engineering science},
|
||||
year = 2000,
|
||||
volume = {55},
|
||||
number = 14,
|
||||
pages = {2727--2735},
|
||||
|
||||
}
|
||||
|
||||
@article{HASSANIZADEH1987,
|
||||
author = {S. M. Hassanizadeh and W. G. Gray},
|
||||
title = {High velocity flow in porous media},
|
||||
journal = {Transport in Porous Media},
|
||||
year = 1987,
|
||||
|
||||
}
|
||||
|
||||
@book{CLASS2007,
|
||||
author = {H. Class},
|
||||
title = {Models for Non-Isothermal Compositional Gas-Liquid Flow and Transport in Porous Media},
|
||||
publisher = {University of Stuttgart},
|
||||
year = 2007,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@misc{NUMPDESKRIPT,
|
||||
author = {P. Bastian},
|
||||
title = {Numerische L\"{o}sung partieller Differentialgleichungen},
|
||||
howpublished = {University of Stutt\-gart, Lecture Notes},
|
||||
year = 2007,
|
||||
|
||||
}
|
||||
|
||||
@book{LEVEQUE1992,
|
||||
author = {R. J. LeVeque},
|
||||
title = {Numerical Methods for Conservation Laws},
|
||||
publisher = {Birkh\"{a}user},
|
||||
year = 1992,
|
||||
edition = {2},
|
||||
|
||||
}
|
||||
|
||||
@misc{GSIMSKRIPT,
|
||||
author = {P. Bastian},
|
||||
title = {Grundlagen der Modellbildung und Simulation},
|
||||
howpublished = {University of Stuttgart, Lecture Notes},
|
||||
year = 2007,
|
||||
|
||||
}
|
||||
|
||||
@book{HYDROSKRIPT,
|
||||
author = {R. Helmig and H. Class},
|
||||
title = {Grundlagen der Hydromechanik},
|
||||
publisher = {Shaker},
|
||||
year = 2005,
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@phdthesis{DeNEFF2000,
|
||||
author = {de Neef, M. J.},
|
||||
title = {Modeling Capillary Effects in Heterogeneous Porous Media},
|
||||
school = {Technical University Delft},
|
||||
year = 2000,
|
||||
|
||||
}
|
||||
|
||||
@article{BASTIAN-HELMIG1999,
|
||||
author = {P. Bastian and R. Helmig},
|
||||
title = {Efficient Fully-Coupled Solution Techniques for Two Phase Flow in Porous Media. Parallel Multigrid Solution and Large Scale Computations},
|
||||
journal = {Advances in Water Resources},
|
||||
year = 1999,
|
||||
volume = {23},
|
||||
number = 3,
|
||||
pages = {199--216},
|
||||
|
||||
}
|
||||
|
||||
@techreport{BROOKS1964,
|
||||
author = {R. H. Brooks and A. T. Corey.},
|
||||
title = {Hydraulic properties of porous media},
|
||||
institution = {Colorado State University, Fort Collins},
|
||||
year = 1964,
|
||||
note = {Hydrology Paper No. 3, 27 pp.},
|
||||
|
||||
}
|
||||
|
||||
@article{KOOL1987,
|
||||
author = {J. Kool and J. C. Parker and M. T. van Genuchten},
|
||||
title = {Parameter Estimation for Unsaturated Flow and Transport Models - A Review},
|
||||
journal = {Journal of Hydrology},
|
||||
year = 1987,
|
||||
volume = 91,
|
||||
pages = {255--293},
|
||||
|
||||
}
|
||||
|
||||
@article{PARKER1987,
|
||||
author = {J. C. Parker and R. J. Lenhard and T. Kuppusamy},
|
||||
title = {A Parametric Model for Constitutive Properties Governing Multiphase Flow in Porous Media},
|
||||
journal = {Water Resources Research},
|
||||
year = 1987,
|
||||
volume = 23,
|
||||
number = 4,
|
||||
pages = {618--624},
|
||||
|
||||
}
|
||||
|
||||
@article{LENHARD1987,
|
||||
author = {R. J. Lenhard and J. C. Parker},
|
||||
title = {A Model for Hysteretic Constitutive Relations Governing Multiphase Flow. 2. Permeability-Saturation Relations},
|
||||
journal = {Water Resources Research},
|
||||
year = 1987,
|
||||
volume = 23,
|
||||
number = 12,
|
||||
pages = {2197--2206},
|
||||
|
||||
}
|
||||
|
||||
@article{LAND1968,
|
||||
author = {C. S. Land},
|
||||
title = {Calculation of Imbibition Relative Permeability for Two- and Three-Phase Flow from Rock Properties},
|
||||
journal = {Journal of the Society of Petroleum Engineers},
|
||||
year = 1968,
|
||||
volume = 8,
|
||||
number = 2,
|
||||
pages = {149--156},
|
||||
|
||||
}
|
||||
|
||||
@article{KALUARACHCHI1992,
|
||||
author = {J. J. Kaluarachchi and J. C. Parker},
|
||||
title = {Multiphase Flow with a Simplified Model for Oil Entrapment},
|
||||
journal = {Transport in Porous Media},
|
||||
year = 1992,
|
||||
volume = 7,
|
||||
number = 1,
|
||||
pages = {1--14},
|
||||
|
||||
}
|
||||
|
||||
@book{ORTEGA2000,
|
||||
author = {J. M. Ortega and W. C. Rheinboldt},
|
||||
title = {Iterative Solution of Nonlinear Equations in Several Variables},
|
||||
publisher = {Society for Industrial and Applied Mathematics},
|
||||
year = {2000},
|
||||
address = {Philadelphia, PA, USA},
|
||||
edition = {1},
|
||||
|
||||
}
|
||||
|
||||
@book{MEISTER2008,
|
||||
author = {A. Meister},
|
||||
title = {Numerik linearer Gleichungssysteme: Eine Einf\"{u}hrung in moderne Verfahren.},
|
||||
publisher = {Vieweg},
|
||||
year = {2008},
|
||||
edition = {3},
|
||||
|
||||
}
|
||||
|
||||
@inproceedings{BURRI2006,
|
||||
author = {A. Burri and A. Dedner and R. Kl\"{o}fkorn and M. Ohlberger},
|
||||
title = {An efficient implementation of an adaptive and parallel grid in DUNE.},
|
||||
booktitle = {Computational Science and High Performance Computing II},
|
||||
pages = {67--82},
|
||||
year = 2006,
|
||||
volume = {91},
|
||||
publisher = {Springer},
|
||||
|
||||
}
|
||||
|
||||
@article{BASTIAN2008,
|
||||
author = {P. Bastian and M. Blatt and A. Dedner and C. Engwer and R. Kl\"{o}fkorn and R. Kornhuber and M. Ohlberger and O. Sander},
|
||||
title = {A Generic Grid Interface For Parallel and Adaptive Scientific Computing. Part II: implementation and tests in {DUNE}},
|
||||
journal = {Computing},
|
||||
year = 2008,
|
||||
volume = {82},
|
||||
number = {2},
|
||||
pages={121--138},
|
||||
}
|
||||
|
||||
@book{DEBOOR1978,
|
||||
author = {C. {de Boor}},
|
||||
title = {A Practical Guide to Splines},
|
||||
publisher = {Springer},
|
||||
year = {1978},
|
||||
edition = {1},
|
||||
}
|
||||
|
||||
@article{SPAETH1969,
|
||||
author = {H. Sp{\"{a}}th},
|
||||
key={Spa69},
|
||||
title = {Exponential Spline Interpolation},
|
||||
journal = {Computing},
|
||||
year = 1969,
|
||||
volume = {4},
|
||||
number = {3},
|
||||
pages={225--233},
|
||||
}
|
||||
|
||||
@article{NIESSNER2005,
|
||||
author = {J. Niessner and R. Helmig and H. Jakobs and J. Roberts},
|
||||
title = {Interface Condition and Exact Linearization in the Newton Iterations for Two-phase Flow in Heterogeneous Porous Media},
|
||||
journal = {Advances in Water Resources},
|
||||
pages = {671--687},
|
||||
year = {2005},
|
||||
volume = {28},
|
||||
number = {7},
|
||||
}
|
||||
|
||||
|
||||
@article{BELIAEV2001,
|
||||
author = {A. Y. Beliaev and S. M. Hassanizadeh},
|
||||
title = {A Theoretical Model of Hysteresis and Dynamic Effects in the Capillary Relation for Two-phase Flow in Porous Media},
|
||||
journal = { Transport in Porous Media},
|
||||
pages = {487--510},
|
||||
year = {2001},
|
||||
volume = {43},
|
||||
number = {3},
|
||||
}
|
||||
|
||||
@@ -60,11 +60,10 @@ Universit\"at Stuttgart, Paffenwaldring 61, D-70569 Stuttgart, Germany}\\
|
||||
|
||||
\input{intro}
|
||||
\input{getting-started}
|
||||
\input{quickstart-guide}
|
||||
\input{tutorial}
|
||||
|
||||
\bibliographystyle{plain}
|
||||
%\bibliography{dumux-handbook}
|
||||
\bibliography{dumux-handbook}
|
||||
|
||||
\printindex
|
||||
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
\chapter{Getting started}
|
||||
|
||||
TODO: getting started
|
||||
We first describe the steps which are necessary for installing DuMu$^\text{x}$
|
||||
and then provide a quick start guide for the first DuMu$^\text{x}$ experience.
|
||||
We conclude this chapter with general guidelines for coding your own
|
||||
DuMu$^\text{x}$ application.
|
||||
|
||||
\input{install}
|
||||
\input{quickstart-guide}
|
||||
\input{guidelines}
|
||||
|
||||
36
doc/handbook/guidelines.tex
Normal file
36
doc/handbook/guidelines.tex
Normal file
@@ -0,0 +1,36 @@
|
||||
\section{Guidelines}
|
||||
|
||||
This section mainly quotes the DUNE coding guidelines found at \cite{DUNE-HP}.
|
||||
"In order to keep the code maintainable we have decided upon a set of coding rules.
|
||||
Some of them may seem like splitting hairs to you, but they do make it much easier
|
||||
for everybody to work on code that hasn't been written by oneself.
|
||||
|
||||
\begin{itemize}
|
||||
\item Naming:
|
||||
\begin{itemize}
|
||||
\item Variables: Names for variables should only consist of letters and digits. The first letter should be a lower case one. If your variable names consists of several words, then the first letter of each new word should be capital. As we decided on the only exception are the begin and end methods.
|
||||
\item Private Data Variables: Names of private data variables end with an underscore.
|
||||
\item Typenames: For typenames, the same rules as for variables apply. The only difference is that the first letter should be a capital one.
|
||||
\item Macros: The use of preprocessor macros is strongly discouraged. If you have to use them for whatever reason, please use capital letters only.
|
||||
\item The Exlusive-Access Macro: Every header file traditionally begins with the definition of a preprocessor constant that is used to make sure that each header file is only included once. If your header file is called 'myheaderfile.hh', this constant should be DUNE\_MYHEADERFILE\_HH.
|
||||
\item Files: Filenames should consist of lower case letters exclusively. Header files get the suffix .hh, implementation files the suffix .cc
|
||||
\end{itemize}
|
||||
\item Documentation:
|
||||
Dune, as any software project of similar complexity, will stand and fall with the quality of its documentation.
|
||||
Therefore it is of paramount importance that you document well everything you do! We use the doxygen system to extract easily-readable documentation form the source code. Please use its syntax everywhere. In particular, please comment all
|
||||
\begin{itemize}
|
||||
\item Method Parameters
|
||||
\item Template Parameters
|
||||
\item Return Values
|
||||
\item Exceptions thrown by a method
|
||||
\end{itemize}
|
||||
Since we all know that writing documentation is not well-liked and is frequently defered to some vague
|
||||
'next week', we herewith proclaim the Doc-Me Dogma . It goes like this: Whatever you do, and in whatever hurry you
|
||||
happen to be, please document everything at least with a {\verb /** $\backslash$todo Please doc me! */}. That way at least the absence
|
||||
of documentation is documented, and it is easier to get rid of it systematically.
|
||||
\item Exceptions:
|
||||
The use of exceptions for error handling is encouraged. Until further notice, all exceptions thrown are DuneEx.
|
||||
\item Debugging Code:
|
||||
Global debugging code is switched off by setting the symbol NDEBUG. In particular, all asserts are
|
||||
automatically removed. Use those asserts freely!"
|
||||
\end{itemize}
|
||||
57
doc/handbook/install.tex
Normal file
57
doc/handbook/install.tex
Normal file
@@ -0,0 +1,57 @@
|
||||
\section{Installation}
|
||||
|
||||
For the installation of DuMu$^\text{x}$, the following steps have to be performed.
|
||||
|
||||
\paragraph{Checkout of the core modules}
|
||||
Since we always want to be up to date with the latest changes in DUNE,
|
||||
we decided to use the developers version of the core modules
|
||||
\texttt{dune-common}, \texttt{dune-grid}, \texttt{dune-istl}, \texttt{dune-disc},
|
||||
and \texttt{dune-grid-howto}. The checkout has to be performed as described on
|
||||
the DUNE webpage, \cite{DUNE-HP}:
|
||||
\begin{itemize}
|
||||
\item \texttt{svn checkout https://svn.dune-project.org/svn/dune-common/trunk dune-common}
|
||||
\item \texttt{svn checkout https://svn.dune-project.org/svn/dune-grid/trunk dune-grid}
|
||||
\item \texttt{svn checkout https://svn.dune-project.org/svn/dune-istl/trunk dune-istl}
|
||||
\item \texttt{svn checkout https://svn.dune-project.org/svn/dune-disc/trunk dune-disc}
|
||||
\item \texttt{svn checkout https://svn.dune-project.org/svn/dune-grid-howto/trunk dune-grid-howto}
|
||||
\end{itemize}
|
||||
|
||||
\paragraph{Checkout of DuMu$^\text{x}$ and external modules}
|
||||
|
||||
First of all, you need to ask one of the IWS system administrators to
|
||||
add your account to the group \texttt{svndune}.
|
||||
If you are working on a LH2 computer, you then can checkout DuMu$^\text{x}$
|
||||
and the external modules via
|
||||
\begin{itemize}
|
||||
\item \texttt{svn checkout svn+ssht://luftig/home/svn/DUMUX/dune-mux/trunk dune-mux}
|
||||
\item \texttt{svn checkout svn+ssht://luftig/home/svn/DUMUX/dune-subgrid/trunk dune-subgrid}
|
||||
\item \texttt{svn checkout svn+ssht://luftig/home/svn/DUMUX/external/trunk external}
|
||||
\end{itemize}
|
||||
If you want to checkout from outside LH2, you first need to establish a tunnel.
|
||||
To this end, you need to add once
|
||||
\begin{center}
|
||||
\texttt{ssht = ssh -p 2022 -l login -o HostKeyAlias=luftig.iws.uni-stuttgart.de}
|
||||
\end{center}
|
||||
to the file \texttt{\$HOME/.subversion/config}, with \texttt{login} replaced
|
||||
by your actual IWS login name.
|
||||
The tunnel then needs to be initialized every time you want
|
||||
to connect to the repository by
|
||||
\begin{center}
|
||||
\texttt{ssh -Nf -L 2022:luftig.iws.uni-stuttgart.de:22 login@login1.iws.uni-stuttgart.de}.
|
||||
\end{center}
|
||||
Then, you can checkout everything as described above, if you replace \texttt{luftig}
|
||||
by \texttt{localhost}.
|
||||
|
||||
\paragraph{Build the external modules}
|
||||
The external modules consist of Alberta, ALUGrid, UG, GotoBLAS, and Paraview.
|
||||
To install them all, execute the script \texttt{installXXbit.sh} in the folder \texttt{external}.
|
||||
If you like to only install some of the external software, you can copy the corresponding
|
||||
parts of the script and paste them to the command line.
|
||||
Please also refer to the DUNE webpage for additional details, \cite{DUNE-HP}.
|
||||
|
||||
\paragraph{Build DUNE and DuMu$^\text{x}$}
|
||||
Type in the folder \texttt{DUMUX}:
|
||||
\begin{center}
|
||||
\texttt{./dune-common/bin/dunecontrol --opts=dune-mux/debug.opts all}
|
||||
\end{center}
|
||||
|
||||
@@ -1,3 +1,61 @@
|
||||
\chapter{Introduction}
|
||||
|
||||
TODO: introduction to DUNE + DUMUX, installation and quick explanation of the external components
|
||||
Since creating, refining and managing grids in general is a very
|
||||
complex topic which has severe effects on computational efficiency and
|
||||
for which no generic and efficient approach exists, our simulation
|
||||
framework is build on top of DUNE, the \textbf{D}istributed and \textbf{U}nified
|
||||
\textbf{N}umerics \textbf{E}nvironment~\cite{DUNE-HP}. DUNE provides a generic interface to many
|
||||
grid management libraries such as UG~\cite{UG-HP}, ALBERTA~\cite{ALBERTA-HP},
|
||||
ALU-Grid~\cite{ALUGRID-HP} and a few more. DUNE extensively uses templates in
|
||||
order to achieve maximum efficiency to access the actual grid
|
||||
libraries\footnote{In fact, the performance penalty resulting from the
|
||||
use of DUNE's grid interface is usually negligible~\cite{BURRI2006}.}.
|
||||
\begin{figure}[hbt]
|
||||
\centering
|
||||
\includegraphics[width=.5\linewidth, keepaspectratio]{EPS/dunedesign}
|
||||
\caption{
|
||||
\label{fig:dune-design}
|
||||
A high-level overview on DUNE's design as available on the project's
|
||||
web site~\cite{DUNE-HP}.
|
||||
}
|
||||
\end{figure}
|
||||
|
||||
DUNE's grid interface is independent of the spatial dimension of the
|
||||
underlying grid. For this purpose, it uses the concept of
|
||||
co-dimensional entities. Roughly speaking, an entity of co-dimension
|
||||
$0$ constitutes a cell, co-dimension $1$ entities are faces between
|
||||
cells, co-dimension $1$ are edges, and so on until co-dimension $n$
|
||||
which are the cell's vertices. The DUNE grid interface generally
|
||||
assumes, that all entities are convex polytopes, which means that it
|
||||
must be possible to express each entity as the convex hull of a set of
|
||||
vertices. For efficiency, all entities are further expressed in terms
|
||||
of so-called reference elements which are transformed to the actual
|
||||
spatial incarnation within the grid by a so-called geometry
|
||||
function\footnote{The same approach is also used by \texttt{dune-disc} for
|
||||
finite element shape functions.}. Here, a reference element for an
|
||||
entity can be thought of as a prototype for the actual grid
|
||||
entity. For example, if we used at a grid that used hexahedrons as cells,
|
||||
the reference element for each cell would be the unit cube $[0, 1]^3$
|
||||
and the geometry function would scale and translate the cube so that
|
||||
it matches the grid's cell. For a more thorough description of DUNE's
|
||||
grid definition, see~\cite{BASTIAN2008}.
|
||||
|
||||
In addition to the grid interface, DUNE also provides quite a few additional
|
||||
modules, of which the \texttt{dune-disc} and \texttt{dune-istl} modules are the most
|
||||
relevant in the context of this handbook. \texttt{dune-disc} provides a toolbox for
|
||||
discretization and includes a set of generic finite element shape
|
||||
functions, matrix assemblers for translating local stiffness matrices
|
||||
into global linear systems of equations and much more. \texttt{dune-istl} is the
|
||||
\textbf{I}terative \textbf{S}olver \textbf{T}emplate \textbf{L}ibrary
|
||||
and provides generic, highly optimized linear algebra routines for solving
|
||||
the generated systems.
|
||||
|
||||
DuMu$^\text{x}$ comes in form of an additional module \texttt{dune-mux}.
|
||||
It inherits functionality from all available DUNE modules.
|
||||
Its main intention is to provide a framework for easy and efficient
|
||||
implementation of models from porous media flow problems,
|
||||
ranging from problem formulation, the selection of
|
||||
spatial and temporal discretization schemes, as well as nonlinear solvers,
|
||||
up to general concepts for model coupling.
|
||||
Moreover, DuMu$^\text{x}$ includes ready to use numerical models and example applications.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
\chapter[Quick start guide]{Quick start guide: The first run of a test application}\label{quick-start-guide}
|
||||
\section[Quick start guide]{Quick start guide: The first run of a test application}\label{quick-start-guide}
|
||||
|
||||
PRELIMINARY DRAFT, tbc.: The previous chapter showed, how to install and compile \Dumux. This chapter shall give a very brief introduction, how to run a first test application, how to choose the materials, where to change boundary conditions, and how to visualize the first output files. Moreover, it will be explained, how to generate an own application folder. Only the rough steps will be described here. More detailed explanations can be found in the tutorials in the following chapter.
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ The problem which is solved in this tutorial is illustrated in figure \ref{tutor
|
||||
\psfrag{q_w = 0 [kg/m^2s]}{$q_w = 0$ $\left[\frac{\textnormal{kg}}{\textnormal{m}^2 \textnormal{s}}\right]$}
|
||||
\psfrag{q_n = -3 x 10^-4 [kg/m^2s]}{$q_w = -3 \times 10^-4$ $\left[\frac{\textnormal{kg}}{\textnormal{m}^2 \textnormal{s}}\right]$}
|
||||
\centering
|
||||
\includegraphics[width=0.9\linewidth,keepaspectratio]{EPS/tutorial-problemconfiguration}
|
||||
%\includegraphics[width=0.9\linewidth,keepaspectratio]{EPS/tutorial-problemconfiguration}
|
||||
\caption{Geometry of the tutorial problem with initial and boundary conditions.}\label{tutorial-decoupled:problemfigure}
|
||||
\end{figure}
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
\chapter[Tutorial]{Tutorial}
|
||||
|
||||
In \Dumux two sorts of models are implemented: Fully coupled models, and decoupled models. In the fully coupled models a flow system is described by a system of strongly coupled equations which can be mass balance equations, balance equations of components, energy balance equations, etc. In contrast a decoupled model consists of a pressure equation which is decoupled or only weakly coupled to a saturation equation, concentration equations, energy balance equations, etc.
|
||||
|
||||
Different kinds of both coupled and decoupled models can be isothermal two phase models, isothemal two phase two component models, non-isothermal twophase model, non-isothermal two phase two component models, etc.
|
||||
|
||||
Reference in New Issue
Block a user