Added thorn documentation.

Added option table argument.
Added copyright statement.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusNumerical/Slab/trunk@9 2e825fa2-fb71-486d-8b7f-a5ff3f0f6cb8

4 files changed, 737 insertions, 58 deletions

diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..5b6e7c6
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 7ccf999..d08f29c 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -97,12 +97,13 @@
 % Add an abstract for this thorn's documentation
 \begin{abstract}
 The Slab thorn provides generic slabbing facilities.  A slab is a
-sub-array of another array.  Both can be multidimensional, and the
-slab can have a non-unit stride.  The Slab thorn provides a routine to
-copy a slab from one array into a slab of another array, while
-possibly transposing or inverting the slab.  The distribution of the
-arrays can be specified freely, so that the Slab thorn can also be
-used to interface to non-Cactus libraries with different data layouts.
+sub-array of another array.  Both the array and the slab can be
+multidimensional, and the slab can have a non-unit stride.  The Slab
+thorn provides a routine to copy a slab from one array into a slab of
+another array, while possibly transposing or mirroring the slab.  The
+processor distribution of the arrays can be specified freely, so that
+the Slab thorn can be used to interface to non-Cactus libraries with
+different data layouts.
 
 The Slab thorn is driver independent, i.e.\ not tied to PUGH or
 Carpet, and does not require MPI for single-processor configurations.
@@ -111,40 +112,386 @@ Carpet, and does not require MPI for single-processor configurations.
 % The following sections are suggestive only.
 % Remove them or add your own.
 
+
+
 \section{Introduction}
 
 A \emph{Slab} is a subarray of another array.  This concept is used in
 many places with many different names.  Fortran has so-called ``array
-subscript triplets'', which are the same thing.
-
-\section{Physical System}
-
-\section{Numerical Implementation}
-
-\section{Using This Thorn}
-
-\subsection{Obtaining This Thorn}
+subscript triplets'', which represent the same thing.  In BLAS, the
+``leading dimension'' arguments are used to described slabs.  Slabs
+are sometimes also called ``array views'' in object oriented
+applications.  Slabs are rectangular in shape, and can be rotated with
+regard to their containing array by multiples of 90 degrees.  They can
+also be mirrored, i.e.\ the direction of axes can be inverted.
 
-\subsection{Basic Usage}
+It is often necessary to copy slabs from one array into other arrays,
+or to copy one slab of an array to another slab of the same array.
+This can be used to change the processor distribution of some data, or
+to apply symmetry or periodicity boundary conditions, or to collect
+data onto a single processor to process it more easily.
 
-\subsection{Special Behaviour}
 
-\subsection{Interaction With Other Thorns}
 
-\subsection{Support and Feedback}
-
-\section{History}
-
-\subsection{Thorn Source Code}
-
-\subsection{Thorn Documentation}
-
-\subsection{Acknowledgements}
-
-
-\begin{thebibliography}{9}
+\section{Using This Thorn}
 
