From d02e32017c37ea66408c0f91c44d27fe6f67624e Mon Sep 17 00:00:00 2001 From: schnetter Date: Wed, 6 Nov 2002 14:10:20 +0000 Subject: Fixed bug in doc. git-svn-id: http://svn.cactuscode.org/arrangements/CactusNumerical/Slab/trunk@10 2e825fa2-fb71-486d-8b7f-a5ff3f0f6cb8 --- doc/documentation.tex | 52 ++++++++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/doc/documentation.tex b/doc/documentation.tex index d08f29c..a23c32e 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -186,11 +186,11 @@ Failure Pointer to the CCTK grid hierarchy \end{Parameter} -\begin{parameter}{dim} +\begin{Parameter}{dim} Number of dimensions of the arrays and slabs. Must be nonnegative. \end{Parameter} -\begin{parameter}{xferinfo[dim]} +\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 @@ -198,17 +198,17 @@ between the slabs. Each dimension is described separately. See the entries \texttt{xferinfo[d].*} below. \end{Parameter} -\begin{parameter}{xferinfo[d].src} +\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} +\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} +\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}, @@ -218,7 +218,7 @@ transposition. No two values of \texttt{xferinfo[*].xpose} may be the same. \end{Parameter} -\begin{parameter}{xferinfo[d].flip} +\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 @@ -235,79 +235,79 @@ 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}} +\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} +\begin{Parameter}{\textit{slab}.gsh} Global shape of the array; the overall number of grid points \end{Parameter} -\begin{parameter}{\textit{slab}.lbnd} +\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} +\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} +\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} +\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} +\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} +\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} +\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} +\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} +\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} +\begin{Parameter}{srctype} Type of the source array. Pass the corresponding \texttt{CCTK\_VARIABLE\_*} constant. \end{Parameter} -\begin{parameter}{srcptr} +\begin{Parameter}{srcptr} Pointer to the source array \end{Parameter} -\begin{parameter}{dsttype} +\begin{Parameter}{dsttype} Type of the destination array. Pass the corresponding \texttt{CCTK\_VARIABLE\_*} constant. \end{Parameter} -\begin{parameter}{dstptr} +\begin{Parameter}{dstptr} Pointer to the destination array \end{Parameter} \end{ParameterSection} @@ -338,9 +338,11 @@ boundary is assumed to be the same. There is no Fortran interface. \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 @@ -355,6 +357,8 @@ The identity transfer: copy a whole 3D grid function without transforming it \begin{verbatim} +INHERITS: Slab + #include #include "cctk.h" #include "cctk_Arguments.h" @@ -410,6 +414,8 @@ A complicated transfer: copy a subarray, transposing the $x$ and $z$ axes, and inverting the $x$ axis \begin{verbatim} +INHERITS: Slab + #include #include "cctk.h" #include "cctk_Arguments.h" @@ -483,14 +489,14 @@ assert (!ierr); \section{Obtaining This Thorn} This thorn is available from the \texttt{TAT} arrangement in the -\texttt{arrangements} directory from the \texttt{cvs.cactuscode.org} +\texttt{arrangements} directory on 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 +schnetter@uni-tuebingen.de\textgreater\ in 2002. Contact me for questions and comments. % Do not delete next line -- cgit v1.2.3