aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/documentation.tex27
1 files changed, 25 insertions, 2 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 518f231..1411419 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -18,8 +18,8 @@ a wave speed.
Thorn {\tt Time} uses one of four methods to decide on the timestep
to be used for the simulation. The method is chosen using the
-keyword parameter {\tt time::timestep\_method}. (Note: In releases Beta 8 and
-earlier the parameter used was {\tt time::courant\_method}
+keyword parameter {\tt time::timestep\_method}.
+
\begin{itemize}
\item{} {\tt time::timestep\_method = ``given''} The timestep is fixed to the
@@ -68,8 +68,31 @@ $$
\Delta t \le \mbox{min}(\Delta x^i)/\mbox{wave speed}/\sqrt(\mbox{dim})
$$
+\section{Examples}
+
+{\bf Fixed Value Timestep}
+
+{\tt
+\begin{verbatim}
+time::timestep_method = ``given''
+time::timestep = 0.1
+\end{verbatim}
+}
+
+
+{\bf Calculate Static Timestep Based on Grid Spacings}
+The following parameters set the timestep to be 0.25
+{\tt
+\begin{verbatim}
+grid::dx = 0.5
+grid::dy = 1.0
+grid::dz = 1.0
+time::timestep_method = ``courant_static''
+time::dtfac = 0.5
+\end{verbatim}
+}
% Automatically created from the ccl files by using gmake thorndoc
\include{interface}