From 93b29a5e7ea6c7b97746202c24daa475f32923c3 Mon Sep 17 00:00:00 2001
From: tradke <tradke@0337457d-221f-4ee6-a5f0-14255d5370d8>
Date: Sun, 9 May 2004 14:51:19 +0000
Subject: Added aliased function Coord_GetDefaultSystem() which returns the
 default coordinate system registered for a given grid dimension.

git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/CoordBase/trunk@15 0337457d-221f-4ee6-a5f0-14255d5370d8
---
 doc/documentation.tex | 41 +++++++++++++++++++++++++++--------------
 1 file changed, 27 insertions(+), 14 deletions(-)

(limited to 'doc')

diff --git a/doc/documentation.tex b/doc/documentation.tex
index ab06462..ce6749a 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -233,9 +233,9 @@ section \ref{CactusBase_CoordBase_APIs}).
 \label{CactusBase_CoordBase_APIs}
 
 \begin{verbatim}
-int systemhandle = Coord_SystemRegister(const cGH *GH,
-                                        int dim, 
-                                        const char *systemname)
+CCTK_INT systemhandle = Coord_SystemRegister(CCTK_POINTER_TO_CONST GH,
+                                             CCTK_INT dim, 
+                                             CCTK_STRING systemname)
 \end{verbatim}
 registers a coordinate system, along with its
 dimension, with the CoordBase thorn.  This will create a coordinate
@@ -251,8 +251,8 @@ COORDERROR\_SYSTEMEXISTS & coordinate system of this name already exists\\
 table handles on a GH extension, under the name ``CoordBase''.
 
 \begin{verbatim}
-int systemhandle = Coord_SystemHandle(const cGH *GH,
-                                      const char *systemname)
+CCTK_INT systemhandle = Coord_SystemHandle(CCTK_POINTER_TO_CONST GH,
+                                           CCTK_STRING systemname)
 \end{verbatim}
 returns the handle for a given coordinate system, or 
 negative on error:\beforetable
@@ -262,10 +262,10 @@ negative on error:\beforetable
 \end{tabular}
 
 \begin{verbatim}
-int coordhandle = Coord_CoordRegister(const cGH *GH, 
-                                      int systemhandle, 
-                                      int direction,
-                                      const char *coordname)
+CCTK_INT coordhandle = Coord_CoordRegister(CCTK_POINTER_TO_CONST GH, 
+                                           CCTK_INT systemhandle, 
+                                           CCTK_INT direction,
+                                           CCTK_STRING coordname)
 \end{verbatim}
 registers a coordinate within a coordinate system, in the specified
 `direction'.  (Direction in this context means the index in the
@@ -283,9 +283,9 @@ COORDERROR\_DUPLICATENAME    & coordinate of this name already exists in this
 \end{tabular}
 
 \begin{verbatim}
-int coordhandle = Coord_CoordHandle(const cGH *GH,
-                                    const char *coordname,
-                                    const char *systemname)
+CCTK_INT coordhandle = Coord_CoordHandle(CCTK_POINTER_TO_CONST GH,
+                                         CCTK_STRING coordname,
+                                         CCTK_STRING systemname)
 \end{verbatim}
 returns the coordinate handle for a given coordinatate in a coordinate system,
 or negative on error:\beforetable
@@ -313,8 +313,8 @@ COORDERROR\_NOCOORDSYS       & no coordinate system is associated with the
 \end{tabular}
 
 \begin{verbatim}
-int systemhandle = Coord_SetDefaultSystem(const cGH *GH,
-                                          const char *systemname)
+CCTK_INT systemhandle = Coord_SetDefaultSystem(CCTK_POINTER_TO_CONST GH,
+                                               CCTK_STRING systemname)
 \end{verbatim}
 sets this coordinate system to be the default for grid variables of
 the same dimension.  It returns the handle of the system, or negative
@@ -330,6 +330,19 @@ COORDERROR\_DEFAULTEXISTS & grid variables of this dimension already have a \\
 default system will apply for each grid variable of that dimension,
 unless it is overridden.
 
+\begin{verbatim}
+CCTK_INT systemhandle = Coord_GetDefaultSystem(CCTK_POINTER_TO_CONST GH,
+                                               CCTK_INT dim)
+\end{verbatim}
+gets the default coordinate system for grid variables of dimension {\tt dim}
+(ranging from 1 to the maximum number of dimensions registered).
+It returns the handle of the system, or negative for errors:\beforetable
+\begin{tabular}{ll}
+COORDERROR\_INVALIDDIM   & given dimension is invalid\\
+COORDERROR\_NOSYSTEM     & given dimension does not have a default coordinate 
+                           system associated
+\end{tabular}
+
 
 \section{Coordinate Schema}
 \label{CactusBase_CoordBase_coordinate_schema}
-- 
cgit v1.2.3