aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorallen <allen@c78560ca-4b45-4335-b268-5f3340f3cb52>2002-05-09 12:52:03 +0000
committerallen <allen@c78560ca-4b45-4335-b268-5f3340f3cb52>2002-05-09 12:52:03 +0000
commite5f7adc42e24484c73724efc4a8388c75a10eab2 (patch)
tree4a1f062d09910d8cb933f1984729e9ab02b952e6
parent7bef905d9fce5e98ac9f457bedffcafa61fa0255 (diff)
removing stuff with gives the thornguide problems
git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/CartGrid3D/trunk@157 c78560ca-4b45-4335-b268-5f3340f3cb52
-rw-r--r--doc/documentation.tex27
1 files changed, 11 insertions, 16 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 35e02b8..9642dff 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -1,24 +1,19 @@
\documentclass{article}
-\def\eg{\hbox{eg.}}
-\def\ie{\hbox{i.e.}}
-
\begin{document}
\title{CartGrid3D}
-\author{Gabrielle Allen, Gerd Lanfermann, Joan Masso;\\
- this documentation by Jonathan Thornburg}
-\date{$ $Id$ $}
+\author{Gabrielle Allen, Gerd Lanfermann, Joan Masso, Jonathan Thornburg}
+\date{$Date$}
\maketitle
\abstract{
{\tt CartGrid3D} allows you to set up coordinates on a 3D Cartesian
grid in a flexible manner. You can choose different grid domains
-(\eg{} octant) to allow you to exploit any symmetry in your problem.
+({\it eg} octant) to allow you to exploit any symmetry in your problem.
{\tt CartGrid3D} also provides routines for registering symmetries
of grid functions and applying symmetry conditions across the
-coordinate axes.
- }
+coordinate axes. }
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -76,9 +71,9 @@ chapter of the Cactus Users' Guide.)
\section{Specifying the Grid Size, Range, and Spacing}
\verb|CartGrid3D| provides several different methods for setting
-up the integer {\em grid size\/} (\eg{} 128), floating-point
-{\em grid spacing\/} (\eg{} 0.1), and floating-point {\em grid range\/}
-(\eg{} 12.8).%%%
+up the integer {\em grid size\/} ({\it eg} 128), floating-point
+{\em grid spacing\/} ({\it eg} 0.1), and floating-point {\em grid range\/}
+({\it eg} 12.8).%%%
\footnote{%%%
If you're AMR-ing, this all refers to the
coarsest or base grid.%%%
@@ -128,7 +123,7 @@ $y$, and/or $z$ coordinate exactly equal to 0:
(\verb|grid::avoid_originx = "true"| or
\verb|grid::avoid_originx = "yes"| or
\verb|grid::avoid_originx = 1|) then the grid will be
- ``half-centered'' across $x=0$, \ie{} there will be
+ ``half-centered'' across $x=0$, {\it ie} there will be
grid points at
\dots,
$x = - \frac{3}{2} \Delta x$,
@@ -142,7 +137,7 @@ $y$, and/or $z$ coordinate exactly equal to 0:
\item[{\tt grid::avoid\_originz}]\mbox{}\\
Same thing for $z$.
\item[{\tt grid::avoid\_origin}]\mbox{}\\
- Same thing for all 3 axes $x$ and $y$ and $z$, \ie{}
+ Same thing for all 3 axes $x$ and $y$ and $z$, {\it ie}
no grid point will have $x=0$ or $y=0$ or $z=0$.
\end{description}
@@ -197,7 +192,7 @@ includes the range of floating-point coordinates $z \in [-0.2,3.0]$.
The original specification of 33~grid points is left alone, however,
so the grid points have integer array indices $[0,32]$ (C) or
$[1,33]$ (Fortran).
-The ``physical'' (\ie{} non-symmetry-zone) part of the grid is
+The ``physical'' ({\it ie} non-symmetry-zone) part of the grid is
precisely the originally-specified range, $z \in [0.0,3.0]$, and
has the integer array indices $[2,32]$ (C) or $[3,33]$ (Fortran).
@@ -210,7 +205,7 @@ has the integer array indices $[2,32]$ (C) or $[3,33]$ (Fortran).
The Cartesian coordinates supplied by this thorn are grid functions
with the standard names \verb|x|, \verb|y|, and \verb|z|. To use
-these coordinates you need to inherit from \verb|grid|, \ie{} you
+these coordinates you need to inherit from \verb|grid|, {\it ie} you
need to have an
\begin{verbatim}
inherits: grid