aboutsummaryrefslogtreecommitdiff
path: root/doc/documentation.tex
blob: 47b088ea644ab58d9018a0613185d114ea687acf (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
45
46
47
48
49
50
51
52
53
54
55
56
57
\documentclass{article}
\begin{document}

\title{ADMBase}
\author{Tom Goodale}
\date{April 2002}
\maketitle

\abstract{Provides the basic ADM variables used in the $3+1$ formalism}

\section{Purpose}

This thorn provides the basic variables used to communicate between
thorns doing General Relativity in the $3+1$ formalism.

The variables are:
\begin{itemize}
\item
The metric tensor -- {\bf gxx}, {\bf gxy}, {\bf gxz},{\bf gyy},{\bf gyz},{\bf gzz}
\item
The extrinsic curvature tensor -- {\bf kxx}, {\bf kxy}, {\bf kxz},{\bf kyy},{\bf kyz},{\bf kzz}
\item
The lapse -- {\bf alp}
\item
The shift -- {\bf betax},{\bf betay},{\bf betaz}
\end{itemize}

By default the metric and extrinsic curvature tensors are assumed to
be the physical ones, however these semantics can be changed by use of
the {\bf metric\_type} parameter.  ADMBase provides the default value
of `physical', however another thorn could extend this with a value
stating that the metric or curvature have some conformal factor or
whatever.  This means that all thorns which inherit from ADMBase
should check the value of {\bf metric\_type} in a routine scheduled at
{\bf CCTK\_PARAMCHECK} and signal an error if the thorn does not
recognise the value.

ADMBase allocates one timelevel of memory for all variables, except the
shift, which is only allocated if the {\bf initial\_shift} parameter is
set to a value other than `none'.  The state of the shift storage is
indicated by the {\bf shift\_state} grid scalar.  This is 1 if there
is storage for the shift, and 0 otherwise.

The thorn provides, on request, initial data to set the metric and
extrinsic curvature to flat space in cartesian coordinates, to set the
initial lapse to one and the initial shift to zero.

\section{Comments}



% Automatically created from the ccl files by using gmake thorndoc
\include{interface}
\include{param}
\include{schedule}

\end{document}