Ian Hinder:

I was confused about the meaning of CCTK_LSSH and discussed it with
Erik, leading to the attached patch to the documentation.

UsersGuide: Clarify meaning of "lssh" grid size



git-svn-id: http://svn.cactuscode.org/flesh/trunk@4634 17b73243-c579-4c4c-a9d2-2d5706c11dac

1 files changed, 7 insertions, 2 deletions

diff --git a/doc/UsersGuide/ApplicationThorns.tex b/doc/UsersGuide/ApplicationThorns.tex
index c174c551..c526df49 100644
--- a/doc/UsersGuide/ApplicationThorns.tex
+++ b/doc/UsersGuide/ApplicationThorns.tex
@@ -1898,7 +1898,8 @@ The Cactus variables which are passed through the macro
 \item [\texttt{cctk\_dim}] An integer with the number of dimensions
       used for this grid hierarchy.
 \item [\texttt{cctk\_lsh}] An array of \texttt{cctk\_dim} integers
-      with the local grid size on this processor.
+      with the local grid size on this processor.  This is the allocated
+      size of the array.
 \item [\texttt{cctk\_gsh}] An array of \texttt{cctk\_dim} integers
       with the \textit{global} grid size.
 \item [\texttt{cctk\_iteration}] The current iteration number.
@@ -1915,7 +1916,11 @@ CCTK\_REAL}s with the grid spacing in each direction.
       of the grid.
 \item [\texttt{cctk\_lssh}]  This is an internal array used to hold
 array extents for staggering.  One should use the macro CCTK\_LSSH(,)
-to access its elements.
+to access its elements.  This variable is also used to determine the
+extent of the array over which to loop.  Usually it is identical to
+\texttt{cctk\_lsh}, but if array padding is used (not yet implemented), all
+loops should use CCTK\_LSSH(,) to determine the loop indices over which to
+loop.
 
 \end{Lentry}