aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrideout <rideout@0cbbb82d-14ec-4423-a1fb-2ab18257ecaa>2002-07-11 15:39:25 +0000
committerrideout <rideout@0cbbb82d-14ec-4423-a1fb-2ab18257ecaa>2002-07-11 15:39:25 +0000
commit779f0b9e0aff1d0938a478bc4e5978f514b6edf4 (patch)
treeed8f4143adff9f75fbfc364eb870ea4f58a71979
parent87caa75fefa1d255687a8833f51a462909b77cb5 (diff)
minor fixes
git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinBase/StaticConformal/trunk@14 0cbbb82d-14ec-4423-a1fb-2ab18257ecaa
-rw-r--r--doc/documentation.tex26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index c3c8795..7a535e0 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -26,7 +26,7 @@ Base thorn to provide the variables for the static conformal factor
This thorn provides the variables defining a static conformal factor
which is used to transform the physical metric. If this thorn is
active and the {\tt ADMBase::metric\_type} parameter is set to
-{\tt static conformal} then the {\tt ADMBase::g...} variables are the
+``{\tt static conformal}'' then the {\tt ADMBase::g...} variables are the
conformal values as opposed to the physical values.
The transformation is
@@ -47,8 +47,8 @@ common use of the derivative. I.e. the grid functions are
\begin{eqnarray*}
{\tt psi} &=& \psi, \\
- {\tt psix} &=& \psi_x/\psi, \qquad {\mbox etc}\\
- {\tt psixx} &=& \psi_{ij}/\psi \qquad {\mbox etc}
+ {\tt psix} &=& \psi_x/\psi, \qquad \mbox{etc}\\
+ {\tt psixx} &=& \psi_{ij}/\psi \qquad \mbox{etc}
\end{eqnarray*}
Thorns need to check the value of the grid scalar
@@ -57,7 +57,7 @@ actually been calculated before using the conformal factor:
\begin{description}
\item[{\tt conformal\_state=0}]
-No conformal factor has been calculated -- thorns may
+No conformal factor has been calculated --- thorns may
assume the conformal factor is 1 at all points. (I.e. the metric is physical.)
\item[{\tt conformal\_state=1}]
The conformal factor has been calulated, but no derivatives.
@@ -73,7 +73,7 @@ the values for the conformal factor you can check for {\tt conformal\_state > 0}
\section{Utilities}
{\tt StaticConformal} provides functions to convert between physical and conformal 3-metric values. It is very important to understand that these functions
-apply the conversion {\it in place}. That is, if {\tt gxx} contains the conformal metric value, when the routine is exited it will now contain the physical metric value. This functions {\it do not} change the value of {\tt conformal\_state} and should be used with due care. (These functions are for example used
+apply the conversion {\it in place}. That is, if {\tt gxx} contains the conformal metric value, when the routine is exited it will now contain the physical metric value. These functions {\it do not} change the value of {\tt conformal\_state} and should be used with due care. (These functions are for example used
by some analysis thorns who work only with the physical metric, they apply the
transformation on entry to the analysis routine and switch it back on exit).
@@ -125,17 +125,17 @@ The {\tt StaticConformal} thorn itself does not calculate any conformal
factor, but does initialise the {\tt conformal\_state} variable to 0.
Please note, no thorn should use the {\tt conformal\_state} variable
-unless the parameter {\tt metric\_type} is {\tt "static conformal"}.
+unless the parameter {\tt metric\_type} is {\tt ``static conformal''}.
The {\tt conformal\_state} variable is not assigned storage or
initialised by the StaticConformal thorn in any other case.
-However thorns are free to themselves assigned storage for
-{\tt conformal\_state} and initialise it to zero if {\tt metric\_type} is
-"physical". In this one case is it safe for them to use
-the conformal\_state variable if metric\_type is not "static
-conformal". This method allows them to use just one set of ifs rather
-than first checking the metric\_type and then the conformal\_state
-variable if the metric\_type is "static conformal".
+However thorns are free to themselves assign storage for {\tt
+conformal\_state} and initialise it to zero if {\tt metric\_type} is
+``physical''. In this one case it is safe for them to use the
+\texttt{conformal\_state} variable if \texttt{metric\_type} is not
+``static conformal''. This method allows them to use just one set of
+ifs rather than first checking the metric\_type and then the
+conformal\_state variable if the metric\_type is ``static conformal''.
% Do not delete next line
% END CACTUS THORNGUIDE