summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-11 09:23:53 +0000
committerallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-11 09:23:53 +0000
commitad5f2c8a3fba47e6f1e5b438204c15bedb0f818c (patch)
tree43e66c27b55db3090df90133ca5b152cf68d87ab /doc
parent25d17935411514dda2ece09dba1ac12f77c05fb5 (diff)
Added new functions
git-svn-id: http://svn.cactuscode.org/flesh/trunk@1222 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
-rw-r--r--doc/UsersGuide/FunctionReference.tex59
1 files changed, 57 insertions, 2 deletions
diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index 9979f297..3c64a91a 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -85,6 +85,10 @@ available from C, not all are currently available from Fortran.
[\pageref{CmplxSqrt}]
Returns the square root of a complex number (only C) [not yet available]
+\item[CCTK\_CoordDir]
+ [\pageref{CoordDir}]
+ Give the direction for a given coordinate name.
+
\item[CCTK\_CoordIndex]
[\pageref{CoordIndex}]
Give the GF index for a given coordinate name.
@@ -230,6 +234,10 @@ available from C, not all are currently available from Fortran.
[\pageref{PrintGroup}]
Prints a group name from its index
+\item[CCTK\_PrintString]
+ [\pageref{PrintString}]
+ Prints a Cactus string to screen (from Fortran)
+
\item[CCTK\_PrintVar]
[\pageref{PrintVar}]
Prints a variable name from its index
@@ -487,9 +495,31 @@ available from C, not all are currently available from Fortran.
% CCC
%%%%%
+\begin{CCTKFunc}{CCTK\_CoordDir}{Give the direction for a given coordinate name.}
+\label{CoordIndex}
+\subroutine{int}{integer}{dir}
+\argument{const char *}{character*(*)}{coordname}
+\showargs
+\begin{params}
+\parameter{dir}{The direction of the coordinate}
+\parameter{coordname}{The name assigned to this coordinate}
+\end{params}
+\begin{discussion}
+The coordinate name is independent of the grid function name.
+\end{discussion}
+\begin{examples}
+\begin{tabular}{@{}p{3cm}cp{11cm}}
+\hfill {\bf C} && {\t direction = CCTK\_CoordDir(`xdir')};
+\\
+\hfill {\bf Fortran} && {\t call CCTK\_COORDDIR(direction,`radius')};
+\\
+\end{tabular}
+\end{examples}
+\begin{errorcodes}
+\end{errorcodes}
+\end{CCTKFunc}
-% Coord.c
\begin{CCTKFunc}{CCTK\_CoordIndex}{Give the GF index for a given coordinate name.}
\label{CoordIndex}
\subroutine{int}{integer}{index}
@@ -506,7 +536,7 @@ The coordinate name is independent of the grid function name.
\begin{tabular}{@{}p{3cm}cp{11cm}}
\hfill {\bf C} && {\t index = CCTK\_CoordIndex(`xdir')};
\\
-\hfill {\bf Fortran} && {\t call CCTK\_COORDINDEX(`radius')};
+\hfill {\bf Fortran} && {\t call CCTK\_COORDINDEX(index,`radius')};
\\
\end{tabular}
\end{examples}
@@ -1562,6 +1592,31 @@ This routine is for debugging purposes for Fortran programmers.
\end{errorcodes}
\end{CCTKFunc}
+% Groups.c
+\begin{CCTKFunc}{CCTK\_PrintString}{Prints a Cactus string}
+\label{PrintString}
+\subroutine{}{}{}
+\argument{char *}{CCTK\_STRING}{string}
+\showargs
+\begin{params}
+\parameter{string}{The string to print}
+\end{params}
+\begin{discussion}
+This routine can be used to print Cactus string variables and parameters
+from Fortran.
+\end{discussion}
+\begin{examples}
+\begin{tabular}{@{}p{3cm}cp{11cm}}
+\hfill {\bf C} && {\t CCTK\_PrintString(string_param) ;}
+\\
+\hfill {\bf Fortran} && {\t call CCTK\_PRINTGROUP(string_param)}\\
+\\
+\end{tabular}
+\end{examples}
+\begin{errorcodes}
+\end{errorcodes}
+\end{CCTKFunc}
+