update to describe the current state of this thorn

git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/LocalInterp/trunk@157 df1f8a13-aa1d-4dd4-9681-27ded5b42416

1 files changed, 32 insertions, 35 deletions

diff --git a/README b/README
index b184737..32af6e4 100644
--- a/README
+++ b/README
@@ -1,43 +1,40 @@
 Cactus Code Thorn LocalInterp
-Authors    : Jonathan Thornburg <jthorn@aei.mpg.de>,
-             incorporating parts of the old PUGHInterp by
-             Thomas Radke <tradke@aei.mpg.de>, which in turn draws
-             on older code by Paul Walker and optimization ideas
-             from Erik Schnetter <schnetter@uni-tuebingen.de>
-Maintainer : Jonathan Thornburg <jthorn@aei.mpg.de>
+Authors: Thomas Radke <tradke@aei.mpg.de> (with some documentation
+         provided by Jonathan Thornburg <jthorn@aei.mpg.de>), drawing
+         on older code by Paul Walker and optimization ideas
+         from Erik Schnetter <schnetter@uni-tuebingen.de>
+Maintainer : Thomas Radke <tradke@aei.mpg.de>
 CVS info   : $Header$
 --------------------------------------------------------------------------
 
-Purpose of the thorn:
+Purpose of the thorn
+====================
 
 This thorn does processor-local interpolation of N-dimensional data
 arrays.  In general there may be many input arrays (all defined on the
 same uniform Cartesian grid) all being interpolated to the same set
-of interpolation points.
-
-This thorn actually packages together two separate local interpolators:
-* One written by Thomas Radke in early 2001, with the operators
-     "first order uniform cartesian"
-     "second order uniform cartesian",
-     "third order uniform cartesian"
-  for the CCTK_InterpLocal() interpolation API.  (This code formerly
-  lived in the PUGHInterp thorn, but turned to have very little to do
-  with PUGH, so it's been moved here.)  This code lives in the subdirectory
-  src/UniformCartesian/ .
-* One written by Jonathan Thornburg in winter 2001-2002, with the
-  operators
-     "Lagrange polynomial interpolation (tensor product)"
-     "Lagrange polynomial interpolation (maximum degree)"
-  for the CCTK_InterpLocalUniform() interpolation API.  The operators
-     "Lagrange polynomial interpolation"
-     "generalized polynomial interpolation"
-  are also both accepted as a synonyms for
-     "Lagrange polynomial interpolation (tensor product)"
-  This code lives in the subdirectory src/GeneralizedPolynomial-Uniform/ .
-
-See the README files in the individual interpolators' directories
-for more information.
-
-We plan to eventually phase out the CCTK_InterpLocal() API.  We may
-also phase out its interpolator, or we may move this to the newer
-CCTK_InterpLocalArrays() API.
+of interpolation points.  At present this thorn only supports the
+CCTK_InterpLocal() API, but in the near future it will probably be
+enhanced to support the newer CCTK_InterpLocalUniform() API.
+
+
+History
+=======
+
+This interpolator was written by Thomas Radke in early 2001 (drawing
+on older code by Paul Walker), and supports the interpolation operators
+  "first order uniform cartesian"
+  "second order uniform cartesian"
+  "third order uniform cartesian"
+
+Originally lived in the PUGHInterp thorn, but it turned to have very
+little to do with PUGH, so was moved here in winter 2001-2002.
+
+From winter 2001-2002 to July 2003 this thorn also contained another
+interpolator written by Jonathan Thornburg, but in July 2003 that
+interpolator was moved to AEIThorns/AEILocalInterp because it was (is)
+GPL and Cactus policies forbids GPL code in this arrangement.
+
+Because CVS can't delete directories, this thorn still contains a lot
+of empty-except-for-CVS-directories directory trees left over from
+Jonathan Thornburg's interpolator.  You can/should ignore these.