EOS_Omni: update documentationsvn

From: Roland Haas <rhaas@tapir.caltech.edu>

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinEOS/EOS_Omni/trunk@106 8e189c6b-2ab8-4400-aa02-70a9cfce18b9

1 files changed, 16 insertions, 3 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 8bbee49..65d5e86 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -113,9 +113,10 @@ Erik Schnetter \textless eschnetter@perimeterinstitute.ca\textgreater}
   interface and implements multiple analytic EOS, and also provides table
   reader and interpolation routines for finite-temperature
   microphysical EOS available from
-    \url{http://www.stellarcollapse.org}. Currently, the implemented
-  analytic EOS are the polytropic EOS, the gamma-law EOS, and a hybrid EOS
-  consisting of a 2-piece piecewise-polytrope with an a thermal,
+    \url{http://www.stellarcollapse.org}. In addition cold and barotropic
+  tabulated EOS are provided for use in initial data thorns. Currently, the
+  implemented analytic EOS are the polytropic EOS, the gamma-law EOS, and a
+  hybrid EOS consisting of a 2-piece piecewise-polytrope with a thermal,
   gamma-law component.
 \end{abstract}
 
@@ -173,6 +174,7 @@ Here,
       for stellar core collapse simulations.
     \item \texttt{eoskey = 4}: Finite-temperature microphysical EOS
     \item \texttt{eoskey = 5}: Cold tabulated EOS with Gamma-Law
+    \item \texttt{eoskey = 6}: Tabulated barotropic EOS
   \end{itemize}
 \item \texttt{havetemp} determines whether the EOS is to be called as
   a function of $(\rho,\epsilon,Y_e)$ (\texttt{havetemp = 0}), or as a
@@ -211,9 +213,20 @@ wrong. This is also true for the Einstein Toolkit GR hydro code
 
 \begin{verbatim}
 eos_omni::poly_gamma 
+eos_omni::poly_gamma_initial
 eos_omni::poly_k 
 \end{verbatim}
 
+The only non-obvious parameter here is \texttt{poly\_gamma\_initial}.
+In most simulations it should not be set.
+In simulations that are run with a different adiabatic index than
+what was used to set up the initial data, \texttt{poly\_gamma} should
+be the evolution value, and \texttt{poly\_gamma\_initial} should be the
+initial data value. \texttt{EOS\_Omni} then rescales \texttt{poly\_k} such
+that the \emph{cgs} value of \texttt{poly\_k} is the same for initial data and
+evolution. Since the units of \texttt{poly\_k}
+($[K] = \frac{\rm N}{\rm m^2} \left(\frac{\rm m^3}{\rm kg}\right)^{\Gamma}$)
+depend on \texttt{poly\_gamma} this is not fully trivial.
 
 Check \texttt{param.ccl} for parameters for the other EOS\@.