aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorbmundim <bmundim@c83d129a-5a75-4d5a-9c4d-ed3a5855bf45>2010-05-02 20:59:32 +0000
committerbmundim <bmundim@c83d129a-5a75-4d5a-9c4d-ed3a5855bf45>2010-05-02 20:59:32 +0000
commit74fb1e6ea34d6e03a35ff6c158f455c39904bf5a (patch)
treed8f9b95f30517e9bafd8c67301c7383bc8beb76e /doc
parent291e94d06b30046227fb075cbfa97b9656339d5a (diff)
file/parameter string replacement from whisky to GRHydro
git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinEvolve/GRHydro/trunk@112 c83d129a-5a75-4d5a-9c4d-ed3a5855bf45
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation.tex150
1 files changed, 75 insertions, 75 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 675cca8..b084389 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -4,7 +4,7 @@
\begin{document}
% The title of the document (not necessarily the name of the Thorn)
-\title{The {\tt Whisky} code: three-dimensional relativistic hydrodynamics}
+\title{The {\tt GRHydro} code: three-dimensional relativistic hydrodynamics}
% The author of the documentation - on one line, otherwise it does not work
\author{Original authors: Luca Baiotti, Ian Hawke, Pedro Montero \cr Contributors:
@@ -101,7 +101,7 @@
% Add an abstract for this thorn's documentation
\begin{abstract}
- {\tt Whisky} is a fully general-relativistic three-dimensional hydrodynamics code. It evolves the
+ {\tt GRHydro} is a fully general-relativistic three-dimensional hydrodynamics code. It evolves the
hydrodynamics using High Resolution Shock Capturing methods and can
work with realistic equations of state. The evolution of the
spacetime can be done by any other ``appropriate'' thorn, such as
@@ -114,9 +114,9 @@
\section{Introduction}
\label{sec:intro}
-The {\tt Whisky}\footnote{The name is
+The {\tt GRHydro}\footnote{The name is
due to Tom Goodale, who pointed out that the in the original Gaelic
- {\it uisge beatha} (from which {\tt whisky} is derived) meant {\it water of
+ {\it uisge beatha} (from which {\tt GRHydro} is derived) meant {\it water of
life}. This name was chosen at a free and fair democratic ballot
at the EU Network meeting in Southampton that gave the right answer
thanks to a little bit of help from the authors of the code after
@@ -131,27 +131,27 @@ contributors.
\section{Using This Thorn}
\label{sec:use}
-What follows is a brief introduction to using {\tt Whisky}. It assumes that
+What follows is a brief introduction to using {\tt GRHydro}. It assumes that
you know the required physics and numerical methods, and also the
basics of Cactus\footnote{http://www.cactuscode.org}. If you don't, then skip this section and come back
to it after reading the rest of this ThornGuide of Cactus. For more details such
-as thornlists and parameter files, take a look at the {\tt Whisky} web page
+as thornlists and parameter files, take a look at the {\tt GRHydro} web page
which is currently stored at
\begin{verbatim}
-http://www.whiskycode.org
+http://www.GRHydrocode.org
\end{verbatim}
-{\tt Whisky} provides the hydro variables and methods to evolve them. It
+{\tt GRHydro} provides the hydro variables and methods to evolve them. It
does not provide any information about initial data or equations of
state. For these, other thorns are required. A minimal list of thorns
for performing a shock-tube test is given in the shock-tube test
parameter file, found at
\begin{verbatim}
-Whisky/test/whisky_test_shock.par
+GRHydro/test/GRHydro_test_shock.par
\end{verbatim}
and will include the essential thorns
\begin{verbatim}
-whisky eos_base admbase admcoupling mol
+GRHydro eos_base admbase admcoupling mol
\end{verbatim}
Current thorns actually implementing equations of state include
\begin{verbatim}
@@ -159,17 +159,17 @@ eos_ideal_fluid eos_polytrope
\end{verbatim}
Initial data for shocks can be set using
\begin{verbatim}
-whisky_init_data
+GRHydro_init_data
\end{verbatim}
Initial data for spherically symmetric static stars (with
perturbations or multiple ``glued'' stars) can be set by
\begin{verbatim}
-whisky_tovsolverc
+GRHydro_tovsolverc
\end{verbatim}
The actual evolution in time is controlled by the Method of Lines
thorn MoL. For full details see the relevant ThornGuide. For the
-purposes of {\tt Whisky} at least two parameters are relevant; {\tt
+purposes of {\tt GRHydro} at least two parameters are relevant; {\tt
ode\_method} and {\tt mol\_timesteps}. If second-order accuracy is
all that is required then {\tt ode\_method} can be set to either {\tt
"rk2"} (second-order TVD Runge-Kutta evolution) or {\tt "icn"}
@@ -181,7 +181,7 @@ Shu-Osher type TVD Runge-Kutta evolution. Then the parameter {\tt
mol\_timesteps} controls the number of intermediate steps and hence
the order of accuracy. First to seventh order are currently supported.
-{\tt Whisky} currently uses a Reconstruction-Evolution type method. The type
+{\tt GRHydro} currently uses a Reconstruction-Evolution type method. The type
of reconstruction is controlled by the parameter {\tt recon\_method}.
The currently supported values are {\tt "tvd"} for slope limited TVD
reconstruction, {\tt "ppm"} for the Colella-Woodward PPM method, and
@@ -192,7 +192,7 @@ there are a number of slope limiters controlled by the keyword {\tt
Boolean {\tt ppm\_detect}, and the ENO method can have various orders
of accuracy controlled by {\tt eno\_order}. Note that the higher-order
methods such as PPM and ENO require the stencil size to be increased
-using {\tt whisky\_stencil} {\bf and} {\tt driver::ghost\_size}.
+using {\tt GRHydro\_stencil} {\bf and} {\tt driver::ghost\_size}.
For the evolution various approximate Riemann solvers are available,
controlled by {\tt riemann\_solver}. Currently implemented are {\tt
@@ -203,25 +203,25 @@ methods of the Valencia group, but the explicit matrix inversion is
still there for reference.
For the equations of state, two ``types'' are recognized, controlled
-by the parameter {\tt whisky\_eos\_type}. These are {\tt "Polytype"}
+by the parameter {\tt GRHydro\_eos\_type}. These are {\tt "Polytype"}
where the pressure is a function of the density, $P=P(\rho)$, and the
more generic {\tt "General"} type where the pressure is a function
of the density and the internal energy, $P=P(\rho, \epsilon)$. For the
{\tt Polytype} equations of state one fewer equation is evolved and
the specific internal energy is set directly from the density. The
actual equation of state used is controlled by the parameter {\tt
- whisky\_eos\_table}. Polytype equations of state include {\tt
+ GRHydro\_eos\_table}. Polytype equations of state include {\tt
"2D\_Polytrope"} and general equations of state include {\tt
"Ideal\_Fluid"}.
\subsection{Obtaining This Thorn}
-The public version of Whisky can be found on the
-website {\tt http://www.whiskycode.org}.
+The public version of GRHydro can be found on the
+website {\tt http://www.GRHydrocode.org}.
\subsection{Basic Usage}
-The simplest way to start using {\tt Whisky} would be to download some
+The simplest way to start using {\tt GRHydro} would be to download some
example parameter files from the web page to try it. There are a number
of essential parameters which might reward some experimentation. These
include:
@@ -243,10 +243,10 @@ include:
\item Riemann solvers: {\tt Marquina} is the standard solver
used. {\tt HLLE} is significantly faster, but sometimes provides cruder approximation.
\item Equations of state: These are controlled by the {\tt
- whisky\_eos\_type} and {\tt whisky\_eos\_table} parameters. Changing
+ GRHydro\_eos\_type} and {\tt GRHydro\_eos\_table} parameters. Changing
these parameters will depend on which equation of state thorns you
have compiled in.
-\item Initial data parameters: {\tt whisky\_rho\_central} is inherited by many
+\item Initial data parameters: {\tt GRHydro\_rho\_central} is inherited by many
initial data thorns to set the central density of compact fluid
objects such as single stars.
\item Atmosphere parameters: Many of these are listed in
@@ -255,35 +255,35 @@ include:
\subsection{Special Behaviour}
-Although in theory {\tt Whisky} can deal with conformal metrics as well as
+Although in theory {\tt GRHydro} can deal with conformal metrics as well as
physical metrics, this part of the code is completely untested as we
don't have conformal initial data (although this would not be hard -
we just haven't had the incentive).
\subsection{Interaction With Other Thorns}
-{\tt Whisky} provides the appropriate contribution to the stress energy
+{\tt GRHydro} provides the appropriate contribution to the stress energy
through the {\tt TmunuBase} interface. Those spacetime evolvers that
-use this interface can use {\tt Whisky} without change.
-%To pass the required variables across {\tt Whisky} is a friend of {\tt ADMCoupling}.
+use this interface can use {\tt GRHydro} without change.
+%To pass the required variables across {\tt GRHydro} is a friend of {\tt ADMCoupling}.
-{\tt Whisky} uses the {\tt MoL} thorn to perform the actual time
+{\tt GRHydro} uses the {\tt MoL} thorn to perform the actual time
evolution. This means that if all other evolution thorns are also
using {\tt MoL} then the complete evolution will have the accuracy of
the {\tt MoL} evolution method without change. This (currently) allows
-for up to fourth-order accuracy in time without any changes to {\tt Whisky}.
+for up to fourth-order accuracy in time without any changes to {\tt GRHydro}.
-For the general equations of state {\tt Whisky} uses the {\tt EOS\_Base}
+For the general equations of state {\tt GRHydro} uses the {\tt EOS\_Base}
interface. This returns the necessary hydrodynamical quantities, such
as the pressure and derivatives with general function calls. The
-parameter {\tt whisky\_eos\_table} controls which equation of state is
+parameter {\tt GRHydro\_eos\_table} controls which equation of state is
used during evolution.
-{\tt Whisky} also explicitly depends on the polytropic equation of state
+{\tt GRHydro} also explicitly depends on the polytropic equation of state
thorn {\tt EOS\_Polytrope}. This is used to reset the hydrodynamical
quantities in the atmosphere if necessary.
-For the metric quantities {\tt Whisky} uses the standard {\tt
+For the metric quantities {\tt GRHydro} uses the standard {\tt
CactusEinstein} arrangement, especially {\tt ADMBase}. This allows
the standard thorns to be used for the calculation of constraint
violations, emission of gravitational waves, location of the apparent
@@ -291,9 +291,9 @@ horizon, and more.
\subsection{Support and Feedback}
-The {\tt Whisky} web page is located at
+The {\tt GRHydro} web page is located at
\begin{verbatim}
-http://www.whiskycode.org
+http://www.GRHydrocode.org
\end{verbatim}
and contains information on obtaining the code, together with
thornlists and sample parameter files. There is also a section on
@@ -301,17 +301,17 @@ Frequently Asked Questions which will hopefully solve your problem.
If your problem is not answered there then please send details to one
of the maintainers listed below.
-The primary maintainers of {\tt Whisky} are Ian Hawke ({\tt
+The primary maintainers of {\tt GRHydro} are Ian Hawke ({\tt
hawke@aei.mpg.de}), Luca Baiotti ({\tt baiotti@yukawa.kyoto-u.ac.jp}) and Frank L\"offler
({\tt knarf@cct.lsu.edu}). Email should always reach us faster than
other means and we will try to fix any problems as fast as possible.
Problems with the web page should also be addressed to Frank.
Other people with knowledge and experience of developing and using
-{\tt Whisky} who may be able to help include Luciano Rezzolla ({\tt
+{\tt GRHydro} who may be able to help include Luciano Rezzolla ({\tt
rezzolla@aei.mpg.de}) and Nick Stergioulas ({\tt niksterg@aei.mpg.de}).
-Problems with thorns that {\tt Whisky} depends on should go direct to their
+Problems with thorns that {\tt GRHydro} depends on should go direct to their
maintainers. Examples would be
\begin{itemize}
\item {\tt MoL}: Ian Hawke ({\tt hawke@aei.mpg.de})
@@ -321,11 +321,11 @@ maintainers. Examples would be
({\tt cactusmaint@cactuscode.org})
\item {\tt EOS\_*}: Ian Hawke (although in this case I can't guarantee
I'll be able to fix the problem)
-\item {\tt Whisky\_Init\_Data}: Luca Baiotti ({\tt baiotti@yukawa.kyoto-u.ac.jp}) or
+\item {\tt GRHydro\_Init\_Data}: Luca Baiotti ({\tt baiotti@yukawa.kyoto-u.ac.jp}) or
Ian Hawke ({\tt hawke@aei.mpg.de})
-\item {\tt Whisky\_TOVSolverC}: Ian Hawke ({\tt hawke@aei.mpg.de}) or Frank L\"offler ({\tt
+\item {\tt GRHydro\_TOVSolverC}: Ian Hawke ({\tt hawke@aei.mpg.de}) or Frank L\"offler ({\tt
knarf@cct.lsu.edu})
-\item {\tt Whisky\_IVP}: Frank L\"offler ({\tt knarf@cct.lsu.edu})
+\item {\tt GRHydro\_IVP}: Frank L\"offler ({\tt knarf@cct.lsu.edu})
or Luca Baiotti ({\tt baiotti@yukawa.kyoto-u.ac.jp}) or Ian Hawke ({\tt hawke@aei.mpg.de})
\end{itemize}
@@ -349,12 +349,12 @@ These conserved variables are composed from a set of {\it primitive variables},
which are $\rho$, the density, $p$, the
pressure, $v^i$, the fluid 3-velocities, $\epsilon$, the internal
energy, and $W$, the Lorentz factor, via the following relations
-% from Whisky/src/Prim2con.F90
+% from GRHydro/src/Prim2con.F90
% w = 1.d0 / sqrt(1.d0 - (gxx*dvelx*dvelx + gyy*dvely*dvely + gzz &
% &*dvelz*dvelz + 2*gxy*dvelx*dvely + 2*gxz*dvelx *dvelz + 2*gyz&
% &*dvely*dvelz))
%
-% dpress = (whisky_eos_gamma - 1.d0) * drho * deps
+% dpress = (GRHydro_eos_gamma - 1.d0) * drho * deps
%
% ddens = sqrt(det) * drho * w
% dsx = sqrt(det) * (drho*(1+deps)+dpress)*w*w * (gxx*dvelx + gxy&
@@ -430,15 +430,15 @@ accuracy over the majority of the domain.
For a full introduction to HRSC methods see~\cite{laney}, \cite{toro},
\cite{leveque}, \cite{livrevsrrfd} and \cite{livrevgrrfd}.
-In the {\tt Whisky} code it was decided to use the {\it method of lines} as a
+In the {\tt GRHydro} code it was decided to use the {\it method of lines} as a
base for the HRSC scheme. The method of lines is a way of turning a
partial differential equation such as~(\ref{eq:consform1}) into an
-ordinary differential equation. For the {\tt Whisky} code the following steps
+ordinary differential equation. For the {\tt GRHydro} code the following steps
are required.
\begin{itemize}
\item Partition the domain of interest into {\it cells}. For
simplicity we shall assume a regular Cartesian partitioning. This is
- not necessary for the method of lines, but it is for {\tt Whisky}.
+ not necessary for the method of lines, but it is for {\tt GRHydro}.
\item Over a given cell with Cartesian coordinates $(x^1_i, x^2_j, x^3_k)$,
integrate equation~(\ref{eq:consform1}) in space to find the
ordinary differential equation
@@ -465,7 +465,7 @@ are required.
\end{itemize}
This ordinary differential equation can be solved by the Cactus thorn
-MoL. All that {\tt Whisky} has to do is to return the values of the discrete
+MoL. All that {\tt GRHydro} has to do is to return the values of the discrete
spatial differential operator
\begin{eqnarray}
\label{eq:molrhs1} \nonumber
@@ -488,7 +488,7 @@ accurate in time. For more details on the method of lines, and the
options given with the time integration for MoL, see the relevant
chapter in the ThornGuide.
-In this implementation of {\tt Whisky} the right hand side operator ${\bf L}$
+In this implementation of {\tt GRHydro} the right hand side operator ${\bf L}$
will be simplified considerably by approximating the integrals by the
midpoint rule to get
\begin{equation}
@@ -542,7 +542,7 @@ of the right hand side operator splits simply into the following two parts:
\end{enumerate}
\end{enumerate}
-So, the difficult part of {\tt Whisky} is expressed in two routines. One that
+So, the difficult part of {\tt GRHydro} is expressed in two routines. One that
reconstructs the function ${\bf q}$ at the boundaries of a
computational cell given the cell average data $\bar{{\bf q}}$, and
another that calculates the intercell flux ${\bf f}$ at this cell
@@ -551,7 +551,7 @@ boundary.
\section{Reconstruction}
\label{sec:recon}
-In the reduction of all of {\tt Whisky} to two routines in the last section
+In the reduction of all of {\tt GRHydro} to two routines in the last section
one point was glossed over. That is, in order for the numerical method
to be consistent and convergent it must retain conservation and not
introduce spurious oscillations. Up to this point all the steps have
@@ -630,7 +630,7 @@ Equations (\ref{First_qTVD}) and (\ref{Toro_qTVD}) are equivalent.
For details on how to construct a limiter, on their stability regions and on
the explicit expressions for the limiters used here,
-see~\cite{toro}. The {\tt Whisky} code implements the {\tt minmod} limiter
+see~\cite{toro}. The {\tt GRHydro} code implements the {\tt minmod} limiter
(the most diffusive and the default), the Van Leer Monotonized Centred
(MC) ({\tt VanLeerMC}) limiter in a number of forms (which should give equivalent results),
and the {\tt Superbee} limiter. The limiter specified by the parameter value {\tt VanLeerMC2}
@@ -664,7 +664,7 @@ and write
The piecewise parabolic method (PPM) of Colella and
Woodward~\cite{ppm} is a rather more complex method that requires a
-number of steps. The implementation in the {\tt Whisky} code is specialized
+number of steps. The implementation in the {\tt GRHydro} code is specialized
to use evenly spaced grids. Also, some of the more complex features are not
implemented; in particular, the dissipation algorithm is only the
simplest given in the original article. Here we just give the implementation
@@ -774,7 +774,7 @@ and $\omega_0, \omega_1,\omega_2$ are constants.
The above flattening procedure is not the one in the original article of Colella and Woodward, but
it has been adapted from it in order to have a stencil of three points. The original flattening
-procedure is also implemented in {\tt Whisky}. Instead of \ref{eq:ppmflatten}, it consists in the formula
+procedure is also implemented in {\tt GRHydro}. Instead of \ref{eq:ppmflatten}, it consists in the formula
\begin{equation}
\label{eq:ppmflatten-stencil4}
q_i^{L,R} = \tilde \nu_i q_i^{L,R} + (1 - \tilde \nu_i) q_i,
@@ -1230,10 +1230,10 @@ Then the numerical flux is given by
The above implementation is based on \cite{Aloy99b}.
-\section{Other points in {\tt Whisky}}
+\section{Other points in {\tt GRHydro}}
\label{sec:misc}
-There are a number of other things done by {\tt Whisky} which, whilst not as
+There are a number of other things done by {\tt GRHydro} which, whilst not as
important as reconstruction and evolution, are still essential.
@@ -1249,7 +1249,7 @@ There are a few points to note about the calculation of the sources.
metric and the extrinsic curvature.
\item In order to calculate the Christoffel symbols the gauge and
metric variables must be differenced. Currently centred differencing
- of second or fourth (we are safe to use this, as {\tt Whisky} requires
+ of second or fourth (we are safe to use this, as {\tt GRHydro} requires
always at least 2 ghost zones) order is hardwired in. The two differencings can be selected via
the parameter {\tt ADMMacros/spatial\_order}.
\item For numerical reasons, namely in order to avoid the presence of time derivatives
@@ -1787,7 +1787,7 @@ problem; by rearranging the order of the eigenvalues and vectors it is
possible to numerically invert the matrix.
This means that no specific ordering of the eigenvalues should be
assumed. It also explains the slightly strange ordering in the
-routines {\tt Whisky\_EigenProblem*.F90}.
+routines {\tt GRHydro\_EigenProblem*.F90}.
The current default is that the left eigenvectors are calculated
analytically - for the expressions see Font~\cite{livrevgrrfd}. For
@@ -1810,13 +1810,13 @@ To avoid this problem it is customary to introduce an atmosphere. In our impleme
low-density region surrounding the compact objects and initially it has no velocity and is in equilibrium. The
introduction of an atmosphere is managed by the initial data thorns.
-However {\tt Whisky} itself also knows about the atmosphere, of course. If the conserved variables
+However {\tt GRHydro} itself also knows about the atmosphere, of course. If the conserved variables
$D$ or $\tau$ are beneath some minimum value, or an evolution step might push them below such a
value, then the relevant cell is not evolved. Also, if the density should fall below a minimum value
in the routine that converts from conservative to primitive variables, all the variables are reset
to the values adopted for the atmosphere.
-Probably the hardest part of using {\tt Whisky} is to correctly set these
+Probably the hardest part of using {\tt GRHydro} is to correctly set these
atmosphere values. In the current implementation the atmosphere is
used in three separate places. These are
\begin{enumerate}
@@ -1861,14 +1861,14 @@ density.
The parameters controlling the atmosphere are the following.
\begin{itemize}
-\item {\tt Whisky::rho\_abs\_min}. An absolute value for $\rho$ in the
+\item {\tt GRHydro::rho\_abs\_min}. An absolute value for $\rho$ in the
atmosphere. Defaults to -1. Any negative value will be ignored, and
the value of {\tt rho\_rel\_min} used instead.
-\item {\tt Whisky::rho\_rel\_min}. A relative value for $\rho$ in the
+\item {\tt GRHydro::rho\_rel\_min}. A relative value for $\rho$ in the
atmosphere. Defaults to $10^{-7}$. Only used if {\tt rho\_abs\_min}
is negative, which is the default behaviour. The actual value of the
atmosphere will be $\rho =${\tt rho\_rel\_min}$\times${\tt
- whisky\_rho\_max}, where {\tt Whisky::whisky\_rho\_max}
+ GRHydro\_rho\_max}, where {\tt GRHydro::GRHydro\_rho\_max}
is a variable containing the maximum value of $\rho$ on the numerical grid at time zero.
\item {\tt initial\_rho\_abs\_min}. An absolute value for rho in the initial atmosphere. It is used
only by initial data routines. Unused if negative.
@@ -1878,9 +1878,9 @@ The parameters controlling the atmosphere are the following.
\item {\tt initial\_atmosphere\_factor}. A relative (to the initial atmosphere) value for rho in the
atmosphere. It is used only by initial data routines. It multiplies the atmosphere value used by
the initial data solver. Unused if negative.
-\item {\tt whisky\_atmo\_tolerance}. A parameter useful mostly in mesh-refined simulations. A point
+\item {\tt GRHydro\_atmo\_tolerance}. A parameter useful mostly in mesh-refined simulations. A point
is set to the atmosphere values in the conservative to primitive routines if its rest-mass density
- is such that $\rho <$ {\tt whisky\_rho\_min}$*(1+${\tt whisky\_atmo\_tolerance}). This avoids
+ is such that $\rho <$ {\tt GRHydro\_rho\_min}$*(1+${\tt GRHydro\_atmo\_tolerance}). This avoids
occasional spurious oscillations in ({\tt Carpet}) buffer zones lying in the atmosphere (because
prolongation happens on conserved variables).
\end{itemize}
@@ -1891,7 +1891,7 @@ avoids truncation error and metric evolution leading to low density waves travel
atmosphere.
The routines essential to the atmosphere are contained in {\tt
-Whisky\_Minima.F90, Whisky\_Con2Prim.F90, Whisky\_UpdateMask.F90}.
+GRHydro\_Minima.F90, GRHydro\_Con2Prim.F90, GRHydro\_UpdateMask.F90}.
\subsection{Advection of passive scalars ('tracers')}
\label{sec:tracer}
@@ -1913,20 +1913,20 @@ equation looks like
\partial_t { ( D X_k )} + \partial_{x^j} {\bf f}^{(j)} ({D X_k}) = 0\, ,
\end{equation}
where $D$ is the generalized particle number density as defined in
-Eq.~(\ref{eq:prim2con}). {\tt Whisky} currently supports any number of
+Eq.~(\ref{eq:prim2con}). {\tt GRHydro} currently supports any number of
independent tracer variables. The following parameters have to be
set to use the tracers:
\begin{itemize}
- \item {\tt Whisky::evolve\_tracer}. Boolean. Set to {\tt yes} if
+ \item {\tt GRHydro::evolve\_tracer}. Boolean. Set to {\tt yes} if
you want the tracers to be active.
- \item {\tt Whisky::number\_of\_tracers}. Integer. Defaults to 0. To
+ \item {\tt GRHydro::number\_of\_tracers}. Integer. Defaults to 0. To
use tracers, set to at least 1.
\end{itemize}
Note, that your initial data thorn must set initial data for
-{\tt Whisky::tracer[k]} and {\tt Whisky::cons\_tracer[k]} for all tracers
-you want to advect. {\tt Whisky::cons\_tracer[k]} stores $D X_k$.
+{\tt GRHydro::tracer[k]} and {\tt GRHydro::cons\_tracer[k]} for all tracers
+you want to advect. {\tt GRHydro::cons\_tracer[k]} stores $D X_k$.
\subsubsection{Implementation and Limitations}
@@ -1958,7 +1958,7 @@ you want to advect. {\tt Whisky::cons\_tracer[k]} stores $D X_k$.
The above was suggested by Miguel Aloy and first implemented and
tested by Harry Dimmelmeier in his code (CoCoNuT), then by Christian~D.~Ott
- in {\tt Whisky}.
+ in {\tt GRHydro}.
\end{itemize}
@@ -1974,7 +1974,7 @@ The approximate time line is something like this:
\item ~1998-: Developed as Cactus thorn {\tt MAHC} inside the
GR{\tt Astro\_Hydro} arrangement at Washington University, primarily by
Mark Miller.
-\item 2002-: {\tt Whisky} written based on {\tt GR3D}.
+\item 2002-: {\tt GRHydro} written based on {\tt GR3D}.
\end{itemize}
This is necessarily only a sketch; many people have contributed to
@@ -1984,8 +1984,8 @@ the history of this code, and the present authors were not around for most of it
This was initially written by Luca Baiotti, Ian Hawke and Pedro
Montero with considerable assistance from Luciano Rezzolla, Toni Font,
-Nick Stergioulas and Ed Seidel. This led to the basic {\tt Whisky} thorns,
-{\tt Whisky} itself, {\tt Whisky\_Init\_Data} and {\tt Whisky\_RNSID}.
+Nick Stergioulas and Ed Seidel. This led to the basic {\tt GRHydro} thorns,
+{\tt GRHydro} itself, {\tt GRHydro\_Init\_Data} and {\tt GRHydro\_RNSID}.
Since then most of the maintenance has been done by Ian Hawke, Luca Baiotti and Frank L\"offler. Various
people have contributed to the development. In particular
@@ -1997,12 +1997,12 @@ people have contributed to the development. In particular
\item The current atmosphere algorithm is a mixture of ideas from the
{\tt GR3D} code, Luciano Rezzolla, Toni Font and Nick
Stergioulas. The current setup was written by Ian Hawke and Luca Baiotti.
-\item The 1-dimensional TOV solver {\tt Whisky\_TOVSolver} was written
+\item The 1-dimensional TOV solver {\tt GRHydro\_TOVSolver} was written
by Ian Hawke based on a short paper by Thomas Baumgarte.
%\item The use of the equation of state, in particular the routines to
% ensure the initial hydrodynamic consistency, were due to the work of
% Harald Dimmelmeier and Christian Ott.
-\item The initial value solver {\tt Whisky\_IVP} was initially a
+\item The initial value solver {\tt GRHydro\_IVP} was initially a
rewrite of the IVP solver written by Washington University (Malcolm
Tobias?) based on the formulation given by the Living Review of
Cook~\cite{Cook00}. For actually making it work thanks are due to