summaryrefslogtreecommitdiff
path: root/doc/UsersGuide
diff options
context:
space:
mode:
authorallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-12 13:46:46 +0000
committerallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-12 13:46:46 +0000
commit911cd218d1e58d7bfb188c5ee6ba80ef6ad87625 (patch)
tree1c166e491aa06cd28e8d3cf412695a417d10170f /doc/UsersGuide
parent1f80bc5a88f6c391ece63384416199b465dc68f1 (diff)
Changed to function CCTK_GroupData
git-svn-id: http://svn.cactuscode.org/flesh/trunk@1236 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide')
-rw-r--r--doc/UsersGuide/FunctionReference.tex31
1 files changed, 15 insertions, 16 deletions
diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index 3c64a91a..7e66b52f 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -963,30 +963,29 @@ No Fortran routine exists at the moment.
% Groups.c
\begin{CCTKFunc}{CCTK\_GroupData}{Given a group index, returns information about the variables held in the group.}
\label{GroupData}
-\subroutine{int}{integer}{istat}
+\subroutine{cGroup}{}{pgroup}
\argument{int}{integer}{group}
-\argument{int *}{integer}{gtype}
-\argument{int *}{integer}{vtype}
-\argument{int *}{integer}{dim}
-\argument{int *}{integer}{nvars}
-\argument{int *}{integer}{ntimelevels}
\showcargs
\begin{params}
-\parameter{istat}{Returns one if a group with the given index was found, and zero otherwise}
-\parameter{group}{The group index}
-\parameter{gtype}{The group type}
-\parameter{vtype}{The type of variables in the group}
-\parameter{dim}{The dimension of variables in the group}
-\parameter{nvars}{The number of variables in the group}
-\parameter{ntimelevels}{The number of timelevels for variables in the group}
+\parameter{pgroup}{Returns a pointer to a structure containing group information}
\end{params}
\begin{discussion}
+The cGroup structure contains the information
+\begin{itemize}
+\item grouptype: The group type
+\item variabletype: The type of variables in the group
+\item staggertype: The type of grid staggering for arrays
+\item dim: The dimension of variables in the group
+\item numvariables: The number of variables in the group
+\item ntimelevels: The number of timelevels for variables in the group
+\end{itemize}
No Fortran routine exists at the moment.
\end{discussion}
\begin{examples}
\begin{tabular}{@{}p{3cm}cp{11cm}}
\hfill {\bf C} && {\t index = CCTK\_GroupIndex(`evolve::scalars')}\\
- &&{\t istat = CCTK\_GroupData(index,gtype,vtype,dim,nvars,ntimelevels);}
+ &&{\t pgroup = CCTK\_GroupData(index);}\\
+ && {\t vtype = pgroup->variabletype}
\\
\end{tabular}
\end{examples}
@@ -1607,9 +1606,9 @@ from Fortran.
\end{discussion}
\begin{examples}
\begin{tabular}{@{}p{3cm}cp{11cm}}
-\hfill {\bf C} && {\t CCTK\_PrintString(string_param) ;}
+\hfill {\bf C} && {\t CCTK\_PrintString(string\_param) ;}
\\
-\hfill {\bf Fortran} && {\t call CCTK\_PRINTGROUP(string_param)}\\
+\hfill {\bf Fortran} && {\t call CCTK\_PRINTSTRING(string\_param)}\\
\\
\end{tabular}
\end{examples}