diff options
Diffstat (limited to 'src/README')
| -rw-r--r-- | src/README | 41 |
1 files changed, 24 insertions, 17 deletions
@@ -1,24 +1,31 @@ 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 Theta(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 Theta(h) function - and its Jacobian coefficients -patch/ basic multipatch infrastructure for storing and - finite differencing gridfns in angular coordinates +In this directory, +CODESTYLE documents some general programming conventions I have + used in this thorn +driver/ contains high-level driver routines to solve the + Theta(h) = 0 equations and interface to the rest of Cactus +elliptic/ contains code to solve elliptic equations on the multipatch + $S^2$ +gr/ contains relativity code; all knowledge of the actual + apparent horizon equation lives in the code in this directory +gr.cg/ contains Maple-generated code to compute the Theta(h) + function and its Jacobian coefficients +patch/ contains the 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:: +jtutil/ contains various low-level utility routines (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 + floating-point comparisons, N-dimensional arrays, etc); + except for one C function which will disappear once + Tom Goodale commits some pending Cactus-flesh changes) + all this code lives in the C++ namespace jtutil:: +include/ contains 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 +misc/ contains misc source code that doesn't fit anywhere else, + including the 'mpp' Maple preprocessor used by the Maple + code in other directories +maple/ contains Maple code to generate C/C++ from complicated + expressions |