diff options
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r-- | doc/documentation.tex | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex new file mode 100644 index 0000000..5cefc97 --- /dev/null +++ b/doc/documentation.tex @@ -0,0 +1,39 @@ +\documentclass{article} +\begin{document} + +\title{CartGrid3D} +\author{Gabrielle Allen, Gerd Lanfermann} +\date{1999} +\maketitle + +\abstract{Cartesian coordinates and symmetries for 3D grids} + +\section{Purpose} + +Allows you to set up coordinates on a 3D Cartesian grid in a +flexible manner. Different grid domains (e.g. octant) can +be chosen to allow you to exploit any symmetry in your +problem. Routines for registering symmetries of grid functions +and applying symmetry conditions across the coordinate axes +are provided. + +\section{Comments} + +\subsection{Coordinates} + +The Cartesian coordinates supplied by this thorn are +grid functions with the standard names {\tt x}, {\tt y}, and +{\tt z}. To use these coordinates you need to {\tt inherit} +from {\tt grid}. The coordinates are +registered with the flesh using the same names "x", "y" +and "z". In addition a grid function {\tt r} (registered as +"r") is provided, containing the radius from the origin. + + + +% Automatically created from the ccl files by using gmake thorndoc +\include{interface} +\include{param} +\include{schedule} + +\end{document} |