diff options
author | jthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2006-05-31 12:53:30 +0000 |
---|---|---|
committer | jthorn <jthorn@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2006-05-31 12:53:30 +0000 |
commit | c5a2f88d8f19db00bfcc20a2c850b3502fe76658 (patch) | |
tree | 28dd23fcabb25192bf8f100e6419db07a02f1899 /doc/ReferenceManual | |
parent | 663a5a772a4be99acf5ae877871a4aec132ee457 (diff) |
permute order of entries for
CCTK_MaxTimeLevelsGI()
CCTK_MaxTimeLevelsGN()
CCTK_MaxTimeLevelsVI()
CCTK_MaxTimeLevelsVN()
to be in alphabetical order (and all come before CCTK_MyProc())
git-svn-id: http://svn.cactuscode.org/flesh/trunk@4309 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/ReferenceManual')
-rw-r--r-- | doc/ReferenceManual/CCTKReference.tex | 75 |
1 files changed, 38 insertions, 37 deletions
diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex index 15b0cdc3..ecde3ffb 100644 --- a/doc/ReferenceManual/CCTKReference.tex +++ b/doc/ReferenceManual/CCTKReference.tex @@ -6949,49 +6949,24 @@ The group name should be in the form \code{<implementation>::<group>} \end{errorcodes} \end{CCTKFunc} -\begin{CCTKFunc}{CCTK\_MaxTimeLevelsVN}{Gives the number of timelevels for a variable} -\label{CCTK-MaxTimeLevelsVN} -\subroutine{int}{integer}{numlevels} -\argument{const char *}{character*(*)}{name} -\showargs -\begin{params} -\parameter{name}{The full variable name} -\parameter{numlevels}{The number of timelevels} -\end{params} -\begin{discussion} -The variable name should be in the form \code{<implementation>::<variable>} -\end{discussion} -\begin{examples} -\begin{tabular}{@{}p{3cm}cp{11cm}} -\hfill {\bf C} && {\t numlevels = CCTK\_MaxTimeLevelsVN("evolve::phi") ;} -\\ -\hfill {\bf Fortran} && {\t call CCTK\_MAXTIMELEVELSVN(numlevels,"evolve::phi")}\\ -\\ -\end{tabular} -\end{examples} -\begin{errorcodes} -\end{errorcodes} -\end{CCTKFunc} - - % Groups.c -\begin{CCTKFunc}{CCTK\_MaxTimeLevelsVI}{Gives the number of timelevels for a variable} -\label{CCTK-MaxTimeLevelsVI} +\begin{CCTKFunc}{CCTK\_MaxTimeLevelsGI}{Gives the number of timelevels for a group} +\label{CCTK-MaxTimeLevelsGI} \subroutine{int}{integer}{numlevels} \argument{int}{integer}{index} \showargs \begin{params} \parameter{numlevels}{The number of timelevels} -\parameter{index}{The variable index} +\parameter{index}{The group index} \end{params} \begin{discussion} \end{discussion} \begin{examples} \begin{tabular}{@{}p{3cm}cp{11cm}} -\hfill {\bf C} && {\t index = CCTK\_VarIndex("evolve::phi")}\\ - &&{\t numlevels = CCTK\_MaxTimeLevelsVI(index) ;} +\hfill {\bf C} && {\t index = CCTK\_GroupIndex("evolve::phivars")}\\ + &&{\t numlevels = CCTK\_MaxTimeLevelsGI(index) ;} \\ -\hfill {\bf Fortran} && {\t call CCTK\_MAXTIMELEVELSVI(numlevels,3)}\\ +\hfill {\bf Fortran} && {\t call CCTK\_MAXTIMELEVELSGI(numlevels,3)}\\ \\ \end{tabular} \end{examples} @@ -6999,6 +6974,8 @@ The variable name should be in the form \code{<implementation>::<variable>} \end{errorcodes} \end{CCTKFunc} + +% Groups.c \begin{FunctionDescription}{CCTK\_MaxTimeLevelsGN} \label{CCTK-MaxTimeLevelsGN} Gives the number of timelevels for a group @@ -7026,24 +7003,25 @@ This function and its relatives return the maximum number of timelevels that the \end{FunctionDescription} + % Groups.c -\begin{CCTKFunc}{CCTK\_MaxTimeLevelsGI}{Gives the number of timelevels for a group} -\label{CCTK-MaxTimeLevelsGI} +\begin{CCTKFunc}{CCTK\_MaxTimeLevelsVI}{Gives the number of timelevels for a variable} +\label{CCTK-MaxTimeLevelsVI} \subroutine{int}{integer}{numlevels} \argument{int}{integer}{index} \showargs \begin{params} \parameter{numlevels}{The number of timelevels} -\parameter{index}{The group index} +\parameter{index}{The variable index} \end{params} \begin{discussion} \end{discussion} \begin{examples} \begin{tabular}{@{}p{3cm}cp{11cm}} -\hfill {\bf C} && {\t index = CCTK\_GroupIndex("evolve::phivars")}\\ - &&{\t numlevels = CCTK\_MaxTimeLevelsGI(index) ;} +\hfill {\bf C} && {\t index = CCTK\_VarIndex("evolve::phi")}\\ + &&{\t numlevels = CCTK\_MaxTimeLevelsVI(index) ;} \\ -\hfill {\bf Fortran} && {\t call CCTK\_MAXTIMELEVELSGI(numlevels,3)}\\ +\hfill {\bf Fortran} && {\t call CCTK\_MAXTIMELEVELSVI(numlevels,3)}\\ \\ \end{tabular} \end{examples} @@ -7051,6 +7029,29 @@ This function and its relatives return the maximum number of timelevels that the \end{errorcodes} \end{CCTKFunc} +\begin{CCTKFunc}{CCTK\_MaxTimeLevelsVN}{Gives the number of timelevels for a variable} +\label{CCTK-MaxTimeLevelsVN} +\subroutine{int}{integer}{numlevels} +\argument{const char *}{character*(*)}{name} +\showargs +\begin{params} +\parameter{name}{The full variable name} +\parameter{numlevels}{The number of timelevels} +\end{params} +\begin{discussion} +The variable name should be in the form \code{<implementation>::<variable>} +\end{discussion} +\begin{examples} +\begin{tabular}{@{}p{3cm}cp{11cm}} +\hfill {\bf C} && {\t numlevels = CCTK\_MaxTimeLevelsVN("evolve::phi") ;} +\\ +\hfill {\bf Fortran} && {\t call CCTK\_MAXTIMELEVELSVN(numlevels,"evolve::phi")}\\ +\\ +\end{tabular} +\end{examples} +\begin{errorcodes} +\end{errorcodes} +\end{CCTKFunc} % CommOverloadables.c \begin{CCTKFunc}{CCTK\_MyProc}{Returns the number of the local processor for a parallel run} |