From fab95dfba4011f249aa3cb1ce45008a2bb706972 Mon Sep 17 00:00:00 2001
From: Philipp Nuske <philipp.nuske@mailbox.org>
Date: Mon, 13 Feb 2012 09:25:47 +0000
Subject: [PATCH] - A new section on the usage of the parameter files. Nothing
fancy but hopefully helpful for (first time) usage. Feel free to change or
move somewhere else :-)
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7723 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/handbook/getting-started.tex | 1 +
doc/handbook/quickstart-guide.tex | 4 ++--
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/handbook/getting-started.tex b/doc/handbook/getting-started.tex
index 93ba070734..cbf9675654 100644
--- a/doc/handbook/getting-started.tex
+++ b/doc/handbook/getting-started.tex
@@ -5,3 +5,4 @@ Then a quick start guide for the first \Dumux experience is provided.
\input{quick-install}
\input{quickstart-guide}
+\input{parameterTree}
diff --git a/doc/handbook/quickstart-guide.tex b/doc/handbook/quickstart-guide.tex
index 1ea4839872..bf9e4cadde 100644
--- a/doc/handbook/quickstart-guide.tex
+++ b/doc/handbook/quickstart-guide.tex
@@ -5,8 +5,8 @@ The previous chapter showed how to install and compile \Dumux. This chapter shal
\begin{enumerate}
\item Go to the directory \texttt{/test}. There, various test application folders can be found. Let us consider as example \texttt{boxmodels/test{\_}2p}:
\item Enter the folder \texttt{boxmodels/2p}. If everything was compiled correctly, there should be an executable \texttt{test{\_}2p}. Otherwise, type \texttt{make test{\_}2p} in order to compile the application. To run the simulation, type\\
-\texttt{./test{\_}2p 1e4 1e2}\\
-into the console. The parameters that are used here are the end time of the simulation and the initial timestep size. The parameters that are required when calling the application are specified in the application file (here: test{\_}2p.cc).
+\texttt{./test{\_}2p -parameterFile ./test\_2p.input}\\
+into the console. The parameter \texttt{-parameterFile} specifies that all important parameters (like first timestep size, end of simulation and location of the grid file) can be found in a text file in the same directory with the name \texttt{test\_2p.input}.
\item The simulation starts and produces some .vtu output files and also a .pvd file. The .pvd file can be used to examine time series and summarizes the .vtu-files. It is possible to stop a running application by pressing $<ctrl><c>$.
\item You can display the results using the visualization tool ParaView (or alternatively VisIt). Just type \texttt{paraview} in the console and open the .pvd file. On the left hand side, you can choose the desired parameter to be displayed.
\end{enumerate}
--
GitLab