by default,

  print a level 1 warning if we return an error code due to a point
  being outside (or too close to the boundary of) the grid

if the key "suppress_warnings" is in the parameter table,
  don't print these warnings


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

1 files changed, 18 insertions, 4 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 2883518..c1e2723 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -520,8 +520,9 @@ Interpolation Operator				& Order	& Size
 \subsection{Handling of Grid Boundaries}
 \label{AEIThorns/AEILocalInterp/sect-grid-boundaries}
 
-Near grid boundaries and/or excised points the interpolator can either
-off-center the interpolation molecules, or refuse to interpolate
+If an interpolation point is too near a grid boundary and/or an
+excised region the interpolator can either off-center the interpolation
+molecule, or refuse to interpolate that point
 (returning a \verb|CCTK_INTERP_ERROR_POINT_OUTSIDE|\,%%%
 \footnote{%%%
 	 For backwards compatability the error code
@@ -529,8 +530,9 @@ off-center the interpolation molecules, or refuse to interpolate
 	 is also defined; it's a synonym for
 	 {\tt CCTK\_INTERP\_ERROR\_POINT\_OUTSIDE}.
 	 }%%%
-{} or \verb|CCTK_INTERP_ERROR_POINT_EXCISED| error code).  This behavior
-is controlled by the (optional) parameter-table entries
+{} or \verb|CCTK_INTERP_ERROR_POINT_EXCISED| error code, and possibly
+also printing a warning message).  This behavior is controlled by the
+(optional) parameter-table entries
 \begin{verbatim}
 const CCTK_INT N_boundary_points_to_omit[2*N_dims]
 const CCTK_REAL boundary_off_centering_tolerance[2*N_dims]
@@ -814,6 +816,18 @@ This would leave Lagrange interpolation unchanged, while for Hermite
 interpolation the defaults would forbid any significant off-centering
 of the interpolation molecules.]
 
+%%%%%%%%%%%%%%%%%%%%
+
+\subsubsection{Suppressing Warning Messages about Off-Centering}
+
+By default, \thorn{AEILocalInterp} prints a Cactus level~1 warning
+message for each interpolation point which causes it to return a
+\verb|CCTK_INTERP_ERROR_POINT_OUTSIDE| or
+\verb|CCTK_INTERP_ERROR_POINT_EXCISED| error code.  If the key
+\verb|suppress_warnings| is present in the parameter table
+(it may have any datatype and value), then these messages are
+not printed.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \subsection{Per-Point Status Reporting}