diff options
| -rw-r--r-- | README | 37 | ||||
| -rw-r--r-- | doc/TODO | 2 | ||||
| -rw-r--r-- | doc/documentation.tex | 10 |
3 files changed, 29 insertions, 20 deletions
@@ -23,6 +23,9 @@ the (many) parameters. The par/ directory contains some sample par files. +src/CODESTYLE documents the general programming conventions used in +this thorn. + See below in this file for notes on compiling this thorn. @@ -51,18 +54,22 @@ Place, Suite 330, Boston, MA 02111-1307 USA Other Software Required ======================= -This thorn inherits from ADMBase and StaticConformal (both in the -CactusEinstein arrangement), since it uses Cactus various grid functions -which are defined in those thorns. - -This thorn can use either of two different interpolator APIs -* CCTK_InterpGridArrays(), which at present is only supplied by the - CactusPUGH/PUGHInterp thorn, and which in turn uses... -* CCTK_InterpLocalUniform() interpolator API, which - at present is only supplied by the CactusBase/InterpLocal thorn. - -This thorn uses various Cactus reduction operations, so you'll need -a (driver-specific) reduction thorn (e.g. CactusPUGH/PUGHReduce). +This thorn inherits from ADMBase, StaticConformal, and SpaceMask +(all in the CactusEinstein arrangement), since it uses various Cactus +grid functions which are defined in those thorns. + +By default this thorn uses various Cactus APIs which are supplied by +other thorns: +* This thorn uses CCTK_InterpGridArrays() for interpolating grid arrays. + This is supplied by a driver-specific thorn; at present PUGHInterp + it this for the PUGH driver. +* This thorn uses CCTK_ReduceLocArrayToArray1D() for interprocessor + communication in the multiprocessor Newton solver. + [see src/driver/README.parallel for details] + This is supplied by a driver-specific thorn; at present PUGHReduce + it this for the PUGH driver. +* This thorn uses CCTK_InterpLocalUniform() for interpatch and surface + interpolation. At present LocalInterp supplies this. This thorn is written in C++, so you'll need a C++ compiler -- in fact a fairly modern one -- to compile this thorn. See the "Compilation Notes" @@ -98,6 +105,7 @@ In particular: alas none of the more modern forms (<cstdio> and namespace std::) seem to be supported on as wide a range of systems as the pre-namespaces form.) +* <assert.h> is used fairly heavily for sanity checks. * To avoid various portability problems, none of the C++ standard template library (STL) is used. @@ -154,7 +162,10 @@ IBM Power4 (AIX) Please let me (Jonathan) know of any other compilers which are ok. -It's uncertain whether this thorn will work or not using +This thorn compiles, but doesn't work, using the folloing systems/compilers; +the cure is to switch to a newer compiler version: +x86 +=== * gcc version 2.96 20000731 (Red Hat Linux 7.1 2.96-98) (This is the system gcc on Red Hat GNU/Linux 7.2 systems) @@ -1,8 +1,6 @@ small things set centroid variables for drift correction read IO parameters to set (default) directory in which we write output files - src/gr/geometry.cc should give a nice error msg for "ghost size too small" - interpolator error code there should be a Cactus test suite medium things diff --git a/doc/documentation.tex b/doc/documentation.tex index a3def2a..c0ea3ed 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -588,9 +588,9 @@ $^,$%%% to set the center position, and \item[%%% \begin{tabular}{@{}l@{}} - \code{initial\_guess\_\_coord\_ellipsoid\_\_x\_radius[}$n$\code{]} - \code{initial\_guess\_\_coord\_ellipsoid\_\_y\_radius[}$n$\code{]} - \code{initial\_guess\_\_coord\_ellipsoid\_\_z\_radius[}$n$\code{]} + \code{initial\_guess\_\_coord\_ellipsoid\_\_x\_radius[}$n$\code{]} \\ + \code{initial\_guess\_\_coord\_ellipsoid\_\_y\_radius[}$n$\code{]} \\ + \code{initial\_guess\_\_coord\_ellipsoid\_\_z\_radius[}$n$\code{]} %%%\\ \end{tabular}%%% ] \mbox{}\\ @@ -617,8 +617,8 @@ to data files: at every time step. However, you can control how often (if at all) the apparent horizon shape(s) are written to data files: this is only done if \verb|how_often_to_output_h| - is nonzero, and the Cactus time step number is an - integral multiple of this parameter. + is nonzero, and the Cactus time step number \verb|cctk_iteration| + is an integral multiple of this parameter. \item[\code{file\_format}] \mbox{}\\ |