diff options
Diffstat (limited to 'doc/documentation.tex')
-rw-r--r-- | doc/documentation.tex | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 0638289..1c1f70d 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -65,10 +65,10 @@ In general, a hyperslab get/put operation is done in a three-level scheme: \item In a first step, a hyperslab mapping is defined by calling one of the following routines:\\ {\tt - \hspace*{3ex}Hyperslab\_DefineLocalMappingByIndex()\\ - \hspace*{3ex}Hyperslab\_DefineLocalMappingByPhys()\\ - \hspace*{3ex}Hyperslab\_DefineGlobalMappingByIndex()\\ - \hspace*{3ex}Hyperslab\_DefineGlobalMappingByPhys()\\ + \hspace*{3ex}Hyperslab\_LocalMappingByIndex()\\ + \hspace*{3ex}Hyperslab\_LocalMappingByPhys()\\ + \hspace*{3ex}Hyperslab\_GlobalMappingByIndex()\\ + \hspace*{3ex}Hyperslab\_GlobalMappingByPhys()\\ } There exists two complement sets of routines: one for the definition of local hyperslabs (which apply to a processor's local patch of a distributed @@ -109,7 +109,7 @@ can be specified either by coordinates on the physical grid or by index points on the underlying computational grid. \begin{verbatim} -CCTK_INT Hyperslab_DefineGlobalMappingByIndex ( +CCTK_INT Hyperslab_GlobalMappingByIndex ( CCTK_POINTER_TO_CONST GH, CCTK_INT vindex, CCTK_INT hdim, @@ -121,7 +121,7 @@ CCTK_INT Hyperslab_DefineGlobalMappingByIndex ( CCTK_FPOINTER conversion_fn, CCTK_INT *hsize /* hdim */); -CCTK_INT Hyperslab_DefineGlobalMappingByPhys ( +CCTK_INT Hyperslab_GlobalMappingByPhys ( CCTK_POINTER_TO_CONST GH, CCTK_INT vindex, CCTK_INT hdim, @@ -135,7 +135,7 @@ CCTK_INT Hyperslab_DefineGlobalMappingByPhys ( CCTK_INT *hsize /* hdim */); -CCTK_INT Hyperslab_DefineLocalMappingByIndex ( +CCTK_INT Hyperslab_LocalMappingByIndex ( CCTK_POINTER_TO_CONST GH, CCTK_INT vindex, CCTK_INT hdim, @@ -149,7 +149,7 @@ CCTK_INT Hyperslab_DefineLocalMappingByIndex ( CCTK_INT *hsize_global, /* hdim */ CCTK_INT *hoffset_global /* hdim */); -CTK_INT Hyperslab_DefineLocalMappingByPhys ( +CTK_INT Hyperslab_LocalMappingByPhys ( CCTK_POINTER_TO_CONST GH, CCTK_INT vindex, CCTK_INT hdim, @@ -270,7 +270,7 @@ typedef CCTK_INT (*t_hslabConversionFn) (CCTK_INT nelems, \item{\tt CCTK\_INT *hsize\\ CCTK\_INT *hsize\_local}\\ Reference to a size array with {\tt hdim} elements to be set by the - {\tt Hyperslab\_DefineXXXMappingByXXX()} routines. + {\tt Hyperslab\_XXXMappingByXXX()} routines. The resulting size of the hyperslab to be extracted is set according to the hyperslab extents and downsampling parameters chosen. @@ -280,7 +280,7 @@ typedef CCTK_INT (*t_hslabConversionFn) (CCTK_INT nelems, \item{\tt CCTK\_INT *hsize\_global}\\ Reference to a size array with {\tt hdim} elements to be set by the - {\tt Hyperslab\_DefineLocalMappingBy*()} routine. + {\tt Hyperslab\_LocalMappingBy*()} routine. This array holds the sizes of the corresponding global hyperslab. It is set according to the local hyperslab extents and downsampling @@ -291,7 +291,7 @@ typedef CCTK_INT (*t_hslabConversionFn) (CCTK_INT nelems, \item{\tt CCTK\_INT *hoffset\_global}\\ Reference to an offset array with {\tt hdim} elements to be set by the - {\tt Hyperslab\_DefineLocalMappingBy*()} routine. + {\tt Hyperslab\_LocalMappingBy*()} routine. This array holds the offsets of the local hyperslab into the corresponding global hyperslab. It is set according to the local @@ -306,7 +306,7 @@ typedef CCTK_INT (*t_hslabConversionFn) (CCTK_INT nelems, \begin{itemize} \item 0 for success \item negative for some error condition (to be defined by an actual - implementation of the {\tt Hyperslab\_Define*MappingBy*()} routines) + implementation of the {\tt Hyperslab\_*MappingBy*()} routines) \end{itemize} |