From 60e4527a2653cfeba6e10cb1a7d836c7ac277a1c Mon Sep 17 00:00:00 2001
From: tradke <tradke@10716dce-81a3-4424-a2c8-48026a0d3035>
Date: Mon, 17 Nov 2003 17:04:46 +0000
Subject: Document support for the 'with_ghostzones' option in the parameter
 table passed into HyperslabDefine*Mapping().

git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGH/PUGHSlab/trunk@117 10716dce-81a3-4424-a2c8-48026a0d3035
---
 doc/documentation.tex | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'doc/documentation.tex')

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 385fc48..0638289 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -457,9 +457,11 @@ The current version of thorn {\tt PUGHSlab} implements only parts of the
 CCTK hyperslab API as described in section \ref{specification}:
 \begin{enumerate}
   \item the definition of local/global hyperslabs based on grid indicices\\
-    Currently, no additional hyperslab mapping information can be passed
-    through a key/value table; the {\tt table\_handle} argument is
-    completely ignored.
+    Currently, the only additional hyperslab mapping information which can be
+    passed through a key/value table is a {\tt CCKT\_INT} option with the key
+    {\tt with\_ghostzones}. If the value of this key is non-zero {\tt PUGHSlab}
+    will not strip outer boundary ghostzones for periodic boundary conditions
+    as implemented by {\tt PUGH}.
 
     {\tt PUGHSlab} provides a set of predefined built-in functions
     for the following classes of data type conversions:
-- 
cgit v1.2.3

