User: knarf Date: 2011/11/13 01:18 AM

Modified: /trunk/doc/ documentation.tex

Log: some updates to the documentation

File Changes:

Directory: /trunk/doc/ ======================

File [modified]: documentation.tex Delta lines: +24 -68 =================================================================== --- trunk/doc/documentation.tex 2011-11-04 18:34:36 UTC (rev 298) +++ trunk/doc/documentation.tex 2011-11-13 07:18:46 UTC (rev 299) @@ -122,13 +122,15 @@ 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 some slight irregularities on the part of certain specialists in - strange stars.} code is a product of the EU Network on Sources of -Gravitational Radiation\footnote{http://www.eu-network.org%7D. It was initially written by Luca Baiotti, Ian Hawke -and Pedro Montero, based on the publicly available {\tt GR3D} code and with many other important -contributors. + strange stars.} code is based upon the public version of the {\tt Whisky} code which + is a product of the EU Network on Sources of + Gravitational Radiation\footnote{http://www.eu-network.org%7D, + and was initially written by Luca Baiotti, Ian Hawke + and Pedro Montero, based on the publicly available {\tt GR3D} code and + with many other important contributors. + With the help of large parts of the community, the {\tt GRHydro} code got + improved, extended and included into the Einstein Toolkit.

- - \section{Using This Thorn} \label{sec:use}

@@ -141,12 +143,9 @@ \begin{verbatim} http://www.einsteintoolkit.org \end{verbatim} -as well as the original {\tt Whisky} website at -\begin{verbatim} -http://www.whiskycode.org -\end{verbatim}

-{\tt GRHydro} provides the hydro variables and methods to evolve them. It +{\tt GRHydro} uses the hydro variables defined in {\tt HydroBase} +and provides own ``conserved'' 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 @@ -156,20 +155,16 @@ \end{verbatim} and will include the essential thorns \begin{verbatim} -GRHydro eos_base admbase admcoupling mol +GRHydro EOS_Omni ADMBase ADMCoupling MoL \end{verbatim} -Current thorns actually implementing equations of state include -\begin{verbatim} -eos_ideal_fluid eos_polytrope -\end{verbatim} Initial data for shocks can be set using \begin{verbatim} -GRHydro_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} -GRHydro_tovsolverc +TOVSolver \end{verbatim}

The actual evolution in time is controlled by the Method of Lines @@ -223,8 +218,6 @@

The public version of GRHydro can be found on the website {\tt http://www.einsteintoolkit.org%7D. -The latest public version of Whisky can be found on the -website {\tt http://www.whiskycode.org%7D.

\subsection{Basic Usage}

@@ -255,7 +248,7 @@ have compiled in. \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. + objects such as single stars. However, this parameter is depreciated. \item Atmosphere parameters: Many of these are listed in section~\ref{sec:atmosphere}. \end{itemize} @@ -280,16 +273,12 @@ the {\tt MoL} evolution method without change. This (currently) allows for up to fourth-order accuracy in time without any changes to {\tt GRHydro}.

-For the general equations of state {\tt GRHydro} uses the {\tt EOS_Base} +For the general equations of state {\tt GRHydro} uses the {\tt EOS_Omni} interface. This returns the necessary hydrodynamical quantities, such as the pressure and derivatives with general function calls. The parameter {\tt GRHydro_eos_table} controls which equation of state is -used during evolution. +used during evolution.

-{\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 GRHydro} uses the standard {\tt CactusEinstein} arrangement, especially {\tt ADMBase}. This allows the standard thorns to be used for the calculation of constraint @@ -298,44 +287,14 @@

\subsection{Support and Feedback}

-The {\tt GRHydro} web page is located at +{\tt GRHydro} is part of the Einstein Toolkit, with its web page located at \begin{verbatim} http://www.einsteintoolkit.org \end{verbatim} -and contains information on obtaining the code, together with -thornlists and sample parameter files. There is also a section on -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. +It contains information on obtaining the code, together with +thornlists and sample parameter files. For questions, send an email +to the Einstein Toolkit mailing list {\tt users@einsteintoolkit.org}.

-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 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 GRHydro} depends on should go direct to their -maintainers. Examples would be -\begin{itemize} -\item {\tt MoL}: Ian Hawke ({\tt hawke@aei.mpg.de}) -\item {\tt ADM_BSSN}: Denis Pollney ({\tt pollney@aei.mpg.de}) or Ian Hawke ({\tt - hawke@aei.mpg.de}) -\item {\tt ADMBase, ADMCoupling, StaticConformal}: The Cactus team - ({\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 GRHydro_Init_Data}: Luca Baiotti ({\tt baiotti@yukawa.kyoto-u.ac.jp}) or - Ian Hawke ({\tt hawke@aei.mpg.de}) -\item {\tt GRHydro_TOVSolverC}: Ian Hawke ({\tt hawke@aei.mpg.de}) or 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} - \section{Physical System} \label{sec:phys}

@@ -1981,7 +1940,8 @@ \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-2008: {\tt Whisky} written based on {\tt GR3D}. +\item 2008-: {\tt GRHydro} based on the public version of {\tt Whisky} \end{itemize}

This is necessarily only a sketch; many people have contributed to @@ -2009,11 +1969,6 @@ %\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 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 - Frank L"offler and Luca Baiotti. \end{itemize}

\subsection{Thorn Documentation} @@ -2044,7 +1999,8 @@ EU Network, especially Toni Font, Luciano Rezzolla, Nick Stergioulas, Ed Seidel, Carsten Gundlach and Jos'e-Maria Ib{'a}{~n}ez.

-Originally Ed Seidel and then Luciano Rezzolla have been granting (in addition to valuable +Originally Ed Seidel and then Luciano Rezzolla and Gabrielle Allen and many others +have been granting (in addition to valuable scientific advice) financial support and human resources to the development of the code.

\begin{thebibliography}{20}