aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
blob: 5376ec6b8494e9b13871d0838a002a9ac64acb29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
\documentclass{article}

% Use the Cactus ThornGuide style file
% (Automatically used from Cactus distribution, if you have a 
%  thorn without the Cactus Flesh download this from the Cactus
%  homepage at www.cactuscode.org)
\usepackage{../../../../doc/ThornGuide/cactus}

\begin{document}

\title{SpaceMask}
\author{Tom Goodale}
\date{$ $Date$ $}

\maketitle

% Do not delete next line
% START CACTUS THORNGUIDE

\begin{abstract}
Provides a mask function for the spatial slice variables
\end{abstract}

\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}

% Do not delete next line
% END CACTUS THORNGUIDE

\end{document}