summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgoodale <goodale@17b73243-c579-4c4c-a9d2-2d5706c11dac>2005-10-05 13:45:40 +0000
committergoodale <goodale@17b73243-c579-4c4c-a9d2-2d5706c11dac>2005-10-05 13:45:40 +0000
commit1d29a1e8d9c9d68428921866f577f51bc8e953d3 (patch)
tree4bee43307295985f185dcb842e549ee38c3755cc
parentf0c714f9c5eafa3005a5e03ef87101ab638aad7b (diff)
Patch from Josh to add crossreferencing.
git-svn-id: http://svn.cactuscode.org/flesh/trunk@4171 17b73243-c579-4c4c-a9d2-2d5706c11dac
-rw-r--r--doc/ReferenceManual/CCTKReference.tex112
-rw-r--r--doc/ReferenceManual/UtilReference.tex533
2 files changed, 369 insertions, 276 deletions
diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex
index da492790..699fe303 100644
--- a/doc/ReferenceManual/CCTKReference.tex
+++ b/doc/ReferenceManual/CCTKReference.tex
@@ -758,6 +758,7 @@ from Fortran.
%%%%%
% CommOverloadables.c
+%Entering a function descrpition for CCTK\_Abort
\begin{FunctionDescription}{CCTK\_Abort}
\label{CCTK-Abort}
Abnormal Cactus termination.
@@ -841,6 +842,7 @@ call CCTK_Abort (dummy, cctkGH)
% ActiveThorns.c
+%Entering a function descrpition for CCTK\_ActivatingThorn
\begin{FunctionDescription}{CCTK\_ActivatingThorn}
\label{CCTK-ActivatingThorn}
Finds the thorn which activated a particular implementation.
@@ -916,6 +918,7 @@ The implementation is inactive, or an error occurred.
% cctk_GroupsOnGH.h
+%Entering a function descrpition for CCTK\_ActiveTimeLevels
\begin{FunctionDescription}{CCTK\_ActiveTimeLevels}
\label{CCTK-ActiveTimeLevels}
Returns the number of active time levels for a group.
@@ -1039,6 +1042,7 @@ Illegal arguments given.
% cctk_Comm.h
+%Entering a function descrpition for CCTK\_ArrayGroupSize}{
\begin{FunctionDescription}{CCTK\_ArrayGroupSize}{}
\label{CCTK-ArrayGroupSize}
Returns a pointer to the processor-local size for variables in a
@@ -1084,9 +1088,9 @@ in the future. Consider using \code{CCTK\_GroupgshGN} instead.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{CCTK\_GroupgshGN}
+\begin{SeeAlso2} {CCTK\_GroupgshGN} {CCTK-GroupgshGN}
Returns an array with the array size in all dimensions.
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{...}
There are many related functions which grab information from the GH,
but many are not yet documented.
@@ -1100,6 +1104,7 @@ but many are not yet documented.
% cctk_Comm.h
+%Entering a function descrpition for CCTK\_ArrayGroupSizeI}{
\begin{FunctionDescription}{CCTK\_ArrayGroupSizeI}{}
\label{CCTK-ArrayGroupSizeI}
Returns a pointer to the processor-local size for variables in a
@@ -1146,9 +1151,9 @@ in the future. Consider using \code{CCTK\_GroupgshGI} instead.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{CCTK\_GroupgshGI}
+\begin{SeeAlso2} {CCTK\_GroupgshGI} {CCTK-GroupgshGI}
Returns an array with the array size in all dimensions.
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{...}
There are many related functions which grab information from the GH,
but many are not yet documented.
@@ -1188,6 +1193,7 @@ it must be called by all processors otherwise the code will hang.
% CCC
%%%%%
+%Entering a function descrpition for CCTK\_ClockRegister
\begin{FunctionDescription}{CCTK\_ClockRegister}
\label{CCTK-ClockRegister}
Registers a named timer clock with the Flesh.
@@ -1611,6 +1617,7 @@ Error.
% cctk_ActiveThorns.c
+%Entering a function descrpition for CCTK\_CompiledThorn
\begin{FunctionDescription}{CCTK\_CompiledThorn}
\label{CCTK-CompiledThorn}
Return the name of the compiled thorn with given index.
@@ -2225,6 +2232,7 @@ the Cactus scheduler via a thorn's \code{schedule.ccl} file.
\end{CCTKFunc}
% CommOverloadables.c
+%Entering a function descrpition for CCTK\_Equals
\begin{FunctionDescription}{CCTK\_Equals}
\label{CCTK-Equals}
Checks a STRING or KEYWORD parameter for equality with a given string
@@ -2278,9 +2286,9 @@ See the examples below for typical usage.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_StrCmpi}
+\begin{SeeAlso2} {Util\_StrCmpi} {Util-StrCmpi}
compare two C-style strings case-independently
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2364,6 +2372,7 @@ It never returns to the caller.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Groups.c
+%Entering a function descrpition for CCTK\_FirstVarIndex
\begin{FunctionDescription}{CCTK\_FirstVarIndex}
\label{CCTK-FirstVarIndex}
Given a group name, returns the first variable index in the group.
@@ -2433,6 +2442,7 @@ Group has no members.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Groups.c
+%Entering a function descrpition for CCTK\_FirstVarIndexI
\begin{FunctionDescription}{CCTK\_FirstVarIndexI}
\label{CCTK-FirstVarIndexI}
Given a group index, returns the first variable index in the group.
@@ -2497,6 +2507,7 @@ Group has no members.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for CCTK\_FortranString
\begin{FunctionDescription}{CCTK\_FortranString}
\label{CCTK-FortranString}
Copy the contents of a C string into a Fortran string variable
@@ -2913,6 +2924,7 @@ The number of grid array reduction operators registered
% GroupsOnGH.h
+%Entering a function descrpition for CCTK\_GroupbboxGI, CCTK\_GroupbboxGN
\begin{FunctionDescription}{CCTK\_GroupbboxGI, CCTK\_GroupbboxGN}
\label{CCTK-GroupbboxGI}
\label{CCTK-GroupbboxGN}
@@ -2980,6 +2992,7 @@ Returns the lower bounds for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GroupbboxVI, CCTK\_GroupbboxVN
\begin{FunctionDescription}{CCTK\_GroupbboxVI, CCTK\_GroupbboxVN}
\label{CCTK-GroupbboxVI}
\label{CCTK-GroupbboxVN}
@@ -3049,6 +3062,7 @@ Returns the upper bounds for a given group.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Groups.c
+%Entering a function descrpition for CCTK\_GroupData
\begin{FunctionDescription}{CCTK\_GroupData}
\label{CCTK-GroupData}
Given a group index, returns information about the group and its variables.
@@ -3121,27 +3135,27 @@ The {\t cGroup} structure%%%
\begin{SeeAlso}{"interface.ccl"}
Defines variables, groups, tags tables, and lots of other things.
\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupDynamicData}
+\begin{SeeAlso2} {CCTK\_GroupDynamicData} {CCTK-GroupDynamicData}
Gets grid-size information for a group's variables.
-\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupIndex}
+\end{SeeAlso2}
+\begin{SeeAlso2} {CCTK\_GroupIndex} {CCTK-GroupIndex}
Gets the group index for a given group name.
-\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupIndexFromVar}
+\end{SeeAlso2}
+\begin{SeeAlso2} {CCTK\_GroupIndexFromVar} {CCTK-GroupIndexFromVar}
Gets the group index for a given variable name.
-\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupName}
+\end{SeeAlso2}
+\begin{SeeAlso2} {CCTK\_GroupName} {CCTK-GroupName}
Gets the group name for a given group index.
-\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupNameFromVar}
+\end{SeeAlso2}
+\begin{SeeAlso2} {CCTK\_GroupNameFromVar} {CCTK-GroupNameFromVar}
Gets the group name for a given variable name.
-\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupTypeI}
+\end{SeeAlso2}
+\begin{SeeAlso2} {CCTK\_GroupTypeI} {CCTK-GroupTypeI}
Gets a group type index for a given group index.
-\end{SeeAlso}
-\begin{SeeAlso}{CCTK\_GroupTypeFromVarI}
+\end{SeeAlso2}
+\begin{SeeAlso2} {CCTK\_GroupTypeFromVarI} {CCTK-GroupTypeFromVarI}
Gets a group type index for a given variable index.
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3184,6 +3198,7 @@ printf("this group's arrays are %-dimensional and have %d time levels\n",
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for CCTK\_GroupgshGI, CCTK\_GroupgshGN
\begin{FunctionDescription}{CCTK\_GroupgshGI, CCTK\_GroupgshGN}
\label{CCTK-GroupgshGI}
\label{CCTK-GroupgshGN}
@@ -3256,6 +3271,7 @@ Returns the local size for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GroupgshVI, CCTK\_GroupgshVN
\begin{FunctionDescription}{CCTK\_GroupgshVI, CCTK\_GroupgshVN}
\label{CCTK-GroupgshVI}
\label{CCTK-GroupgshVN}
@@ -3408,6 +3424,7 @@ The variable name should be in the form \code{<implementation>::<variable>}
\end{CCTKFunc}
+%Entering a function descrpition for CCTK\_GrouplbndGI, CCTK\_GrouplbndGN
\begin{FunctionDescription}{CCTK\_GrouplbndGI, CCTK\_GrouplbndGN}
\label{CCTK-GrouplbndGI}
\label{CCTK-GrouplbndGN}
@@ -3481,6 +3498,7 @@ Returns the upper bounds for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GrouplbndVI, CCTK\_GrouplbndVN
\begin{FunctionDescription}{CCTK\_GrouplbndVI, CCTK\_GrouplbndVN}
\label{CCTK-GrouplbndVI}
\label{CCTK-GrouplbndVN}
@@ -3554,6 +3572,7 @@ Returns the upper bounds for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GrouplshGI, CCTK\_GrouplshGN
\begin{FunctionDescription}{CCTK\_GrouplshGI, CCTK\_GrouplshGN}
\label{CCTK-GrouplshGI}
\label{CCTK-GrouplshGN}
@@ -3626,6 +3645,7 @@ Returns the local size for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GrouplshVI, CCTK\_GrouplshVN
\begin{FunctionDescription}{CCTK\_GrouplshVI, CCTK\_GrouplshVN}
\label{CCTK-GrouplshVI}
\label{CCTK-GrouplshVN}
@@ -3753,6 +3773,7 @@ No Fortran routine exists at the moment.
+%Entering a function descrpition for CCTK\_GroupnghostzonesGI, CCTK\_GroupnghostzonesGN
\begin{FunctionDescription}{CCTK\_GroupnghostzonesGI, CCTK\_GroupnghostzonesGN}
\label{CCTK-GroupnghostzonesGI}
\label{CCTK-GroupnghostzonesGN}
@@ -3818,6 +3839,7 @@ Returns the number of ghostzones for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GroupnghostzonesVI, CCTK\_GroupnghostzonesVN
\begin{FunctionDescription}{CCTK\_GroupnghostzonesVI, CCTK\_GroupnghostzonesVN}
\label{CCTK-GroupnghostzonesVI}
\label{CCTK-GroupnghostzonesVN}
@@ -3914,6 +3936,7 @@ with the Cactus provided macros for \code{CCTK\_SCALAR},
\end{errorcodes}
\end{CCTKFunc}
+%Entering a function descrpition for CCTK\_GroupTypeI}{
\begin{FunctionDescription}{CCTK\_GroupTypeI}{}
\label{CCTK-GroupTypeI}
Provides a group's group type index given a group index
@@ -3946,9 +3969,9 @@ for \code{CCTK\_SCALAR}, \code{CCTK\_GF}, \code{CCTK\_ARRAY}.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{CCTK\_GroupTypeFromVarI}
+\begin{SeeAlso2} {CCTK\_GroupTypeFromVarI} {CCTK-GroupTypeFromVarI}
This function takes a variable index rather than a group index as its argument.
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
%\begin{ErrorSection}
%\end{ErrorSection}
@@ -3957,6 +3980,7 @@ This function takes a variable index rather than a group index as its argument.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GroupubndGI, CCTK\_GroupubndGN
\begin{FunctionDescription}{CCTK\_GroupubndGI, CCTK\_GroupubndGN}
\label{CCTK-GroupubndGI}
\label{CCTK-GroupubndGN}
@@ -4030,6 +4054,7 @@ Returns the upper bounds for a given variable.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_GroupubndVI, CCTK\_GroupubndVN
\begin{FunctionDescription}{CCTK\_GroupubndVI, CCTK\_GroupubndVN}
\label{CCTK-GroupubndVI}
\label{CCTK-GroupubndVN}
@@ -4139,6 +4164,7 @@ No Fortran routine exists at the moment
% cctk_ActiveThorns.c
+%Entering a function descrpition for CCTK\_ImplementationRequires
\begin{FunctionDescription}{CCTK\_ImplementationRequires}
\label{CCTK-ImplementationRequires}
Return the ancestors for an implementation.
@@ -4220,6 +4246,7 @@ uStringList *imps = CCTK_ImplementationRequires(const char *imp);
% cctk_ActiveThorns.c
+%Entering a function descrpition for CCTK\_ImplementationThorn
\begin{FunctionDescription}{CCTK\_ImplementationThorn}
\label{CCTK-ImplementationThorn}
Returns the name of one thorn providing an implementation.
@@ -4301,6 +4328,7 @@ Error.
% cctk_ActiveThorns.c
+%Entering a function descrpition for CCTK\_ImpThornList
\begin{FunctionDescription}{CCTK\_ImpThornList}
\label{CCTK-ImpThornList}
Return the thorns for an implementation.
@@ -4383,6 +4411,7 @@ Name of implementation
% WarnLevel.c
+%Entering a function descrpition for CCTK\_INFO
\begin{FunctionDescription}{CCTK\_INFO}
\label{CCTK-INFO}
Macro to print a single string as an information message to screen
@@ -4467,6 +4496,7 @@ call CCTK_INFO(message)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for CCTK\_InterpGridArrays
\begin{FunctionDescription}{CCTK\_InterpGridArrays}
\label{CCTK-InterpGridArrays}
Interpolate a list of distributed grid arrays
@@ -4865,6 +4895,7 @@ A negative value is returned for invalid/unregistered interpolation operator nam
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%notyet % Interp.c
+%Entering a function descrpition for CCTK\_InterpLocalNonUniform
%notyet \begin{FunctionDescription}{CCTK\_InterpLocalNonUniform}
%notyet \label{CCTK-InterpLocalNonUniform}
%notyet Interpolate a list of processor-local arrays
@@ -5167,6 +5198,7 @@ A negative value is returned for invalid/unregistered interpolation operator nam
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Interp.c
+%Entering a function descrpition for CCTK\_InterpLocalUniform
\begin{FunctionDescription}{CCTK\_InterpLocalUniform}
\label{CCTK-InterpLocalUniform}
Interpolate a list of processor-local arrays
@@ -5477,6 +5509,7 @@ if (CCTK_InterpLocalUniform(N_DIMS,
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%notyet % Interp.c
+%Entering a function descrpition for CCTK\_InterpLocalWarped
%notyet \begin{FunctionDescription}{CCTK\_InterpLocalWarped}
%notyet \label{CCTK-InterpLocalWarped}
%notyet Interpolate a list of processor-local arrays
@@ -5786,6 +5819,7 @@ if (CCTK_InterpLocalUniform(N_DIMS,
% here should be CCTK\_InterpRegisterOpLocalNonUniform
% Interp.c
+%Entering a function descrpition for CCTK\_InterpRegisterOpLocalUniform
\begin{FunctionDescription}{CCTK\_InterpRegisterOpLocalUniform}
\label{CCTK-InterpRegisterOpLocalUniform}
Register a \code{CCTK\_InterpLocalUniform} interpolation operator.
@@ -5968,6 +6002,7 @@ See also
\end{CCTKFunc}
% ActiveThorns.c
+%Entering a function descrpition for CCTK\_IsThornActive
\begin{FunctionDescription}{CCTK\_IsThornActive}
\label{CCTK-IsThornActive}
Reports whether a thorn was activated in a parameter file
@@ -6113,6 +6148,7 @@ The number of local reduction operators registered
\end{FunctionDescription}
%Reduction.c
+%Entering a function descrpition for CCTK\_LocalArrayReduceOperatorImplementation
\begin{FunctionDescription}{CCTK\_LocalArrayReduceOperatorImplementation}
\label{CCTK-LocalArrayReduceOperatorImplementation}
Provide the implementation which provides an local array reduction operator
@@ -6169,6 +6205,7 @@ The number of local reduction operators registered
\end{FunctionDescription}
%Reduction.c
+%Entering a function descrpition for CCTK\_LocalArrayReductionHandle
\begin{FunctionDescription}{CCTK\_LocalArrayReductionHandle}
\label{CCTK-LocalArrayReductionHandle}
Returns the handle of a given local array reduction operator
@@ -6406,6 +6443,7 @@ For a single processor run this call will return one.
% util/Misc.c
+%Entering a function descrpition for CCTK\_NullPointer
\begin{FunctionDescription}{CCTK\_NullPointer}%%%
\label{CCTK-NullPointer}
Returns a C-style NULL pointer value.
@@ -6463,6 +6501,7 @@ call Util_TableSetPointer(ierror, table_handle, pointer_var, "NULL pointer")
% cctk_ActiveThorns.c
+%Entering a function descrpition for CCTK\_NumCompiledImplementations
\begin{FunctionDescription}{CCTK\_NumCompiledImplementations}
\label{CCTK-NumCompiledImplementations}
Return the number of implementations compiled in.
@@ -6538,6 +6577,7 @@ Number of implementations compiled in.
% cctk_ActiveThorns.c
+%Entering a function descrpition for CCTK\_NumCompiledThorns
\begin{FunctionDescription}{CCTK\_NumCompiledThorns}
\label{CCTK-NumCompiledThorns}
Return the number of thorns compiled in.
@@ -6612,6 +6652,7 @@ Number of thorns compiled in.
%Reduction.c
+%Entering a function descrpition for CCTK\_NumGridArrayReductionOperators
\begin{FunctionDescription}{CCTK\_NumGridArrayReductionOperators}
\label{CCTK-NumGridArrayReductionOperators}
The number of grid array reduction operators registered
@@ -6681,6 +6722,7 @@ The name of the grid reduction operator, or NULL if none is registered
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for CCTK\_NumIOMethods
\begin{FunctionDescription}{CCTK\_NumIOMethods}
\label{CCTK-NumIOMethods}
Find the total number of I/O methods registered with the flesh
@@ -6766,6 +6808,7 @@ Returns the name of a registered reduction operator
% cctk_GroupsOnGH.h
+%Entering a function descrpition for CCTK\_NumTimeLevels
\begin{FunctionDescription}{CCTK\_NumTimeLevels}
\label{CCTK-NumTimeLevels}
Returns the number of active time levels for a group (deprecated).
@@ -6890,6 +6933,7 @@ Illegal arguments given.
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_NumTimerClocks
\begin{FunctionDescription}{CCTK\_NumTimerClocks}
\label{CCTK-NumTimerClocks}
Given a {\tt cTimerData} structure, returns its number of clocks.
@@ -7321,6 +7365,7 @@ No parameter with that name was found.
% Parameters.c
+%Entering a function descrpition for CCTK\_ParameterGet
\begin{FunctionDescription}{CCTK\_ParameterGet}
\label{CCTK-ParameterGet}
Get the data pointer to and type of a parameter's value.
@@ -7394,6 +7439,7 @@ No parameter with that name was found.
% WaveLevel.c
+%Entering a function descrpition for CCTK\_ParameterLevel
\begin{FunctionDescription}{CCTK\_ParameterLevel}
\label{CCTK-ParameterLevel}
Return the parameter checking level.
@@ -7438,6 +7484,7 @@ Parameter checking level now being used.
% Parameters.c
+%Entering a function descrpition for CCTK\_ParameterQueryTimesSet
\begin{FunctionDescription}{CCTK\_ParameterQueryTimesSet}
\label{CCTK-ParameterQueryTimesSet}
Return number of times a parameter has been set.
@@ -7510,6 +7557,7 @@ No parameter with that name exists.
% Parameters.c
+%Entering a function descrpition for CCTK\_ParameterSet
\begin{FunctionDescription}{CCTK\_ParameterSet}
\label{CCTK-ParameterSet}
Sets the value of a parameter.
@@ -7589,6 +7637,7 @@ parameter as used.
% Parameters.c
+%Entering a function descrpition for CCTK\_ParameterValString
\begin{FunctionDescription}{CCTK\_ParameterValString}
\label{CCTK-ParameterValString}
Get the string representation of a parameter's value.
@@ -7682,6 +7731,7 @@ No parameter with that name was found.
% Parameters.c
+%Entering a function descrpition for CCTK\_ParameterWalk
\begin{FunctionDescription}{CCTK\_ParameterWalk}
\label{CCTK-ParameterWalk}
Walk through the list of parameters.
@@ -7784,6 +7834,7 @@ checked.
% util/Misc.c
+%Entering a function descrpition for CCTK\_PointerTo
\begin{FunctionDescription}{CCTK\_PointerTo}%%%
\label{CCTK-PointerTo}
Returns a pointer to a Fortran variable.
@@ -8017,6 +8068,7 @@ A negative error code is returned for an invalid group name.
% CCTK\_Reduce here
%Reduction.c
+%Entering a function descrpition for CCTK\_ReduceGridArrays
\begin{FunctionDescription}{CCTK\_ReduceGridArrays}
\label{CCTK-ReduceGridArrays}
Performs reduction on a list of distributed grid arrays
@@ -8212,6 +8264,7 @@ Util_TableDestroy(param_table_handle);
\end{FunctionDescription}
%Reduction.c
+%Entering a function descrpition for CCTK\_ReduceLocalArrays
\begin{FunctionDescription}{CCTK\_ReduceLocalArrays}
\label{CCTK-ReduceLocalArrays}
Performs reduction on a list of local grid arrays
@@ -8556,6 +8609,7 @@ displayed in the order in which they are registered.
\end{CCTKFunc}
%Reduction.c
+%Entering a function descrpition for CCTK\_RegisterGridArrayReductionOperator
\begin{FunctionDescription}{CCTK\_RegisterGridArrayReductionOperator}
\label{CCTK-RegisterGridArrayReductionOperator}
Registers a function as a grid array reduction operator of a certain name
@@ -8703,6 +8757,7 @@ IO methods should be registered at \code{CCTK\_STARTUP}.
\end{CCTKFunc}
%Reduction.c
+%Entering a function descrpition for CCTK\_RegisterLocalArrayReductionOperator
\begin{FunctionDescription}{CCTK\_RegisterLocalArrayReductionOperator}
\label{CCTK-RegisterLocalArrayReductionOperator}
Registers a function as a reduction operator of a certain name
@@ -8844,6 +8899,7 @@ the preferred method from synchronising variables.
% TTT
%%%%%
+%Entering a function descrpition for CCTK\_TerminateNext
\begin{FunctionDescription}{CCTK\_TerminateNext}
\label{CCTK-TerminateNext}
Flags a Cactus simulation to terminate after the next iteration
@@ -8962,6 +9018,7 @@ Error.
+%Entering a function descrpition for CCTK\_Timer
\begin{FunctionDescription}{CCTK\_Timer}
\label{CCTK-Timer}
Fills a {\tt cTimerData}
@@ -9537,6 +9594,7 @@ with the Cactus provided macros for \code{CCTK\_VARIABLE\_INT}, \code{CCTK\_VARI
\end{errorcodes}
\end{CCTKFunc}
+%Entering a function descrpition for CCTK\_VarTypeSize
\begin{FunctionDescription}{CCTK\_VarTypeSize}
\label{CCTK-VarTypeSize}
Provides variable type size in bytes from the variable type index
@@ -9623,9 +9681,9 @@ semantics is equivalent to \code{printf}.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{CCTK\_INFO}
+\begin{SeeAlso2} {CCTK\_INFO} {CCTK-INFO}
macro to print an info message with a single string argument
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ExampleSection}
@@ -9643,6 +9701,7 @@ CCTK_VInfo(CCTK_THORNSTRING, "Output files will go to '%s'", outdir);
\end{FunctionDescription}
+%Entering a function descrpition for CCTK\_VWarn
\begin{FunctionDescription}{CCTK\_VWarn}
\label{CCTK-VWarn}
Possibly prints a formatted string with a variable argument list as
@@ -9759,9 +9818,9 @@ print everything.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{CCTK\_WARN}
+\begin{SeeAlso2} {CCTK\_WARN} {CCTK-WARN}
macro to print a warning message with a single string argument
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ExampleSection}
@@ -9789,6 +9848,7 @@ CCTK_VWarn(CCTK_WARN_ALERT, __LINE__, __FILE__, CCTK_THORNSTRING,
% WarnLevel.c
+%Entering a function descrpition for CCTK\_WARN
\begin{FunctionDescription}{CCTK\_WARN}
\label{CCTK-WARN}
Macro to print a single string as a warning message and possibly stop the code
diff --git a/doc/ReferenceManual/UtilReference.tex b/doc/ReferenceManual/UtilReference.tex
index 435d64b3..d8d73a40 100644
--- a/doc/ReferenceManual/UtilReference.tex
+++ b/doc/ReferenceManual/UtilReference.tex
@@ -341,6 +341,7 @@ a copy of a specified C-style null-terminated character string
\chapter{Full Descriptions of Miscellaneous Functions}
+%Entering a function descrpition for Util\_sprintf
\begin{FunctionDescription}{Util\_sprintf}
\label{Util-snprintf}
Safely format data into a caller-supplied buffer.
@@ -469,6 +470,7 @@ if (len >= N_BUFFER)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_StrCmpi
\begin{FunctionDescription}{Util\_StrCmpi}
\label{Util-StrCmpi}
Compare two strings, ignoring upper/lower case.
@@ -605,6 +607,7 @@ else
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_Strdup
\begin{FunctionDescription}{Util\_Strdup}
\label{Util-Strdup}
``Duplicate'' a string, i.e.\ copy it to a newly--\code{malloc}ed buffer.
@@ -652,9 +655,9 @@ to copy a string to a buffer.
{\em This does not check that the buffer is big enough to hold the string,
and is thus very dangerous. Use \code{Util\_Strlcpy()} instead!}
\end{SeeAlso}
-\begin{SeeAlso}{Util\_Strlcpy()}
+\begin{SeeAlso2} {Util\_Strlcpy()} {Util-Strlcpy}
Safely copy a string.
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -698,6 +701,7 @@ return 42;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_Strlcat
\begin{FunctionDescription}{Util\_Strlcat}
\label{Util-Strlcat}
Concatenate strings safely.
@@ -769,9 +773,9 @@ to concatenate two strings.
{\em This does not check that the buffer is big enough to hold the result,
and is thus very dangerous. Use \code{Util\_Strlcat()} instead!}
\end{SeeAlso}
-\begin{SeeAlso}{Util\_Strlcpy()}
+\begin{SeeAlso2} {Util\_Strlcpy()} {Util-Strlcpy}
Safely copy a string.
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ExampleSection}
@@ -830,6 +834,7 @@ return OK; /*** NORMAL RETURN ***/
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_Strlcpy
\begin{FunctionDescription}{Util\_Strlcpy}
\label{Util-Strlcpy}
Copies a string safely.
@@ -902,12 +907,12 @@ to copy a string to a buffer.
{\em This does not check that the buffer is big enough to hold the string,
and is thus very dangerous. Use \code{Util\_Strlcpy()} instead!}
\end{SeeAlso}
-\begin{SeeAlso}{Util\_Strdup()}
+\begin{SeeAlso2} {Util\_Strdup()} {Util-Strdup}
``Duplicate'' a string, i.e.\ copy it to a newly-\code{malloc}ed buffer.
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_Strlcat()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_Strlcat()} {Util-Strlcat}
Safely concatenates two strings.
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ExampleSection}
@@ -966,6 +971,7 @@ return OK; /*** NORMAL RETURN ***/
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_StrSep
\begin{FunctionDescription}{Util\_StrSep}
\label{Util-StrSep}
Separate off the first token from a string.
@@ -1116,6 +1122,7 @@ return i;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableClone
\begin{FunctionDescription}{Util\_TableClone}
\label{Util-TableClone}
Creates a new table which is a ``clone'' (exact copy) of an existing
@@ -1174,16 +1181,16 @@ tables with identical key/value contents.)
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreate()}
+\begin{SeeAlso2} {Util\_TableCreate()} {Util-TableCreate}
create a table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableDestroy()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableDestroy()} {Util-TableDestroy}
destroy a table
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -1242,6 +1249,7 @@ return 0;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableCreate
\begin{FunctionDescription}{Util\_TableCreate}
\label{Util-TableCreate}
Creates a new (empty) table
@@ -1305,20 +1313,20 @@ in \code{"util\_Table.h"}:
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_StrCmpi()}
+\begin{SeeAlso2} {Util\_StrCmpi()} {Util-StrCmpi}
compare two strings, ignoring upper/lower case
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableClone()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableClone()} {Util-TableClone}
create a new table which is a ``clone'' (exact copy) of an existing
table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableDestroy()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableDestroy()} {Util-TableDestroy}
destroy a table
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -1348,6 +1356,7 @@ int handle2 = Util_TableCreate(UTIL_TABLE_FLAGS_CASE_INSENSITIVE);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableCreateFromString
\begin{FunctionDescription}{Util\_TableCreateFromString}
\label{Util-TableCreateFromString}
Creates a new table (with the case-insensitive flag set) and sets
@@ -1386,22 +1395,22 @@ for a full description of the syntax and semantics of this string
\end{ParameterSection}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableClone()}
+\begin{SeeAlso2} {Util\_TableClone()} {Util-TableClone}
Create a new table which is a ``clone'' (exact copy) of an existing
table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreate()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreate()} {Util-TableCreate}
create a table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
sets values in a table based on a string argument
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetInt()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetInt()} {Util-TableSetInt}
store a \code{CCTK\_INT} value in a table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetReal()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetReal()} {Util-TableSetReal}
store a \code{CCTK\_REAL} value in a table
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -1453,6 +1462,7 @@ Util_TableSetIntArray(handle, 4, array, "myarray");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableDeleteKey
\begin{FunctionDescription}{Util\_TableDeleteKey}
\label{Util-TableDeleteKey}
Deletes a specified key/value entry from a table
@@ -1546,17 +1556,17 @@ Of course, this function invalidates any and all iterators for the table. :)
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableClone()}
+\begin{SeeAlso2} {Util\_TableClone()} {Util-TableClone}
Create a new table which is a ``clone'' (exact copy) of an existing
table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreate()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreate()} {Util-TableCreate}
create a table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -1588,6 +1598,7 @@ Util_TableDestroy(handle);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableGet*
\begin{FunctionDescription}{Util\_TableGet*}
\label{Util-TableGet*}
This is a family of functions, one for each Cactus data type,
@@ -1673,35 +1684,35 @@ If any error code is returned, the user's value buffer
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -1750,6 +1761,7 @@ N = Util_TableGetInt(handle, &x, "empty array");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableGet*Array
\begin{FunctionDescription}{Util\_TableGet*Array}
\label{Util-TableGet*Array}
This is a family of functions, one for each Cactus data type,
@@ -1837,42 +1849,42 @@ If any error code is returned, the user's value buffer
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -1919,6 +1931,7 @@ N = Util_TableGetRealArray(handle, N_OUTPUT, output, "blah blah blah");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableGetGeneric
\begin{FunctionDescription}{Util\_TableGetGeneric}
\label{Util-TableGetGeneric}
Get the single (1-element array) value, or more generally the
@@ -1993,46 +2006,46 @@ If any error code is returned, the user's value buffer
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItQueryValueInfo()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItQueryValueInfo()} {Util-TableItQueryValueInfo}
query key present/absent in table, and optionally type and/or number
of elements, using an iterator
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableQueryValueInfo()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableQueryValueInfo()} {Util-TableQueryValueInfo}
query key present/absent in table, and optionally type and/or number
of elements
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2083,6 +2096,7 @@ N = Util_TableGetGeneric(handle, CCTK_VARIABLE_INT, &x, "empty array");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableGetGenericArray
\begin{FunctionDescription}{Util\_TableGetGenericArray}
\label{Util-TableGetGenericArray}
Get a copy of the value associated with a specified key, and store
@@ -2166,50 +2180,50 @@ If any error code is returned, the user's value buffer
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItQueryValueInfo()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItQueryValueInfo()} {Util-TableItQueryValueInfo}
query key present/absent in table, and optionally type and/or number
of elements, using an iterator
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableQueryValueInfo()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableQueryValueInfo()} {Util-TableQueryValueInfo}
query key present/absent in table, and optionally type and/or number
of elements
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2264,6 +2278,7 @@ N = Util_TableGetGenericArray(handle,
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableGetString
\begin{FunctionDescription}{Util\_TableGetString}
\label{Util-TableGetString}
Gets a copy of the character-string value associated with a specified
@@ -2336,10 +2351,10 @@ string length.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -2347,37 +2362,37 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetCharArray()}
+\begin{SeeAlso2} {Util\_TableGetCharArray()} {Util-TableGetCharArray}
get an array-of-\code{CCTK\_CHAR} value
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetCharArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetCharArray()} {Util-TableSetCharArray}
set an array-of-\code{CCTK\_CHAR} value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2426,6 +2441,7 @@ Util_TableGetString(handle, N_BUFFER, buffer, "Einstein");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItAdvance
\begin{FunctionDescription}{Util\_TableItAdvance}
\label{Util-TableItAdvance}
Advance a table iterator to the next entry in the table
@@ -2533,16 +2549,16 @@ by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableClone()}
+\begin{SeeAlso2} {Util\_TableClone()} {Util-TableClone}
create a new table which is a ``clone'' (exact copy) of an existing
table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItCreate()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItCreate()} {Util-TableItCreate}
create a table iterator
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItDestroy()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItDestroy()} {Util-TableItDestroy}
destroy a table iterator
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2620,6 +2636,7 @@ return clone_ihandle; /* normal return */
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItCreate
\begin{FunctionDescription}{Util\_TableItCreate}
\label{Util-TableItCreate}
Create a new table iterator
@@ -2652,9 +2669,9 @@ points at the starting table entry.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItDestroy()}
+\begin{SeeAlso2} {Util\_TableItDestroy()} {Util-TableItDestroy}
destroy a table iterator
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2687,6 +2704,7 @@ Util_TableItDestroy(ihandle);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItDestroy
\begin{FunctionDescription}{Util\_TableItDestroy}
\label{Util-TableItDestroy}
Destroy a table iterator
@@ -2717,9 +2735,9 @@ handle to the table iterator
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItCreate()}
+\begin{SeeAlso2} {Util\_TableItCreate()} {Util-TableItCreate}
create a table iterator
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2752,6 +2770,7 @@ Util_TableItDestroy(ihandle);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItQueryIsNonNull
\begin{FunctionDescription}{Util\_TableItQueryIsNonNull}
\label{Util-TableItQueryIsNonNull}
Query whether a table iterator is {\em not\/} in the ``null-pointer'' state
@@ -2794,9 +2813,9 @@ by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItQueryIsNull()}
+\begin{SeeAlso2} {Util\_TableItQueryIsNull()} {Util-TableItQueryIsNull}
query whether a table iterator is in the ``null-pointer'' state
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2826,6 +2845,7 @@ Util_TableItDestroy(ihandle);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItQueryIsNull
\begin{FunctionDescription}{Util\_TableItQueryIsNull}
\label{Util-TableItQueryIsNull}
Query whether a table iterator is in the ``null-pointer'' state
@@ -2868,10 +2888,10 @@ by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItQueryIsNonNull()}
+\begin{SeeAlso2} {Util\_TableItQueryIsNonNull()} {Util-TableItQueryIsNonNull}
query whether a table iterator is {\em not\/} in the ``null-pointer'' state,
i.e.\ whether the iterator points to some table entry
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -2901,6 +2921,7 @@ Util_TableItDestroy(ihandle);
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItQueryKeyValueInfo
\begin{FunctionDescription}{Util\_TableItQueryKeyValueInfo}
\label{Util-TableItQueryKeyValueInfo}
Query the key and the type and number of elements of the value
@@ -2972,10 +2993,10 @@ buffer. If any other error code is returned, the user's key buffer
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableQueryValueInfo()}
+\begin{SeeAlso2} {Util\_TableQueryValueInfo()} {Util-TableQueryValueInfo}
query key present/absent in table, and optionally type and/or number
of elements, but using the key instead of an iterator
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3060,6 +3081,7 @@ return 0;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItQueryTableHandle
\begin{FunctionDescription}{Util\_TableItQueryTableHandle}
\label{Util-TableItQueryTableHandle}
Query what table a table iterator iterates over
@@ -3095,9 +3117,9 @@ invalidated by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItCreate()}
+\begin{SeeAlso2} {Util\_TableItCreate()} {Util-TableItCreate}
create an iterator (which iterates over a specified table)
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3109,6 +3131,7 @@ iterator handle is invalid
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItResetToStart
\begin{FunctionDescription}{Util\_TableItResetToStart}
\label{Util-TableItResetToStart}
Reset a table iterator to point to the starting table entry
@@ -3153,12 +3176,12 @@ invalidated by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItSetToNull()}
+\begin{SeeAlso2} {Util\_TableItSetToNull()} {Util-TableItSetToNull}
set an iterator to the ``null-pointer'' state
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItSetToKey()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItSetToKey()} {Util-TableItSetToKey}
set an iterator to point to a specified table entry
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3170,6 +3193,7 @@ iterator handle is invalid
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItSetToKey
\begin{FunctionDescription}{Util\_TableItSetToKey}
\label{Util-TableItSetToKey}
Set a table iterator to point to a specified table entry
@@ -3210,12 +3234,12 @@ invalidated by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItResetToStart()}
+\begin{SeeAlso2} {Util\_TableItResetToStart()} {Util-TableItResetToStart}
reset an iterator to point to the starting table entry
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItSetToNull()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItSetToNull()} {Util-TableItSetToNull}
set a table iterator to the "null-pointer" state
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3233,6 +3257,7 @@ no such key in table
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableItSetToNull
\begin{FunctionDescription}{Util\_TableItSetToNull}
\label{Util-TableItSetToNull}
Set a table iterator to the "null-pointer" state
@@ -3268,12 +3293,12 @@ invalidated by a change in the table's contents.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItResetToStart()}
+\begin{SeeAlso2} {Util\_TableItResetToStart()} {Util-TableItResetToStart}
reset an iterator to point to the starting table entry
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableItSetToKey()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableItSetToKey()} {Util-TableItSetToKey}
set an iterator to point to a specified table entry
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3285,6 +3310,7 @@ iterator handle is invalid
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableQueryFlags
\begin{FunctionDescription}{Util\_TableQueryFlags}
Query a table's flags word
\label{Util-TableQueryFlags}
@@ -3323,18 +3349,18 @@ of flag words.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableClone()}
+\begin{SeeAlso2} {Util\_TableClone()} {Util-TableClone}
create a new table which is a ``clone'' (exact copy) of an existing
table
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreate()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreate()} {Util-TableCreate}
create a table (flags word specified explicitly)
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table (with certain default flags)
and set key/value entries in it based on a parameter-file--like
character string
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3367,6 +3393,7 @@ return (flags & UTIL_TABLE_FLAGS_CASE_INSENSITIVE)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableQueryValueInfo
\begin{FunctionDescription}{Util\_TableQueryValueInfo}
\label{Util-TableQueryValueInfo}
Query whether or not a specified key is in the table, and optionally
@@ -3437,10 +3464,10 @@ unchanged.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableItQueryKeyValueInfo()}
+\begin{SeeAlso2} {Util\_TableItQueryKeyValueInfo()} {Util-TableItQueryKeyValueInfo}
query key present/absent in table, and optionally type and/or number
of elements, but using an iterator instead of the key
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3490,6 +3517,7 @@ assert( N_elements == N_DATA );
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableQueryMaxKeyLength
\begin{FunctionDescription}{Util\_TableQueryMaxKeyLength}
\label{Util-TableQueryMaxKeyLength}
Query the maximum key length in a table
@@ -3682,10 +3710,10 @@ not in the ``null-pointer'' state.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -3693,31 +3721,31 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3754,6 +3782,7 @@ Util_TableSetComplex16(handle, z, "my complex number");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableSet*Array
\begin{FunctionDescription}{Util\_TableSet*Array}
\label{Util-TableSet*Array}
This is a family of functions, one for each Cactus data type,
@@ -3841,10 +3870,10 @@ data is still valid whenever that \verb|CCTK_POINTER| is used.)
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -3852,31 +3881,31 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -3912,6 +3941,7 @@ Util_TableSetIntArray(handle, N_DIGITS, pi_digits, "digits of pi");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableSetFromString
\begin{FunctionDescription}{Util\_TableSetFromString}
\label{Util-TableSetFromString}
Sets values in a table based on a string argument, which is interpreted
@@ -4007,10 +4037,10 @@ find out where the error was detected. :(
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -4018,30 +4048,30 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -4096,6 +4126,7 @@ Util_TableSetIntArray(handle, 3, array, "array");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableSetGeneric
\begin{FunctionDescription}{Util\_TableSetGeneric}
\label{Util-TableSetGeneric}
Set the value associated with a specified key to be a specified
@@ -4162,10 +4193,10 @@ not in the ``null-pointer'' state.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -4173,34 +4204,34 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -4249,6 +4280,7 @@ Util_TableGetReal(handle, &xcopy, "speed of light");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableSetGenericArray
\begin{FunctionDescription}{Util\_TableSetGenericArray}
\label{Util-TableSetGenericArray}
Set the value associated with a specified key to be a copy of a
@@ -4330,10 +4362,10 @@ data is still valid whenever that \verb|CCTK_POINTER| is used.)
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -4341,31 +4373,31 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetFromString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetFromString()} {Util-TableSetFromString}
convenience routine to set key/value entries in a table based on a
parameter-file--like character string
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetString()} {Util-TableSetString}
set a character-string value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}
@@ -4422,6 +4454,7 @@ Util_TableGetRealArray(handle, N_XARRAY, xarray2, "my real array");
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%Entering a function descrpition for Util\_TableSetString
\begin{FunctionDescription}{Util\_TableSetString}
\label{Util-TableSetString}
Sets the value associated with a specified key in a table, to be
@@ -4488,10 +4521,10 @@ not in the ``null-pointer'' state.
\end{Discussion}
\begin{SeeAlsoSection}
-\begin{SeeAlso}{Util\_TableCreateFromString()}
+\begin{SeeAlso2} {Util\_TableCreateFromString()} {Util-TableCreateFromString}
convenience routine to create a table and set key/value entries
in it based on a parameter-file--like character string
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableGet*()}
get a single (1-element array) value,
or more generally the first array element of an array value
@@ -4499,33 +4532,33 @@ or more generally the first array element of an array value
\begin{SeeAlso}{Util\_TableGet*Array()}
get an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGeneric()}
+\begin{SeeAlso2} {Util\_TableGetGeneric()} {Util-TableGetGeneric}
get a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetGenericArray()} {Util-TableGetGenericArray}
get an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableGetString()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableGetString()} {Util-TableGetString}
get a character-string value
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetCharArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetCharArray()} {Util-TableSetCharArray}
get an array-of-\code{CCTK\_CHAR} value
-\end{SeeAlso}
+\end{SeeAlso2}
\begin{SeeAlso}{Util\_TableSet*()}
set a single (1-element array) value
\end{SeeAlso}
\begin{SeeAlso}{Util\_TableSet*Array()}
set an array value
\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGeneric()}
+\begin{SeeAlso2} {Util\_TableSetGeneric()} {Util-TableSetGeneric}
set a single (1-element array) value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetGenericArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetGenericArray()} {Util-TableSetGenericArray}
set an array value with generic data type
-\end{SeeAlso}
-\begin{SeeAlso}{Util\_TableSetCharArray()}
+\end{SeeAlso2}
+\begin{SeeAlso2} {Util\_TableSetCharArray()} {Util-TableSetCharArray}
set an array-of-\code{CCTK\_CHAR} value
-\end{SeeAlso}
+\end{SeeAlso2}
\end{SeeAlsoSection}
\begin{ErrorSection}