-\end{thebibliography}
+\begin{FunctionDescription}{Slab\_Transfer}{}
+Transfer a slab contained in one array to a (possibly different) slab
+of another (possibly the same) array
+
+\begin{SynopsisSection}
+\begin{Synopsis}{C}
+\begin{verbatim}
+INHERITS: Slab
+
+#include "cctk.h"
+#include "Slab.h"
+
+struct slabinfo {
+  int gsh;
+  int lbnd, lsh;
+  int lbbox, ubbox, nghostzones;
+  int off, str, len;
+};
+
+struct xferinfo {
+  struct slabinfo src, dst;
+  int xpose;
+  int flip;
+};
+
+int Slab_Transfer (cGH                   * restrict const cctkGH,
+                   int                              const dim,
+                   struct xferinfo const * restrict const xferinfo,
+                   int                              const options,
+                   int                              const srctype,
+                   void            const *          const srcptr,
+                   int                              const dsttype,
+                   void                  *          const dstptr);
+\end{verbatim}
+\end{Synopsis}
+\end{SynopsisSection}
+
+\begin{ResultSection}
+\begin{Result}{0}
+Success
+\end{Result}
+\begin{Result}{nonzero}
+Failure
+\end{Result}
+\end{ResultSection}
+
+\begin{ParameterSection}
+\begin{Parameter}{cctkGH}
+Pointer to the CCTK grid hierarchy
+\end{Parameter}
+
+\begin{parameter}{dim}
+Number of dimensions of the arrays and slabs.  Must be nonnegative.
+\end{Parameter}
+
+\begin{parameter}{xferinfo[dim]}
+Describes the layout of the slab transfer, i.e.\ the shape and
+distribution of the source and destination arrays, and the locations
+of the source and destination slabs, and a possible transformation
+between the slabs.  Each dimension is described separately.  See the
+entries \texttt{xferinfo[d].*} below.
+\end{Parameter}
+
+\begin{parameter}{xferinfo[d].src}
+Describes the source array and source slab.  See the \textit{slabinfo}
+entries below.
+\end{Parameter}
+
+\begin{parameter}{xferinfo[d].dst}
+Describes the destination array and destination slab.  See the
+\textit{slabinfo} entries below.
+\end{Parameter}
+
+\begin{parameter}{xferinfo[d].xpose}
+Describes how to transpose the slab, i.e.\ possibly permuting the slab
+axes, as in $(x,y) \rightarrow (y,x)$.  \texttt{xferinfo[d].xpose}
+contains an integer value in the range \texttt{0\ldots dim-1},
+specifying the source axis corresponding to the destination axis
+\texttt{d}.  Specify \texttt{xferinfo[d].xpose = d} for no
+transposition.  No two values of \texttt{xferinfo[*].xpose} may be the
+same.
+\end{Parameter}
+
+\begin{parameter}{xferinfo[d].flip}
+Describes how to mirror the slab, i.e.\ possibly inverting the slab
+axes, as in $(x) \rightarrow (-x)$.  \texttt{xferinfo[d].flip}
+containes a boolean value specifying whether the axis in direction
+\texttt{d} should be inverted, i.e.\ either \texttt{0} or \texttt{1},
+where \texttt{0} indicates no inversion, and \texttt{1} indicates
+inversion.
+
+When axes are both transposed and inverted while a slab is copied,
+then the transposing happens first, and the axis inversion later.
+That is, the sequence of ``actions'' is: extract slab, transpose,
+invert, insert slab.  For example, when transposing the $x$ and $z$
+axes and inverting the $x$ axis, then the destination slab's $x$ axis
+is the source slab's flipped $z$ axis, while the destination $z$ axis
+is the unflipped source $x$ axis.
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}}
+Describes the shape and processor distribution of one dimension of an
+array, and the location of this dimension of a slab.  The shape and
+distribution is specified in the same manner as in the \texttt{cGH}
+structure.  See the entries \texttt{\textit{slab}.*} below.
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.gsh}
+Global shape of the array; the overall number of grid points
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.lbnd}
+Lower boundary of the array; the global index of the lower boundary of
+the processor-local part of the array
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.lsh}
+Local shape of the array; the number of grid points on this processor
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.lbbox}
+Lower bounding box of the array; whether the lower boundary of the
+array is an outer boundary.  This corresponds to the even entries in
+Cactus' \texttt{bbox} array.  Must be \texttt{0} or \texttt{1}.
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.ubbox}
+Upper bounding box of the array; whether the upper boundary of the
+array is an outer boundary.  This corresponds to the odd entries in
+Cactus' \texttt{bbox} array.  Must be \texttt{0} or \texttt{1}.
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.nghostzones}
+Number of ghost zones of the array; the number of grid points on this
+processor that are only copied from neighbouring processors
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.off}
+Slab offset; the global index of the lowest grid point of the slab
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.str}
+Slab stride; the distance between two grid points making up the slab.
+Specify \texttt{\textit{slab}.str = 1} for a unit stride.  Must be
+positive.
+\end{Parameter}
+
+\begin{parameter}{\textit{slab}.len}
+Slab length; the number of grid points that make up the slab.  This
+does not count the grid points that are skipped if the slab has a
+non-unit stride.  Must be nonnegative.
+\end{Parameter}
+
+\begin{parameter}{options}
+Handle of an option table.  Currently there are no options defined.
+Pass either $-1$ or a handle to an empty table.
+\end{Parameter}
+
+\begin{parameter}{srctype}
+Type of the source array.  Pass the corresponding
+\texttt{CCTK\_VARIABLE\_*} constant.
+\end{Parameter}
+
+\begin{parameter}{srcptr}
+Pointer to the source array
+\end{Parameter}
+
+\begin{parameter}{dsttype}
+Type of the destination array.  Pass the corresponding
+\texttt{CCTK\_VARIABLE\_*} constant.
+\end{Parameter}
+
+\begin{parameter}{dstptr}
+Pointer to the destination array
+\end{Parameter}
+\end{ParameterSection}
+
+\begin{Discussion}
+\texttt{Slab\_Transfer} copies one slab from one array onto a possibly
+different slab in possibly the same array.  The shape and processor
+distribution of the arrays can be specified freely, as long as each
+processor holds a rectangular subset of grid points.  The location of
+the slab can also be specified freely, and the slab can be rotated (by
+multiples of 90 degrees) or inverted before it is copied.  The source
+and destination slab are allowed to overlap.
+
+\texttt{Slab\_Transfer} is conservative with regard to
+synchronisation.  It assumes that the ghost zones of the source array
+are not valid, but will correctly fill in the ghost zones in the
+destination slab.
+
+There are currently some restrictions, which can be remedied if the
+need arises: The datatype of the arrays must be CCTK\_REAL.  The
+dimension must be 3 (lower dimensions can easily be padded).  The
+communication schedule is set up for every slab transfer, which is
+expensive.  The number of ghost zones along the lower and upper
+boundary is assumed to be the same.  There is no Fortran interface.
+\end{Discussion}
+
+\begin{SeeAlsoSection}
+\begin{SeeAlso}{CarpetSlab}
+The hyperslabbing thorn of the driver Carpet.
+\end{SeeAlso}
+\begin{SeeAlso}{PUGHSlab}
+The hyperslabbing thorn of the driver CactusPUGH.
+\end{SeeAlso}
+\begin{SeeAlso}{New hyperslabbing API}
+The web page \href{http://www.cactuscode.org/Development/Current.html}
+{http://www.cactuscode.org/Development/Current.html} contains a
+hyperlink to the new proposed hyperslabbing API.  This API is slightly
+different from the one used here.
+\end{SeeAlso}
+\end{SeeAlsoSection}
+
+\begin{ExampleSection}
+\begin{Example}{C}
+The identity transfer: copy a whole 3D grid function without
+transforming it
+
+\begin{verbatim}
+#include <assert.h>
+#include "cctk.h"
+#include "cctk_Arguments.h"
+
+#include "Slab.h"
+
+DECLARE_CCTK_ARGUMENTS;
+
+struct xferinfo info[3];
+int d;
+int ierr;
+
+/* Set up the array descriptors */
+assert (cctk_dim <= 3);
+for (d=0; d<cctk_dim; ++d) {
+  info[d].src.gsh = cctk_gsh[d];
+  info[d].src.lbnd = cctk_lbnd[d];
+  info[d].src.lsh = cctk_lsh[d];
+  info[d].src.lbbox = cctk_bbox[2*d];
+  info[d].src.ubbox = cctk_bbox[2*d+1];
+  info[d].src.nghostzones = cctk_nghostzones[d];
+  info[d].dst.gsh = cctk_gsh[d];
+  info[d].dst.lbnd = cctk_lbnd[d];
+  info[d].dst.lsh = cctk_lsh[d];
+  info[d].dst.lbbox = cctk_bbox[2*d];
+  info[d].dst.ubbox = cctk_bbox[2*d+1];
+  info[d].dst.nghostzones = cctk_nghostzones[d];
+}
+
+/* Set up the slab and transformation descriptors */
+assert (cctk_dim <= 3);
+for (d=0; d<cctk_dim; ++d) {
+  info[d].src.off = 0;
+  info[d].src.len = cctk_gsh[d];
+  info[d].src.str = 1;
+  info[d].dst.off = 0;
+  info[d].dst.len = cctk_gsh[d];
+  info[d].dst.str = 1;
+  info[d].xpose = d;
+  info[d].flip = 0;
+}
+
+/* Transfer the slab */
+ierr = Slab_Transfer
+  (cctkGH, cctk_dim, info, -1,
+   CCTK_VARIABLE_REAL, gf1, CCTK_VARIABLE_REAL, gf2);
+assert (!ierr);
+\end{verbatim}
+\end{Example}
+
+\begin{Example}{C}
+A complicated transfer: copy a subarray, transposing the $x$ and $z$
+axes, and inverting the $x$ axis
+
+\begin{verbatim}
+#include <assert.h>
+#include "cctk.h"
+#include "cctk_Arguments.h"
+
+#include "Slab.h"
+
+DECLARE_CCTK_ARGUMENTS;
+
+struct xferinfo info[3];
+int d;
+int ierr;
+
+/* Set up the array descriptors (same as above) */
+assert (cctk_dim <= 3);
+for (d=0; d<cctk_dim; ++d) {
+  info[d].src.gsh = cctk_gsh[d];
+  info[d].src.lbnd = cctk_lbnd[d];
+  info[d].src.lsh = cctk_lsh[d];
+  info[d].src.lbbox = cctk_bbox[2*d];
+  info[d].src.ubbox = cctk_bbox[2*d+1];
+  info[d].src.nghostzones = cctk_nghostzones[d];
+  info[d].dst.gsh = cctk_gsh[d];
+  info[d].dst.lbnd = cctk_lbnd[d];
+  info[d].dst.lsh = cctk_lsh[d];
+  info[d].dst.lbbox = cctk_bbox[2*d];
+  info[d].dst.ubbox = cctk_bbox[2*d+1];
+  info[d].dst.nghostzones = cctk_nghostzones[d];
+}
+
+/* Set up the slab and transformation descriptors */
+info[0].src.off = 5;
+info[1].src.off = 5;
+info[2].src.off = 1;
+info[0].src.str = 1;
+info[1].src.str = 1;
+info[2].src.str = 1;
+info[0].src.len = 2;
+info[1].src.len = 3;
+info[2].src.len = 2;
+
+info[0].dst.off = 2;
+info[1].dst.off = 3;
+info[2].dst.off = 4;
+info[0].dst.str = 1;
+info[1].dst.str = 1;
+info[2].dst.str = 1;
+info[0].dst.len = 2;
+info[1].dst.len = 3;
+info[2].dst.len = 2;
+
+info[0].xpose = 2;
+info[1].xpose = 1;
+info[2].xpose = 0;
+info[0].flip = 1;
+info[1].flip = 0;
+info[2].flip = 0;
+
+/* Transfer the slab */
+ierr = Slab_Transfer
+  (cctkGH, cctk_dim, info, -1,
+   CCTK_VARIABLE_REAL, gf1, CCTK_VARIABLE_REAL, gf2);
+assert (!ierr);
+\end{verbatim}
+\end{Example}
+\end{ExampleSection}
+
+\end{FunctionDescription}
+
+
+
+\section{Obtaining This Thorn}
+
+This thorn is available from the \texttt{TAT} arrangement in the
+\texttt{arrangements} directory from the \texttt{cvs.cactuscode.org}
+CVS server via anonymous pserver access.
+
+
+\section{Support and Feedback}
+
+This thorn was written by Erik Schnetter \textless
+schnetter@uni-tuebingen.de\textgreater in 2002.  Contact me for
+questions and comments.
 
 % Do not delete next line
 % END CACTUS THORNGUIDE
diff --git a/src/slab.c b/src/slab.c
index 53bcabf..99663eb 100644
--- a/src/slab.c
+++ b/src/slab.c
@@ -2,12 +2,13 @@
 
 /*
   TODO:
+  Provide facilities for types other than CCTK_REAL
   Provide facilities for dim != 3
   Set up the slab exchange information in advance
   Test slabbing without MPI
   Allow using / not setting the ghost zones
   Allow not using / not setting the boundaries
-  Allow different ghost zones at the lower and upper boundary
+  Allow different numbers of ghost zones at the lower and upper boundary
 */
 
 
@@ -195,16 +196,6 @@ struct info {
 
 
 
-static inline int min (int const x, int const y)
-{
-  return x < y ? x : y;
-}
-
-static inline int max (int const x, int const y)
-{
-  return x > y ? x : y;
-}
-
 static inline int roundup (int const x, int const y)
 {
   assert (x >= 0);
@@ -363,7 +354,8 @@ static void bbox_xform (struct bbox       * restrict const ydst,
 
 int Slab_Transfer (cGH                   * restrict const cctkGH,
 		   int                              const dim,
-		   struct xferinfo const *          const xferinfo,
+		   struct xferinfo const * restrict const xferinfo,
+		   int                              const options,
 		   int                              const srctype,
 		   void            const *          const srcptr,
 		   int                              const dsttype,
@@ -663,7 +655,6 @@ int Slab_Transfer (cGH                   * restrict const cctkGH,
 		    && srcipos[c] < info[c].src.local.off + info[c].src.local.len);
 	    if (! (srcipos[c] >= allinfo[n*dim+c].src.slab.off
 		   && srcipos[c] <= allinfo[n*dim+c].src.slab.off + (allinfo[n*dim+c].src.slab.len - 1) * allinfo[n*dim+c].src.slab.str)) {
-	      printf ("ssc n=%d ipos=[%d,%d,%d] d=%d srcipos=%d slab.off=%d slab.len=%d\n", n, i, j, k, d, srcipos[c], allinfo[n*dim+c].src.slab.off, allinfo[n*dim+c].src.slab.len);
 	    }
 	    assert (srcipos[c] >= allinfo[n*dim+c].src.slab.off
 		    && srcipos[c] <= allinfo[n*dim+c].src.slab.off + (allinfo[n*dim+c].src.slab.len - 1) * allinfo[n*dim+c].src.slab.str);
diff --git a/src/slab.h b/src/slab.h
index b79af0a..2aa32bc 100644
--- a/src/slab.h
+++ b/src/slab.h
@@ -5,19 +5,6 @@
 
 #include "cctk.h"
 
-struct slabinfo {
-  int gsh;
-  int lbnd, lsh;
-  int lbbox, ubbox, nghostzones;
-  int off, str, len;
-};
-
-struct xferinfo {
-  struct slabinfo src, dst;
-  int xpose;
-  int flip;
-};
-
 /*
   Slab_Transfer copies a slab from one array into a slab of another
   array.
@@ -83,9 +70,23 @@ struct xferinfo {
   The source and the destination arrays may be the same.
 */
 
+struct slabinfo {
+  int gsh;
+  int lbnd, lsh;
+  int lbbox, ubbox, nghostzones;
+  int off, str, len;
+};
+
+struct xferinfo {
+  struct slabinfo src, dst;
+  int xpose;
+  int flip;
+};
+
 int Slab_Transfer (cGH                   * restrict const cctkGH,
 		   int                              const dim,
-		   struct xferinfo const *          const xferinfo,
+		   struct xferinfo const * restrict const xferinfo,
+		   int                              const options,
 		   int                              const srctype,
 		   void            const *          const srcptr,
 		   int                              const dsttype,