diff --git a/doc/handbook/.gitignore b/doc/handbook/.gitignore deleted file mode 100644 index 405bdb87c..000000000 --- a/doc/handbook/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -dumux-handbook.aux -dumux-handbook.bbl -dumux-handbook.blg -dumux-handbook.idx -dumux-handbook.log -dumux-handbook.out -dumux-handbook.pdf -dumux-handbook.toc diff --git a/doc/handbook/Makefile.am b/doc/handbook/Makefile.am index 65bd585ad..210523c3b 100644 --- a/doc/handbook/Makefile.am +++ b/doc/handbook/Makefile.am @@ -25,6 +25,7 @@ if CONVERT endif endif + # setting like in dune-web BASEDIR=../.. CURDIR=doc/handbook diff --git a/doc/handbook/tutorial-decoupled.tex b/doc/handbook/tutorial-decoupled.tex index 22706c224..3c950b605 100644 --- a/doc/handbook/tutorial-decoupled.tex +++ b/doc/handbook/tutorial-decoupled.tex @@ -49,7 +49,7 @@ properties of the solid matrix are defined in a special soil class. The \texttt{soil} object is generated in line \ref{tutorial-decoupled:soil}. As can be seen, the class type is \texttt{Dune::TutorialSoil}, which is defined in the file -\texttt{tutorial\_soilproperties\_decoupled.hh} in the folder +\texttt{tutorialspatialparameters\_decoupled.hh} in the folder \texttt{/tutorial}. A description of this file and the definition of a soil class including the soil parameters can be found in section \ref{tutorial-decoupled:description-soil-class}. Finally, in line @@ -87,13 +87,13 @@ Soil properties which can be defined in \Dumux are the \textit{intrinsic permeab The base class \texttt{Dune::Matrix2p} for the definition of the soil parameters can be found in the file \texttt{property\_baseclasses.hh} in the directory \texttt{/dumux/material}. Derived from this base class, there exist two standard soil type classes named \texttt{HomogeneousSoil} and \texttt{HeterogeneousSoil}. Both can be found in the file \texttt{matrixproperties.hh} in the \texttt{/material} folder. If one wants to use a soil that differs from this standard soil types, new soil classes can be derived either from the base class (\texttt{Dune::Matrix2p}) or from the two standard soil classes (\texttt{Dune::HomogeneousSoil} and \texttt{Dune::HeterogeneousSoil}). -For this tutorial problem a new soil class named \texttt{TutorialSoil} is derived from \texttt{Dune::Matrix2p} (listing \ref{tutorial-deoucpled:soilpropertiesfile}, line \ref{tutorial-decoupled:tutorialsoil}), which can be found in the file \texttt{tutorial\_soilproperties\_decoupled.hh} in the directory \texttt{/tutorial}. +For this tutorial problem a new soil class named \texttt{TutorialSoil} is derived from \texttt{Dune::Matrix2p} (listing \ref{tutorial-deoucpled:soilpropertiesfile}, line \ref{tutorial-decoupled:tutorialsoil}), which can be found in the file \texttt{tutorialspatialparameters\_decoupled.hh} in the directory \texttt{/tutorial}. -Listing \ref{tutorial-deoucpled:soilpropertiesfile} shows the file \texttt{tutorial\_soilproperties\_decoupled.hh}. +Listing \ref{tutorial-deoucpled:soilpropertiesfile} shows the file \texttt{tutorialspatialparameters\_decoupled.hh}. -\begin{lst}[File tutorial/tutorial\_soilproperties\_decoupled.hh]\label{tutorial-deoucpled:soilpropertiesfile} \mbox{} +\begin{lst}[File tutorial/tutorialspatialparametrs\_decoupled.hh]\label{tutorial-deoucpled:soilpropertiesfile} \mbox{} \lstinputlisting[basicstyle=\ttfamily\scriptsize,numbers=left, -numberstyle=\tiny, numbersep=5pt]{../../tutorial/tutorial_soilproperties_decoupled.hh} +numberstyle=\tiny, numbersep=5pt]{../../tutorial/tutorialspatialparameters_decoupled.hh} \end{lst} In line \ref{tutorial-decoupled:permeability} the function returning the intrinsic permeability can be found. As can be seen, the function has to be called with three different arguments. The first one (\texttt{x}) is a vector including the global coordinates of the current entity (can be an element, vertex, etc.), the second one (\texttt{e}) is the entity itself and the third one is a vector including the local coordinates of the current entity. The intrinsic permeability is a tensor and thus returned in form of a $n \times n$-matrix where $n$ is the dimension of the problem. @@ -153,7 +153,7 @@ Now you can change the fluids. Use DNAPL instead of Oil and Brine instead of Wat \texttt{/dumux/material/fluids}. \item \textbf{Changing Constitutive Relationships} \\ -Use a Brooks-Corey law with $\lambda$ = 2 and entry pressure $p_b = 0.0$ instead of a linear law for the relative-permeability/saturation relationship. To do that you have to change the file \texttt{tutorial\_soilproperties\_decoupled.hh}. You can find the flag that you have to set for the Brooks-Corey law in the file \texttt{property\_baseclasses.hh} in the directory \texttt{/dumux/material}. +Use a Brooks-Corey law with $\lambda$ = 2 and entry pressure $p_b = 0.0$ instead of a linear law for the relative-permeability/saturation relationship. To do that you have to change the file \texttt{tutorialspatialparameters\_decoupled.hh}. You can find the flag that you have to set for the Brooks-Corey law in the file \texttt{property\_baseclasses.hh} in the directory \texttt{/dumux/material}. The available relative permeability and capillary pressure functions are defined in the file \texttt{/dumux/material/relperm\_pc\_law}.\\ (Hint: The CFL-security-factor should be set to a value smaller than 1 if nonlinear relationships are used (Suggestion: 0.95). It can be found in the application file \texttt{tutorialproblem\_decoupled.hh}.) @@ -175,7 +175,7 @@ Set up a model domain with the soil properties given in Figure \ref{tutorial-deo \end{enumerate} \subsubsection{Exercise 2} -For this exercise you should create a new proplem file according to the file \texttt{tutorialproblem\_decoupled.hh} and a new soil property file according to the file \texttt{tutorial\_soilproperties\_decoupled.hh}. These files need to be included in the file \texttt{tutorial\_decoupled.cc}.\\ +For this exercise you should create a new proplem file according to the file \texttt{tutorialproblem\_decoupled.hh} and a new soil property file according to the file \texttt{tutorialspatialparameters\_decoupled.hh}. These files need to be included in the file \texttt{tutorial\_decoupled.cc}.\\ The new soil file should contain the definition of a new soil class e.g. SoilEx2. Make sure that you also adjust the preprocessor commands (e.g. change TUTORIAL\_SOILPROPERTIES to TUTORIAL\_SOILEX2). The new problem file should contain the definition of a new problem class e.g. ProblemEx2. Here you also need to adjust the preprocessor commands. Replace the classes \texttt{TutorialSoil} and \texttt{TutorialProblemDecoupled} by the the new classes you just created. \\ diff --git a/examples/Makefile.am b/examples/Makefile.am index 6c5a5f964..18db357c3 100644 --- a/examples/Makefile.am +++ b/examples/Makefile.am @@ -1,7 +1,7 @@ # tests where program to build and program to run are equal NORMALTESTS = tutorial_decoupled tutorial_coupled -EXTRA_DIST=CMakeLists.txt results/*/*/*.vtu +EXTRA_DIST=results/*/*/*.vtu noinst_HEADERS= tutorialspatialparameters_decoupled.hh tutorialproblem_decoupled.hh tutorialspatialparameters_coupled.hh tutorialproblem_coupled.hh # list of tests to run diff --git a/examples/tutorial_coupled.cc b/examples/tutorial_coupled.cc index 030c08a88..307c4d041 100644 --- a/examples/tutorial_coupled.cc +++ b/examples/tutorial_coupled.cc @@ -1,4 +1,4 @@ -// $Id$ +// $Id: tutorial_coupled.cc 3736 2010-06-15 09:52:10Z lauser $ /***************************************************************************** * Copyright (C) 2007-2008 by Klaus Mosthaf * * Copyright (C) 2007-2008 by Bernd Flemisch * diff --git a/examples/tutorial_decoupled.cc b/examples/tutorial_decoupled.cc index bfe7c6b35..cb3054ca2 100644 --- a/examples/tutorial_decoupled.cc +++ b/examples/tutorial_decoupled.cc @@ -1,4 +1,4 @@ -// $Id$ +// $Id: tutorial_decoupled.cc 3636 2010-05-25 13:27:16Z bernd $ /***************************************************************************** * Copyright (C) 20010 by Markus Wolff * * Copyright (C) 2007-2008 by Bernd Flemisch * diff --git a/examples/tutorialproblem_coupled.hh b/examples/tutorialproblem_coupled.hh index 5e0e1da67..0bcfdc62e 100644 --- a/examples/tutorialproblem_coupled.hh +++ b/examples/tutorialproblem_coupled.hh @@ -1,4 +1,4 @@ -// $Id$ +// $Id: tutorialproblem_coupled.hh 3783 2010-06-24 11:33:53Z bernd $ /***************************************************************************** * Copyright (C) 2008-2009 by Melanie Darcis * * Copyright (C) 2009 by Andreas Lauser * diff --git a/examples/tutorialproblem_decoupled.hh b/examples/tutorialproblem_decoupled.hh index e1daded59..273e9cacb 100644 --- a/examples/tutorialproblem_decoupled.hh +++ b/examples/tutorialproblem_decoupled.hh @@ -1,4 +1,4 @@ -// $Id$ +// $Id: tutorialproblem_decoupled.hh 3783 2010-06-24 11:33:53Z bernd $ /***************************************************************************** * Copyright (C) 2007-2008 by Klaus Mosthaf * * Copyright (C) 2007-2008 by Bernd Flemisch * diff --git a/examples/tutorialspatialparameters_coupled.hh b/examples/tutorialspatialparameters_coupled.hh index ab32ae90e..986f00d63 100644 --- a/examples/tutorialspatialparameters_coupled.hh +++ b/examples/tutorialspatialparameters_coupled.hh @@ -1,4 +1,4 @@ -// $Id$ +// $Id: tutorialspatialparameters_coupled.hh 3783 2010-06-24 11:33:53Z bernd $ /***************************************************************************** * Copyright (C) 2008-2009 by Melanie Darcis * * Institute of Hydraulic Engineering *