aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation.tex35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..803222f
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,35 @@
+\documentclass{article}
+\begin{document}
+
+\title{SpaceMask}
+\author{Tom Goodale}
+\date{April 2002}
+\maketitle
+
+\abstract{Provides a mask function for the spatial slice variables}
+
+\section{Purpose}
+
+This will provide two integer grid functions
+
+space\_mask
+space\_table\_field
+
+the first one will be a bitmask describing the point, with one bit
+indicating that there is extra data in a table the handle of which can be
+found in the corresponding point in the space\_table\_field.
+
+Thorns interested in the mask should inherit from this implementation.
+
+There may also be aliased query functions provided.
+
+\section{Comments}
+
+
+
+% Automatically created from the ccl files by using gmake thorndoc
+\include{interface}
+\include{param}
+\include{schedule}
+
+\end{document}