diff options
Diffstat (limited to 'doc/ReferenceManual/CCTKReference.tex')
| -rw-r--r-- | doc/ReferenceManual/CCTKReference.tex | 112 |
1 files changed, 86 insertions, 26 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 |