summaryrefslogtreecommitdiff
path: root/doc/UsersGuide/Infrastructure.tex
blob: 5ef50aa8d5ca1f5d7222af2ff06ae87f63bc7a29 (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
58
59
60
\begin{cactuspart}{3}{Infrastructure Thorn Writer's Guide}{$RCSfile$}{$Revision$}
\renewcommand{\thepage}{\Alph{part}\arabic{page}}

\chapter{Introduction} 
\label{sec:in}

\begin{itemize}
 \item{} Concepts and terminology (Overloading and registration of functions)
 \item{} The cGH structure --- what it is and how to use it
 \item{} Extending the cGH structure
 \item{} Querying group and variable information
 \item{} Providing an IO layer
 \item{} Providing a communication layer
 \item{} Providing a reduction operator
 \item{} Providing an interpolation operator
 \item{} Overloadable functions
\end{itemize}


 \section{Overloadable functions}

 \subsection{Core functions}
 \begin{tabular}{|l|l|}
   \hline  {\bf Function} & {\bf Default} \\
   \hline {\t CCTK\_Initialise} 	&\\
   \hline {\t CCTK\_Evolve}	&\\
   \hline {\t CCTK\_Shutdown}	&\\
   \hline
 \end{tabular}

 \subsection{IO Functions}
 \begin{tabular}{|l|l|} 
   \hline {\bf Function} & {\bf Default} \\
   \hline {\t CCTK\_OutputGH} & \\
   \hline {\t CCTK\_OutputVarAsByMethod} & \\
   \hline
 \end{tabular}

  \subsection{Driver functions}
  \begin{tabular}{|l|l|}
   \hline {\bf Function} & {\bf Default} \\
   \hline {\t CCTK\_SyncGroup} 		&\\
   \hline {\t CCTK\_EnableGroupStorage}	&\\
   \hline {\t CCTK\_DisableGroupStorage}	&\\
   \hline {\t CCTK\_EnableGroupComm}		&\\
   \hline {\t CCTK\_DisableGroupComm}		&\\
   \hline {\t CCTK\_Barrier}			&\\
   \hline {\t CCTK\_Reduce}			&\\
   \hline {\t CCTK\_Interp} 			&\\
   \hline {\t CCTK\_ParallelInit}		&\\
   \hline {\t CCTK\_Init}			&\\
   \hline {\t CCTK\_Exit}			&\\
   \hline {\t CCTK\_Abort}			&\\
   \hline {\t CCTK\_SetupGH}			&\\
   \hline
  \end{tabular}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{cactuspart}