* change to not use STL vector class any more

  (it caused portability problems on platinum)
	==> move  stl_vector.hh  from src/include/ to archive/ directory
* convert  patch_system_type  and  initial_guess_method
  parameters to be array parameters, i.e. they're now set individually
  for each AH we want to find


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

1 files changed, 21 insertions, 14 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 86b9db1..00912c7 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -214,7 +214,7 @@ necessary in order for \thorn{AHFinderDirect} to work:
 	\thorn{AHFinderDirect} may report in such a situation
 	(where the Cactus 3-D grid resolution is too low) is that
 	the interpolated $g_{ij}$ fails to be positive definite.
-\item	At the moment \thorn{AHFinderDirect} and \thorn{LocalInterp}
+\item	At the moment \thorn{AHFinderDirect} and the Cactus interpolators
 	don't know anything about excision, so if the apparent horizon
 	(or any trial horizon surface as the algorithm is iterating
 	towards the apparent horizon) gets too close to an excised
@@ -262,13 +262,16 @@ here's what works and what doesn't:
 	have storage turned on for at least the conformal factor
 	\verb|StaticConformal::psi|.  (The Cactus 3-D grid functions
 	for 1st and 2nd derivatives of \verb|psi| aren't used.)
-\item	\thorn{AHFinderDirect} uses the new \verb|CCTK_InterpLocalUniform()|
-	interpolator API, which at present is only supported by
-	\thorn{LocalInterp}, so you need that thorn compiled in to
-	your configuration and activated.
-\item	At present \thorn{AHFinderDirect} only works for single-processor
-	Cactus runs.  This isn't checked, so if you try to activate
-	it in a multi-procssor run you'll probably get garbage results.
+\item	By default \thorn{AHFinderDirect} uses the new
+	\verb|CCTK_InterpGridArrays()| global interpolator API,
+	which in turn uses the new \verb|CCTK_InterpLocalUniform()|
+	local interpolator API.  At present these interpolators
+	are only provided by the thorns \thorn{PUGHInterp} and
+	\thorn{LocalInterp} respectively, so you need to have
+	these thorns compiled into your configuration and activated.
+\item	Even though it uses the new global interpolation API,
+	at present \thorn{AHFinderDirect} doesn't work properly
+	for multi-processor Cactus runs.
 	I hope to properly support multi-processor operation soon.
 \end{itemize}
 
@@ -299,12 +302,16 @@ with various compilers.  See the ``Code Notes'' and ``Compiler Notes''
 sections in the top-level \code{README} file for details and lists of
 compilers currently known to be ok or not.
 
-To compile (a Cactus configuration which includes) this thorn, at present
-you must set the environment variable \code{LAPACK\_DIR}, and possibly
-also the environment variables \code{LAPACK\_EXTRA\_LIBS} and
-\code{LAPACK\_EXTRA\_LIBDIRS}.  See the ``Library Configuration''
-section in the top-level \code{README} file for details.
-(I plan to replace this by an autoconfiguration scheme at some point.)
+\thorn{AHFinderDirect} uses the LAPACK library for solving linear
+equations, so you need to configure Cactus with \verb|LAPACK=yes|.
+Cactus can usually find the LAPACK libraries itself; if not it will
+tell you (at configure time) that you also need to set the Cactus
+configuration variable \verb|LAPACK_DIR| to tell it where the
+libraries live.  If the LAPACK libraries were compiled by a different
+Fortran compiler than you're using to compile Cactus, then you may also
+have to set the Cactus configuration variables \verb|LAPACK_EXTRA_LIBS|
+and \verb|LAPACK_EXTRA_LIB_DIRS|.  See the top-level \verb|README|
+file for details and examples.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%