blob: 18350ce4f90554fe7cfe2cb79671742ee8c3ec5b (
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
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
% /*@@
% @file Preface.tex
% @date Wed Jan 12 14:37:52 2000
% @author Tom Goodale
% @date
%
% @enddesc
% @version $Header$
% @@*/
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
{\large \bf Preface}
\label{sec:pr}
\vskip .5cm
This document should describe the Cactus flesh. In particular
it should describe
\begin{itemize}
\item
The philosophy of the flesh
\item
The coding style used
\item
The make system
\item
The various source directories and all their files
\item
The perl scripts
\end{itemize}
In addition it should contain ideas for future enhancements.
\vskip .5cm
{\bf Overview of documentation}
\vskip .5cm
This guide covers the following topics
\begin{Lentry}
\item [{\bf Part A: Philosphy and Style.}]
The philosophy behind the flesh and the coding style used.
\item [{\bf Part B: The Make System.}]
The nitty-gritty of the make system.
\item [{\bf Part C: The CST.}]
The nitty-gritty of the CST.
\item [{\bf Part D: General.}]
General miscellaneous things used all over the flesh.
\item [{\bf Part E: Main.}]
Everything you never wanted to know about the files in the Main
subdirectory of the flesh.
\item [{\bf Part F: Comm.}]
Everything you never wanted to know about the files in the Comm
subdirectory of the flesh.
\item [{\bf Part G: IO.}]
Everything you never wanted to know about the files in the IO
subdirectory of the flesh.
\item [{\bf Part H: Util.}]
Everything you never wanted to know about the various utility
files.
\item [{\bf Part I: Schedule.}]
Everything you never wanted to know about the Schedule system.
\item [\bf Part J: Appendices.]
I'm sure we'll need something here.
\end{Lentry}
Other topics to be discussed in separate documents include:
\begin{Lentry}
\item [{\bf Computational Thorn Guide}] This will contain details about the
arrangements and thorns making up the standard Cactus Computation Tool Kit
\item [{\bf Relativity Thorn Guide}] This will contain details about the arrangements and thorns making up the Cactus Relativity Tool Kit, one of the major
motivators, and still the driving force, for the Cactus Code.
\item [{\bf Users' Guide}]
The stuff users need to know. This in particular documents
the functions the flesh needs to make available to the thorns.
\end{Lentry}
\vskip .5cm
{\bf Typographical Conventions}
\begin{Lentry}
\item[{\tt Typewriter}] Is currently used for everything you type,
for program names, and code extracts.
\item[{\tt < ... >}] Indicates a compulsory argument.
\item[{\tt [ ... ]}] Indicates an optional argument.
\end{Lentry}
\vskip .5cm
{\bf How to Contact Us}
\vskip .5cm
Please let us know of any errors or omissions in this guide, as well
as suggestions for future editions. These can be reported via our
bug tracking system at \url{http://www.cactuscode.org}, or via email to
{\tt cactusmaint@cactuscode.org}. Alternatively, write to us at
\vskip .5cm
The Cactus Team\\
Center for Computation \& Technology\\
216 Johnston Hall\\
Louisiana State University\\
Baton Rouge, LA 70803\\
USA
\vskip .5cm
{\bf Acknowledgements}
\vskip .5cm
Hearty thanks to all those who have helped with documentation for the
Cactus Code.
|
