aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcott <cott@8e189c6b-2ab8-4400-aa02-70a9cfce18b9>2011-04-20 00:39:48 +0000
committercott <cott@8e189c6b-2ab8-4400-aa02-70a9cfce18b9>2011-04-20 00:39:48 +0000
commitca8f2f01872319bb62037d81e70cea1a579c700d (patch)
treea86882d983a89e2569eb9cedad00ee8056551ed6
parented8effae1927c8a11878f601b64c8d76cbcf52fa (diff)
* describe finite-temperature nuclear EOS
git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinEOS/EOS_Omni/trunk@45 8e189c6b-2ab8-4400-aa02-70a9cfce18b9
-rw-r--r--doc/documentation.tex23
1 files changed, 20 insertions, 3 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index c21b0ef..55b9e94 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -342,10 +342,27 @@ The \texttt{EOS\_Omni} parameters for the hybrid EOS are the following:
-\subsection{Finite-Temperature Nuclear}
+\subsection{Finite-Temperature Nuclear EOS}
+
+Complex microphysical finite-temperature equations of state come
+usually in tabulated form. {\tt EOS\_Omni} comes with routines
+provided as part of the \texttt{nuc\_eos} package described in
+\cite{oconnor:10} and available at \\ {\tt
+ http://www.stellarcollapse.org}. A variety of EOS tables for
+application in high-density astrophysical situations (i.e. in stellar
+collapse or in compact star mergers) are also available from there
+in HDF5 format.
+
+The parameters controlling the finite-temperature nuclear EOS
+are the following:
+
+\begin{tabular}{lll}
+\texttt{nuceos\_read\_table}& BOOLEAN & Set to {\tt yes} to read table.\\
+\texttt{do\_energy\_shift}& BOOLEAN & Set to {\tt yes} to subtract the energy shift\\
+&& stored in the table to get correctly normalized $\epsilon$.\\
+\texttt{nuceos\_table\_name}& STRING & Path/Name of the table file.
+\end{tabular}
-\textbf{TODO: Not yet documented; not even mentioned yet in some other
- sections of this documentation.}