summaryrefslogtreecommitdiff
path: root/doc/UsersGuide
diff options
context:
space:
mode:
authorallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-13 13:14:16 +0000
committerallen <allen@17b73243-c579-4c4c-a9d2-2d5706c11dac>2000-01-13 13:14:16 +0000
commit8595e13d956d48a80d16cc711f531400320705b5 (patch)
tree5e630025e0f4eb6888210212ecd8e2251536887b /doc/UsersGuide
parent270851063277379044ed7f1605bfc0f2715e35ef (diff)
Updates
git-svn-id: http://svn.cactuscode.org/flesh/trunk@1254 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/UsersGuide')
-rw-r--r--doc/UsersGuide/FunctionReference.tex22
1 files changed, 13 insertions, 9 deletions
diff --git a/doc/UsersGuide/FunctionReference.tex b/doc/UsersGuide/FunctionReference.tex
index 7e66b52f..8f5f9a57 100644
--- a/doc/UsersGuide/FunctionReference.tex
+++ b/doc/UsersGuide/FunctionReference.tex
@@ -963,29 +963,33 @@ 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{cGroup}{}{pgroup}
-\argument{int}{integer}{group}
+\function{int}{}{ierr}
+\argument{int}{}{group}
+\argument{cGroup *}{}{pgroup}
\showcargs
\begin{params}
-\parameter{pgroup}{Returns a pointer to a structure containing group information}
+\parameter{ierr}{0 for success, negative for failure}
+\parameter{group}{group index}
+\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 vartype: The type of variables in the group
+\item stagtype: 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 numvars: 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 pgroup = CCTK\_GroupData(index);}\\
- && {\t vtype = pgroup->variabletype}
+\hfill {\bf C} && {\t cGroup pgroup;}\\
+ && {\t index = CCTK\_GroupIndex(`evolve::scalars')}\\
+ &&{\t ierr = CCTK\_GroupData(index,\&pgroup);}\\
+ && {\t vtype = pgroup.vartype;}
\\
\end{tabular}
\end{examples}