add a debugging feature: setting the parameter

  AEILocalInterp::log_interp_coords = true
causes this thorn to write a log file on each processor
giving the grid and (some of) the interpolation coordinates


git-svn-id: http://svn.aei.mpg.de/numrel/AEIThorns/AEILocalInterp/trunk@45 0f49ee68-0e4f-0410-9b9c-b2c123ded7ef

1 files changed, 19 insertions, 0 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 78eb921..15b94e5 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -1392,6 +1392,25 @@ to a positive value turns on various debug printing inside the
 interpolator.  This is intended for debugging the interpolator itself;
 you need to look at the interpolator source code to interpret the output.
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\subsection{Logging}
+
+This thorn has a Boolean parameter \verb|log_interp_coords|.
+If this is set to \verb|true|, this thorn will write a detailed log
+file giving the grid information and interpolation coordinates for
+each interpolator call.  Each processor will write a separate log file,
+with the file name determined via
+\begin{verbatim}
+snprintf(buffer, length,
+         "AEILocalInterp.proc%d.log"
+         CCTK_MyProc(NULL))
+\end{verbatim}
+
+Note that these log files are typically quite large, and writing them         
+may significantly slow the simulation -- you should probably only use
+this option for debugging purposes.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{Supressing Interpolation}