From b61092fd8aa556ae850543740e9b6e150b509ae9 Mon Sep 17 00:00:00 2001 From: tradke Date: Thu, 30 Jan 2003 12:28:25 +0000 Subject: Updated documentation. git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGH/PUGHSlab/trunk@96 10716dce-81a3-4424-a2c8-48026a0d3035 --- README | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README b/README index e02cb7d..f4de524 100644 --- a/README +++ b/README @@ -1,26 +1,21 @@ Cactus Code Thorn PUGHSlab Authors : Gabrielle Allen (allen@aei.mpg.de), - Tom Goodale (goodale@aei.mpg.de), + Tom Goodale (goodale@aei.mpg.de), Thomas Radke (tradke@aei.mpg.de) CVS info : $Header$ -------------------------------------------------------------------------- 1. Purpose of the thorn: -This thorn provides functionality to extract hyperslabs: -M-dimensional orthogonal subspaces from a given N-dimensional data space -(1 <= M <= N). +This thorn implements the following parts of the CCTK hyperslab API: -Input parameters are - - the origin of the hyperslab in the data space, - - the directions it spans, - - the extents of the hyperslab - - downsampling values into each hyperslab dimension + * the definition of local and global hyperslab mappings based on grid indices + * the extraction of local and global hyperslabs as specified by such + mappings 2. Additional information -The term hyperslab and the functionality provided by this thorn are derived -from the HDF5 API (see http://hdf.ncsa.uiuc.edu/HDF5/). - -NOTE: the calling interface of PUGHSlab is going to change ! +The complete specification of the CCTK Hyperslab API and the description of +PUGHSlab's implementation of it are described in the corresponding ThornGuide +chapter for PUGHSlab (see file doc/documentation.tex). -- cgit v1.2.3