From 1217bad7bc48d3285cc31d1e1e224a3bef11b451 Mon Sep 17 00:00:00 2001
From: jthorn <jthorn@edbb7e70-9571-45d5-a481-0a560a9b4751>
Date: Tue, 8 Jun 2004 13:46:50 +0000
Subject: cleanup latex typesetting -- function names and *.ccl snippets are
 now in \tt font, thorn names in \bf font

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinBase/CoordGauge/trunk@56 edbb7e70-9571-45d5-a481-0a560a9b4751
---
 doc/documentation.tex | 47 ++++++++++++++++++++++++-----------------------
 1 file changed, 24 insertions(+), 23 deletions(-)

(limited to 'doc')

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 0b268e9..03005fc 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -23,40 +23,40 @@ Base thorn to provide the infrastructure for dynamic gauge selection
 
 \section{Purpose}
 
-The CoordGauge implementation schedules five groups
+The {\bf CoordGauge} implementation schedules five groups:
 
+\begin{verbatim}
 CoordGauge
-
 LapseSelect IN CoordGauge BEFORE PickCoordGauge
 LapseApply  IN CoordGauge AFTER  PickCoordGauge
-
 ShiftSelect IN CoordGauge BEFORE PickCoordGauge
 ShiftApply  IN CoordGauge AFTER  PickCoordGauge
-
+\end{verbatim}
+%
 and one function
-
+\begin{verbatim}
 PickCoordGauge IN CoordGauge
-
+\end{verbatim}
+%
 and has two public grid scalars
-
-selected\_lapse
-selected\_shift
-
+\begin{verbatim}
+selected_lapse
+selected_shift
+\end{verbatim}
+%
 and two string parameters
-
-lapse\_list
-shift\_list
+\begin{verbatim}
+lapse_list
+shift_list
+\end{verbatim}
 
 It also provides four aliased functions
-
+%
 \begin{verbatim}
-
 int CoordGauge_RegisterLapse("lapse-name")
 int CoordGauge_RegisterShift("shift-name")
-
 CoordGauge_Lapse("lapse-name")
 CoordGauge_Shift("shift-name")
-
 \end{verbatim}
 
 (If someone can think of better names, please say so 8-)
@@ -67,18 +67,19 @@ selection routine and an application routine in the appropriate schedule
 groups.
 
 The selection routine decides if this gauge condition should be applied at
-this time, and calls the CoordGauge\_Lapse/Shift aliased function.  (It
-should check that it is actually in the appropriate parameter as a
+this time, and calls the \verb|CoordGauge_Lapse/Shift| aliased function.
+(It should check that it is actually in the appropriate parameter as a
 minimum.)
 
-The PickCoordGauge traverses the list of lapses/shifts and selects the
-first one in the list which has called the CoordGauge\_Lapse/Shift aliased
-function and sets the appropriate grid scalar to the id of this one.
+The \verb|PickCoordGauge| function traverses the list of lapses/shifts
+and selects the first one in the list which has called the
+\verb|CoordGauge_Lapse/Shift| aliased function and sets the
+appropriate grid scalar to the id of this one.
 
 The application routine checks to see if the grid scalar is set to its id,
 and if so, applies the gauge condition.
 
-Evolution thorns could schedule CoordGauge at the appropriate point or
+Evolution thorns could schedule {\bf CoordGauge} at the appropriate point or
 points in their schedule.
 
 An advantage of this scheme over the current one is that it provides the
-- 
cgit v1.2.3