aboutsummaryrefslogtreecommitdiff
path: root/src/README
blob: 0ee1180cd43f49ae9dd28900634d6e70991d8183 (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
This is the top-level source directory for the AHFinderDirect thorn.
See ../doc/ for further documentation.

The main subdirectories under this directory are:
driver/		high-level driver routines to solve the H(h) = 0
		equations and interface to the rest of Cactus
elliptic/	code to solve elliptic equations on the multipatch $S^2$
gr/		relativity code; all knowledge of the actual apparent
		horizon equation lives in the code in this directory
gr.cg/		Maple-generated code to compute the H(h) function
		and its Jacobian coefficients
patch/		basic multipatch infrastructure for storing and
		finite differencing gridfns in angular coordinates
		on the surface of a 2-sphere
jtutil/		low-level utility library in C++ namespace jtutil::
		(templates and inline functions for things like
		integer <--> floating-point linear maps, fuzzy
		floating-point comparisons, N-dimensional arrays, etc)
include/	common header files which don't live in any other
		source directory
misc/		misc source code that doesn't fit anywhere else,
		including the 'mpp' Maple preprocessor used by the
		Maple code in other directories
maple/		Maple code to generate C/C++ from complicated expressions