update TODO that I now properly handle "ghost size too small" error code

from the interpoltor

small tweaks to documentation.tex


git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@1004 f88db872-0e4f-0410-b76b-b9085cfa78c5

1 files changed, 24 insertions, 13 deletions

diff --git a/README b/README
index f0ff6e4..5f59b8f 100644
--- a/README
+++ b/README
@@ -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)