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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
\part{Application thorn writing}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Thorn concepts}
(This section has to contain enough explanation to make the rest of
the writers guide readable the first time through)
(The hardest bugs to find are
those arising from plausible but incorrect assumptions about the
behavior of someone else's thorn.)
a) Again probably emphasize collaboration, what are thorns,
packages, how to share them.
b) Things to think about before you start programming:
Language, read all the documentation, emphasize use of
standard supported Cactus infrastructure
c) Available data types
i) Scalars
ii) Arrays and GFs
iii) Groups
d) Ghost zones and parallelism
e) Understanding the RFR concept
f) Understanding the GH concept
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Anatomy of a thorn}
Each thorn must be in a package. Packages are fairly informal. If you
want, you can just make your own package directory, and stick your new
thorn into it.
a) Creating a thorn (gmake new thorn)
b) Thorn directory structure
c) Thorn make files
d) Thorn configuration
(i) Parameters (param.ccl)
(ii) Variables (interface.ccl)
(iii) Scheduler (schedule.ccl)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Putting code into your thorn}
\section{What the F***h provides}
Header files, macros ...
\section{Argument lists and parameters}
\section{A First Example (Baloney)}
\section{Programming language differences}
\section{A more complex example (WaveToy)}
\section{Error handling, Warnings and Code Termination}
There are two CCTK commands to use for stopping the code
from within your thorn:
\begin{itemize}
\item{} To shut the code down cleanly, use
{\t
\begin{verbatim}
CCTK_Stop(pointer GH, INTEGER return_code)
CCTK_Stop(cGH *GH, int return_code);
\end{verbatim}
}
\item{} To shut the code down more violently, use
{\t
\begin{verbatim}
CCTK_Abort(pointer GH, INTEGER return_code)
CCTK_Abort(cGH *GH, int return_code);
\end{verbatim}
}
\end{itemize}
In both cases, an error code should be returned indicating the
error that you trapped which precipitated the code shutdown.
The error codes are detailed in the following table:
{\bf ACTION: Fill in the table QUERY}.
\section{Calls between different programming languages}
\subsection{Calling C routines from FORTRAN}
\subsection{Calling FORTRAN routines from C}
\section{Programming Style Guidelines and Recommendations}
\section{Adding a test suite}
\section{Sharing your thorns/packages with others}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
