summaryrefslogtreecommitdiff
path: root/doc/ReferenceManual
diff options
context:
space:
mode:
authorschnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac>2003-07-22 09:55:31 +0000
committerschnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac>2003-07-22 09:55:31 +0000
commitb6b5263d6a04e017d18f526797db7700a10bc326 (patch)
treeb8a8b90320c575ee7795dc0d74b4f6d1e280de20 /doc/ReferenceManual
parent3894ba2549a7650fee7008640a4675f8d171e798 (diff)
Nicer line breaks in the latex source of the function reference table
of contents. git-svn-id: http://svn.cactuscode.org/flesh/trunk@3340 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc/ReferenceManual')
-rw-r--r--doc/ReferenceManual/CCTKReference.tex442
1 files changed, 182 insertions, 260 deletions
diff --git a/doc/ReferenceManual/CCTKReference.tex b/doc/ReferenceManual/CCTKReference.tex
index bd9de2b9..9fca5412 100644
--- a/doc/ReferenceManual/CCTKReference.tex
+++ b/doc/ReferenceManual/CCTKReference.tex
@@ -38,335 +38,304 @@ from Fortran.
\begin{Lentry}
-\item[CCTK\_Abort]
- [\pageref{CCTK-Abort}]
+\item[CCTK\_Abort] [\pageref{CCTK-Abort}]
Causes abnormal Cactus termination
-\item[CCTK\_ActiveTimeLevels]
- [\pageref{CCTK-ActiveTimeLevels}]
+\item[CCTK\_ActiveTimeLevels] [\pageref{CCTK-ActiveTimeLevels}]
Returns the number of active timelevels from a group name
-\item[CCTK\_ActiveTimeLevelsGI]
- [\pageref{CCTK-ActiveTimeLevels}]
+\item[CCTK\_ActiveTimeLevelsGI] [\pageref{CCTK-ActiveTimeLevels}]
Returns the number of active timelevels from a group index
-\item[CCTK\_ActiveTimeLevelsGN]
- [\pageref{CCTK-ActiveTimeLevels}]
+\item[CCTK\_ActiveTimeLevelsGN] [\pageref{CCTK-ActiveTimeLevels}]
Returns the number of active timelevels from a group name
-\item[CCTK\_ActiveTimeLevelsVI]
- [\pageref{CCTK-ActiveTimeLevels}]
+\item[CCTK\_ActiveTimeLevelsVI] [\pageref{CCTK-ActiveTimeLevels}]
Returns the number of active timelevels from a variable index
-\item[CCTK\_ActiveTimeLevelsVN]
- [\pageref{CCTK-ActiveTimeLevels}]
+\item[CCTK\_ActiveTimeLevelsVN] [\pageref{CCTK-ActiveTimeLevels}]
Returns the number of active timelevels from a variable name
-\item[CCTK\_ArrayGroupSize]
- [\pageref{CCTK-ArrayGroupSize}]
+\item[CCTK\_ArrayGroupSize] [\pageref{CCTK-ArrayGroupSize}]
Returns a pointer to the local size for a group, given by its group name
-\item[CCTK\_ArrayGroupSizeI]
- [\pageref{CCTK-ArrayGroupSizeI}]
+\item[CCTK\_ArrayGroupSizeI] [\pageref{CCTK-ArrayGroupSizeI}]
Returns a pointer to the local size for a group, given by its group index
-\item[CCTK\_Barrier]
- [\pageref{CCTK-Barrier}]
+\item[CCTK\_Barrier] [\pageref{CCTK-Barrier}]
Synchronizes all processors
-\item[CCTK\_Cmplx]
- [\pageref{CCTK-Cmplx}]
+\item[CCTK\_Cmplx] [\pageref{CCTK-Cmplx}]
Turns two real numbers into a complex number (only C)
-\item[CCTK\_CmplxAbs]
- [\pageref{CCTK-CmplxAbs}]
+\item[CCTK\_CmplxAbs] [\pageref{CCTK-CmplxAbs}]
Returns the absolute value of a complex number (only C)
-\item[CCTK\_CmplxAdd]
- [\pageref{CCTK-CmplxAdd}]
+\item[CCTK\_CmplxAdd] [\pageref{CCTK-CmplxAdd}]
Returns the sum of two complex numbers (only C)
-\item[CCTK\_CmplxConjg]
- [\pageref{CCTK-CmplxConjg}]
+\item[CCTK\_CmplxConjg] [\pageref{CCTK-CmplxConjg}]
Returns the complex conjugate of a complex number (only C)
-\item[CCTK\_CmplxCos]
- [\pageref{CCTK-CmplxCos}]
+\item[CCTK\_CmplxCos] [\pageref{CCTK-CmplxCos}]
Returns the Cosine of a complex number (only C) [not yet available]
-\item[CCTK\_CmplxDiv]
- [\pageref{CCTK-CmplxDiv}]
+\item[CCTK\_CmplxDiv] [\pageref{CCTK-CmplxDiv}]
Returns the division of two complex numbers (only C)
-\item[CCTK\_CmplxExp]
- [\pageref{CCTK-CmplxExp}]
+\item[CCTK\_CmplxExp] [\pageref{CCTK-CmplxExp}]
Returns the Exponentiation of a complex number (only C) [not yet available]
-\item[CCTK\_CmplxImag]
- [\pageref{CCTK-CmplxImag}]
+\item[CCTK\_CmplxImag] [\pageref{CCTK-CmplxImag}]
Returns the imaginary part of a complex number (only C)
-\item[CCTK\_CmplxLog]
- [\pageref{CCTK-CmplxLog}]
+\item[CCTK\_CmplxLog] [\pageref{CCTK-CmplxLog}]
Returns the Logarithm of a complex number (only C) [not yet available]
-\item[CCTK\_CmplxMul]
- [\pageref{CCTK-CmplxMul}]
+\item[CCTK\_CmplxMul] [\pageref{CCTK-CmplxMul}]
Returns the multiplication of two complex numbers (only C)
-\item[CCTK\_CmplxReal]
- [\pageref{CCTK-CmplxReal}]
+\item[CCTK\_CmplxReal] [\pageref{CCTK-CmplxReal}]
Returns the real part of a complex number (only C)
-\item[CCTK\_CmplxSin]
- [\pageref{CCTK-CmplxSin}]
+\item[CCTK\_CmplxSin] [\pageref{CCTK-CmplxSin}]
Returns the Sine of a complex number (only C) [not yet available]
-\item[CCTK\_CmplxSqrt]
- [\pageref{CCTK-CmplxSqrt}]
+\item[CCTK\_CmplxSqrt] [\pageref{CCTK-CmplxSqrt}]
Returns the square root of a complex number (only C) [not yet available]
-\item[CCTK\_CmplxSub]
- [\pageref{CCTK-CmplxSub}]
+\item[CCTK\_CmplxSub] [\pageref{CCTK-CmplxSub}]
Returns the subtraction of two complex numbers (only C)
-\item[CCTK\_CoordDir]
- [\pageref{CCTK-CoordDir}]
+\item[CCTK\_CoordDir] [\pageref{CCTK-CoordDir}]
Give the direction for a given coordinate name.
-\item[CCTK\_CoordIndex]
- [\pageref{CCTK-CoordIndex}]
+\item[CCTK\_CoordIndex] [\pageref{CCTK-CoordIndex}]
Give the grid variable index for a given coordinate.
-\item[CCTK\_CoordRange]
- [\pageref{CCTK-CoordRange}]
- Return the global upper and lower bounds for a given coordinate name on a cctkGH
+\item[CCTK\_CoordRange] [\pageref{CCTK-CoordRange}]
+ Return the global upper and lower bounds for a given coordinate name
+ on a cctkGH
-\item[CCTK\_CoordRegisterData]
- [\pageref{CCTK-CoordRegisterData}]
- Register a coordinate as belonging to a coordinate system, with a given name and direction, and
- optionally with a grid variable
+\item[CCTK\_CoordRegisterData] [\pageref{CCTK-CoordRegisterData}]
+ Register a coordinate as belonging to a coordinate system,
+ with a given name and direction, and optionally with a grid variable
-\item[CCTK\_CoordRegisterRange]
- [\pageref{CCTK-CoordRegisterRange}]
- Saves the global upper and lower bounds for a given coordinate name on a cctkGH
+\item[CCTK\_CoordRegisterRange] [\pageref{CCTK-CoordRegisterRange}]
+ Saves the global upper and lower bounds for a given coordinate name
+ on a cctkGH
-\item[CCTK\_CoordRegisterSystem]
- [\pageref{CCTK-CoordRegisterSystem}]
+\item[CCTK\_CoordRegisterSystem] [\pageref{CCTK-CoordRegisterSystem}]
Registers a coordinate system with a given dimension
-\item[CCTK\_CoordSystemDim]
- [\pageref{CCTK-CoordDim}]
+\item[CCTK\_CoordSystemDim] [\pageref{CCTK-CoordDim}]
Provides the dimension of a given coordinate system
-\item[CCTK\_CoordSystemHandle]
- [\pageref{CCTK-CoordSystemHandle}]
+\item[CCTK\_CoordSystemHandle] [\pageref{CCTK-CoordSystemHandle}]
Get the handle associated with a registered coordinate system
-\item[CCTK\_CoordSystemName]
- [\pageref{CCTK-CoordSystemName}]
+\item[CCTK\_CoordSystemName] [\pageref{CCTK-CoordSystemName}]
Provides the name of the coordinate system identified by its handle
-\item[CCTK\_CreateDirectory]
- [\pageref{CCTK-CreateDirectory}]
+\item[CCTK\_CreateDirectory] [\pageref{CCTK-CreateDirectory}]
Creates a directory
-\item[CCTK\_DecomposeName]
- [\pageref{CCTK-DecomposeName}]
- Given the full name of a variable/group, separates the name returning both the implementation and the variable/group
+\item[CCTK\_DecomposeName] [\pageref{CCTK-DecomposeName}]
+ Given the full name of a variable/group, separates the name
+ returning both the implementation and the variable/group
-\item[CCTK\_DisableGroupComm]
- [\pageref{CCTK-DisableGroupComm}]
+\item[CCTK\_DisableGroupComm] [\pageref{CCTK-DisableGroupComm}]
Disable the communication for a group
-\item[CCTK\_DisableGroupCommI]
- [\pageref{CCTK-DisableGroupCommI}]
+\item[CCTK\_DisableGroupCommI] [\pageref{CCTK-DisableGroupCommI}]
Disable the communication for a group
-\item[CCTK\_DisableGroupStorage]
- [\pageref{CCTK-DisableGroupStorage}]
+\item[CCTK\_DisableGroupStorage] [\pageref{CCTK-DisableGroupStorage}]
Disable the storage for a group
-\item[CCTK\_DisableGroupStorageI]
- [\pageref{CCTK-DisableGroupStorageI}]
+\item[CCTK\_DisableGroupStorageI] [\pageref{CCTK-DisableGroupStorageI}]
Disable the storage for a group
-\item[CCTK\_EnableGroupComm]
- [\pageref{CCTK-EnableGroupComm}]
+\item[CCTK\_EnableGroupComm] [\pageref{CCTK-EnableGroupComm}]
Enable the communication for a group
-\item[CCTK\_EnableGroupCommI]
- [\pageref{CCTK-EnableGroupComm}]
+\item[CCTK\_EnableGroupCommI] [\pageref{CCTK-EnableGroupComm}]
Enable the communication for a group
-\item[CCTK\_EnableGroupStorage]
- [\pageref{CCTK-EnableGroupStorage}]
+\item[CCTK\_EnableGroupStorage] [\pageref{CCTK-EnableGroupStorage}]
Enable the storage for a group
-\item[CCTK\_EnableGroupStorageI]
- [\pageref{CCTK-EnableGroupStorage}]
+\item[CCTK\_EnableGroupStorageI] [\pageref{CCTK-EnableGroupStorage}]
Enable the storage for a group
-\item[CCTK\_Equals]
- [\pageref{CCTK-Equals}]
- Check a STRING or KEYWORD parameter for equality equality with a given string
+\item[CCTK\_Equals] [\pageref{CCTK-Equals}]
+ Check a STRING or KEYWORD parameter for equality equality
+ with a given string
-\item[CCTK\_Exit]
- [\pageref{CCTK-Exit}]
+\item[CCTK\_Exit] [\pageref{CCTK-Exit}]
Causes normal Cactus termination
-\item[CCTK\_FirstVarIndex]
- [\pageref{CCTK-FirstVarIndex}]
+\item[CCTK\_FirstVarIndex] [\pageref{CCTK-FirstVarIndex}]
Given a group name returns the first variable index in the group
-\item[CCTK\_FirstVarIndexI]
- [\pageref{CCTK-FirstVarIndexI}]
+\item[CCTK\_FirstVarIndexI] [\pageref{CCTK-FirstVarIndexI}]
Given a group index returns the first variable index in the group
-\item[CCTK\_FortranString]
- [\pageref{CCTK-FortranString}]
+\item[CCTK\_FortranString] [\pageref{CCTK-FortranString}]
Changes a C string into a Fortran string
-\item[CCTK\_FullName]
- [\pageref{CCTK-FullName}]
+\item[CCTK\_FullName] [\pageref{CCTK-FullName}]
Given a variable index, returns the full name of the variable
-\item[CCTK\_GHExtension]
- [\pageref{CCTK-GHExtension}]
+\item[CCTK\_GHExtension] [\pageref{CCTK-GHExtension}]
Get the pointer to a registered extension to the Cactus GH structure
-\item[CCTK\_GHExtensionHandle]
- [\pageref{CCTK-GHExtensionHandle}]
+\item[CCTK\_GHExtensionHandle] [\pageref{CCTK-GHExtensionHandle}]
Get the handle associated with a extension to the Cactus GH structure
\item[CCTK\_GroupbboxGI] [\pageref{CCTK-GroupbboxGI}]
- Given a group index, return an array of the bounding box of the group for each face
+ Given a group index, return an array of the bounding box
+ of the group for each face
\item[CCTK\_GroupbboxGN] [\pageref{CCTK-GroupbboxGN}]
- Given a group name, return an array of the bounding box of the group for each face
+ Given a group name, return an array of the bounding box
+ of the group for each face
\item[CCTK\_GroupbboxVI] [\pageref{CCTK-GroupbboxVI}]
- Given a variable index, return an array of the bounding box of the variable for each face
+ Given a variable index, return an array of the bounding box
+ of the variable for each face
\item[CCTK\_GroupbboxVN] [\pageref{CCTK-GroupbboxVN}]
- Given a variable name, return an array of the bounding box of the variable for each face
+ Given a variable name, return an array of the bounding box
+ of the variable for each face
-\item[CCTK\_GroupData]
- [\pageref{CCTK-GroupData}]
- Given a group index, returns information about the variables held in the group
+\item[CCTK\_GroupData] [\pageref{CCTK-GroupData}]
+ Given a group index, returns information about the variables
+ held in the group
-\item[CCTK\_GroupDynamicData]
- [\pageref{CCTK-GroupDynamicData}]
- Given a group index, returns information about the variables held in the group
+\item[CCTK\_GroupDynamicData] [\pageref{CCTK-GroupDynamicData}]
+ Given a group index, returns information about the variables
+ held in the group
\item[CCTK\_GroupgshGI] [\pageref{CCTK-GroupgshGI}]
- Given a group index, return an array of the global size of the group in each dimension
+ Given a group index, return an array of the global size
+ of the group in each dimension
\item[CCTK\_GroupgshGN] [\pageref{CCTK-GroupgshGN}]
- Given a group name, return an array of the global size of the group in each dimension
+ Given a group name, return an array of the global size
+ of the group in each dimension
\item[CCTK\_GroupgshVI] [\pageref{CCTK-GroupgshVI}]
- Given a variable index, return an array of the global size of the variable in each dimension
+ Given a variable index, return an array of the global size
+ of the variable in each dimension
\item[CCTK\_GroupgshVN] [\pageref{CCTK-GroupgshVN}]
- Given a variable name, return an array of the global size of the variable in each dimension
+ Given a variable name, return an array of the global size
+ of the variable in each dimension
-\item[CCTK\_GroupIndex]
- [\pageref{CCTK-GroupIndex}]
+\item[CCTK\_GroupIndex] [\pageref{CCTK-GroupIndex}]
Get the index number for a group name
-\item[CCTK\_GroupIndexFromVar]
- [\pageref{CCTK-GroupIndexFromVar}]
+\item[CCTK\_GroupIndexFromVar] [\pageref{CCTK-GroupIndexFromVar}]
Given a variable name, returns the index of the associated group
-\item[CCTK\_GroupIndexFromVarI]
- [\pageref{CCTK-GroupIndexFromVarI}]
+\item[CCTK\_GroupIndexFromVarI] [\pageref{CCTK-GroupIndexFromVarI}]
Given a variable index, returns the index of the associated group
\item[CCTK\_GrouplbndGI] [\pageref{CCTK-GrouplbndGI}]
- Given a group index, return an array of the lower bounds of the group in each dimension
+ Given a group index, return an array of the lower bounds
+ of the group in each dimension
\item[CCTK\_GrouplbndGN] [\pageref{CCTK-GrouplbndGN}]
- Given a group name, return an array of the lower bounds of the group in each dimension
+ Given a group name, return an array of the lower bounds
+ of the group in each dimension
\item[CCTK\_GrouplbndVI] [\pageref{CCTK-GrouplbndVI}]
- Given a variable index, return an array of the lower bounds of the variable in each dimension
+ Given a variable index, return an array of the lower bounds
+ of the variable in each dimension
\item[CCTK\_GrouplbndVN] [\pageref{CCTK-GrouplbndVN}]
- Given a variable name, return an array of the lower bounds of the variable in each dimension
+ Given a variable name, return an array of the lower bounds
+ of the variable in each dimension
\item[CCTK\_GrouplshGI] [\pageref{CCTK-GrouplshGI}]
- Given a group index, return an array of the local size of the group in each dimension
+ Given a group index, return an array of the local size
+ of the group in each dimension
\item[CCTK\_GrouplshGN] [\pageref{CCTK-GrouplshGN}]
- Given a group name, return an array of the local size of the group in each dimension
+ Given a group name, return an array of the local size
+ of the group in each dimension
\item[CCTK\_GrouplshVI] [\pageref{CCTK-GrouplshVI}]
- Given a variable index, return an array of the local size of the variable in each dimension
+ Given a variable index, return an array of the local size
+ of the variable in each dimension
\item[CCTK\_GrouplshVN] [\pageref{CCTK-GrouplshVN}]
- Given a variable name, return an array of the local size of the variable in each dimension
+ Given a variable name, return an array of the local size
+ of the variable in each dimension
-\item[CCTK\_GroupName]
- [\pageref{CCTK-GroupName}]
+\item[CCTK\_GroupName] [\pageref{CCTK-GroupName}]
Given a group index, returns the group name
-\item[CCTK\_GroupNameFromVarI]
- [\pageref{CCTK-GroupNameFromVarI}]
+\item[CCTK\_GroupNameFromVarI] [\pageref{CCTK-GroupNameFromVarI}]
Given a variable index, return the name of the associated group
\item[CCTK\_GroupnghostzonesGI] [\pageref{CCTK-GroupnghostzonesGI}]
- Given a group index, return an array with the number of ghostzones in each dimension of the group
+ Given a group index, return an array with the number of ghostzones
+ in each dimension of the group
\item[CCTK\_GroupnghostzonesGN] [\pageref{CCTK-GroupnghostzonesGN}]
- Given a group name, return an array with the number of ghostzones in each dimension of the group
+ Given a group name, return an array with the number of ghostzones
+ in each dimension of the group
-\item[CCTK\_GroupTypeFromVarI]
- [\pageref{CCTK-GroupTypeFromVarI}]
+\item[CCTK\_GroupStorageDecrease] [\pageref{CCTK-GroupStorageDecrease}]
+ Decrease the active number of timelevels for a list of groups
+
+\item[CCTK\_GroupStorageIncrease] [\pageref{CCTK-GroupStorageIncrease}]
+ Increase the active number of timelevels for a list of groups
+
+\item[CCTK\_GroupTypeFromVarI] [\pageref{CCTK-GroupTypeFromVarI}]
Provides a group's group type index given a variable index
-\item[CCTK\_GroupTypeI]
- [\pageref{CCTK-GroupTypeI}]
+\item[CCTK\_GroupTypeI] [\pageref{CCTK-GroupTypeI}]
Provides a group's group type index given a group index
\item[CCTK\_GroupubndGI] [\pageref{CCTK-GroupubndGI}]
- Given a group index, return an array of the upper bounds of the group in each dimension
+ Given a group index, return an array of the upper bounds
+ of the group in each dimension
\item[CCTK\_GroupubndGN] [\pageref{CCTK-GroupubndGN}]
- Given a group name, return an array of the upper bounds of the group in each dimension
+ Given a group name, return an array of the upper bounds
+ of the group in each dimension
\item[CCTK\_GroupubndVI] [\pageref{CCTK-GroupubndVI}]
- Given a variable index, return an array of the upper bounds of the variable in each dimension
+ Given a variable index, return an array of the upper bounds
+ of the variable in each dimension
\item[CCTK\_GroupubndVN] [\pageref{CCTK-GroupubndVN}]
- Given a variable name, return an array of the upper bounds of the variable in each dimension
+ Given a variable name, return an array of the upper bounds
+ of the variable in each dimension
-\item[CCTK\_ImpFromVarI]
- [\pageref{CCTK-ImpFromVarI}]
+\item[CCTK\_ImpFromVarI] [\pageref{CCTK-ImpFromVarI}]
Given a variable index, returns the implementation name
-\item[CCTK\_INFO]
- [\pageref{CCTK-INFO}]
+\item[CCTK\_INFO] [\pageref{CCTK-INFO}]
Macro to print a single string as an information message to screen
-\item[CCTK\_InterpGridArrays]
- [\pageref{CCTK-InterpGridArrays}]
+\item[CCTK\_InterpGridArrays] [\pageref{CCTK-InterpGridArrays}]
Performs an interpolation on a list of CCTK grid arrays,
using a chosen external local interpolation operator
-\item[CCTK\_InterpGV]
- [\pageref{CCTK-InterpGV}]
+\item[CCTK\_InterpGV] [\pageref{CCTK-InterpGV}]
Performs an interpolation on a list of CCTK grid arrays,
using a chosen build-in local interpolation operator
(this function is being phased out;
it will eventually be replaced by \verb|CCTK_InterpGridArrays()|)
-\item[CCTK\_InterpHandle]
- [\pageref{CCTK-InterpHandle}]
+\item[CCTK\_InterpHandle] [\pageref{CCTK-InterpHandle}]
Returns the handle for a given interpolation operator
-\item[CCTK\_InterpLocal]
- [\pageref{CCTK-InterpLocal}]
+\item[CCTK\_InterpLocal] [\pageref{CCTK-InterpLocal}]
Performs an interpolation on a list of processor-local arrays,
using a chosen interpolation operator
(this function is being phased out; it will
@@ -378,8 +347,7 @@ from Fortran.
%notyet Interpolate a list of processor-local arrays
%notyet which define a nonuniformly spaced data grid (not implemented yet)
-\item[CCTK\_InterpLocalUniform]
- [\pageref{CCTK-InterpLocalUniform}]
+\item[CCTK\_InterpLocalUniform] [\pageref{CCTK-InterpLocalUniform}]
Interpolate a list of processor-local arrays
which define a uniformly-spaced data grid
@@ -421,144 +389,110 @@ from Fortran.
[\pageref{CCTK-IsImplementationCompiled}]
Reports whether an implementation was compiled into a configuration
-\item[CCTK\_IsThornActive]
- [\pageref{CCTK-IsThornActive}]
+\item[CCTK\_IsThornActive] [\pageref{CCTK-IsThornActive}]
Reports whether a thorn was activated in a parameter file
-\item[CCTK\_IsThornCompiled]
- [\pageref{CCTK-IsThornActive}]
+\item[CCTK\_IsThornCompiled] [\pageref{CCTK-IsThornActive}]
Reports whether a thorn was activated in a parameter file
-\item[CCTK\_MaxDim]
- [\pageref{CCTK-MaxDim}]
+\item[CCTK\_MaxDim] [\pageref{CCTK-MaxDim}]
Get the maximum dimension of any grid variable
-\item[CCTK\_MaxTimeLevels]
- [\pageref{CCTK-MaxTimeLevels}]
+\item[CCTK\_MaxTimeLevels] [\pageref{CCTK-MaxTimeLevels}]
Gives the maximum number of timelevels for a group
-\item[CCTK\_MaxTimeLevelsGI]
- [\pageref{CCTK-MaxTimeLevelsGI}]
+\item[CCTK\_MaxTimeLevelsGI] [\pageref{CCTK-MaxTimeLevelsGI}]
Gives the maximum number of timelevels for a group
-\item[CCTK\_MaxTimeLevelsGN]
- [\pageref{CCTK-MaxTimeLevelsGN}]
+\item[CCTK\_MaxTimeLevelsGN] [\pageref{CCTK-MaxTimeLevelsGN}]
Gives the maximum number of timelevels for a group
-\item[CCTK\_MaxTimeLevelsVI]
- [\pageref{CCTK-MaxTimeLevelsVarI}]
+\item[CCTK\_MaxTimeLevelsVI] [\pageref{CCTK-MaxTimeLevelsVarI}]
Gives the maximum number of timelevels for a variable
-\item[CCTK\_MaxTimeLevelsVN]
- [\pageref{CCTK-MaxTimeLevelsVN}]
+\item[CCTK\_MaxTimeLevelsVN] [\pageref{CCTK-MaxTimeLevelsVN}]
Gives the maximum number of timelevels for a variable
-\item[CCTK\_MyProc]
- [\pageref{CCTK-MyProc}]
+\item[CCTK\_MyProc] [\pageref{CCTK-MyProc}]
Get the local processor number
-\item[CCTK\_nProcs]
- [\pageref{CCTK-nProcs}]
+\item[CCTK\_nProcs] [\pageref{CCTK-nProcs}]
Get the total number of processors used
-\item[CCTK\_NullPointer]
- [\pageref{CCTK-NullPointer}]
+\item[CCTK\_NullPointer] [\pageref{CCTK-NullPointer}]
Returns a C-style NULL pointer value
-\item[CCTK\_NumGroups]
- [\pageref{CCTK-NumGroups}]
+\item[CCTK\_NumGroups] [\pageref{CCTK-NumGroups}]
Get the number of groups of variables compiled in the code
-\item[CCTK\_NumIOMethods]
- [\pageref{CCTK-NumIOMethods}]
+\item[CCTK\_NumIOMethods] [\pageref{CCTK-NumIOMethods}]
Returns the total number of I/O methods registered with the flesh
-\item[CCTK\_NumTimeLevels]
- [\pageref{CCTK-NumTimeLevels}]
+\item[CCTK\_NumTimeLevels] [\pageref{CCTK-NumTimeLevels}]
Returns the number of active timelevels from a group name (deprecated)
-\item[CCTK\_NumTimeLevelsGI]
- [\pageref{CCTK-NumTimeLevels}]
+\item[CCTK\_NumTimeLevelsGI] [\pageref{CCTK-NumTimeLevels}]
Returns the number of active timelevels from a group index (deprecated)
-\item[CCTK\_NumTimeLevelsGN]
- [\pageref{CCTK-NumTimeLevels}]
+\item[CCTK\_NumTimeLevelsGN] [\pageref{CCTK-NumTimeLevels}]
Returns the number of active timelevels from a group name (deprecated)
-\item[CCTK\_NumTimeLevelsVI]
- [\pageref{CCTK-NumTimeLevels}]
+\item[CCTK\_NumTimeLevelsVI] [\pageref{CCTK-NumTimeLevels}]
Returns the number of active timelevels from a variable index (deprecated)
-\item[CCTK\_NumTimeLevelsVN]
- [\pageref{CCTK-NumTimeLevels}]
+\item[CCTK\_NumTimeLevelsVN] [\pageref{CCTK-NumTimeLevels}]
Returns the number of active timelevels from a variable name (deprecated)
-\item[CCTK\_NumVars]
- [\pageref{CCTK-NumVars}]
+\item[CCTK\_NumVars] [\pageref{CCTK-NumVars}]
Get the number of grid variables compiled in the code
-\item[CCTK\_NumVarsInGroup]
- [\pageref{CCTK-NumVarsInGroup}]
+\item[CCTK\_NumVarsInGroup] [\pageref{CCTK-NumVarsInGroup}]
Provides the number of variables in a group from the group name
-\item[CCTK\_NumVarsInGroupI]
- [\pageref{CCTK-NumVarsInGroupI}]
+\item[CCTK\_NumVarsInGroupI] [\pageref{CCTK-NumVarsInGroupI}]
Provides the number of variables in a group from the group index
-\item[CCTK\_OutputGH]
- [\pageref{CCTK-OutputGH}]
+\item[CCTK\_OutputGH] [\pageref{CCTK-OutputGH}]
Conditional output of all variables on a GH by all I/O methods
-\item[CCTK\_OutputVar]
- [\pageref{CCTK-OutputVar}]
+\item[CCTK\_OutputVar] [\pageref{CCTK-OutputVar}]
Output of a single variable by all I/O methods
-\item[CCTK\_OutputVarAs]
- [\pageref{CCTK-OutputVarAs}]
+\item[CCTK\_OutputVarAs] [\pageref{CCTK-OutputVarAs}]
Output of a single variable as an alias by all I/O methods
-\item[CCTK\_OutputVarAsByMethod]
- [\pageref{CCTK-OutputVarAsByMethod}]
+\item[CCTK\_OutputVarAsByMethod] [\pageref{CCTK-OutputVarAsByMethod}]
Output of a single variable as an alias by a single I/O method
-\item[CCTK\_OutputVarByMethod]
- [\pageref{CCTK-OutputVarByMethod}]
+\item[CCTK\_OutputVarByMethod] [\pageref{CCTK-OutputVarByMethod}]
Output of a single variable by a single I/O method
-\item[CCTK\_ParallelInit]
- [\pageref{CCTK-ParallelInit}]
+\item[CCTK\_ParallelInit] [\pageref{CCTK-ParallelInit}]
Initializes the parallel subsystem
-\item[CCTK\_PARAMWARN]
- [\pageref{CCTK-PARAMWARN}]
+\item[CCTK\_PARAMWARN] [\pageref{CCTK-PARAMWARN}]
Prints a warning from parameter checking, and possibly stops the code
-\item[CCTK\_PointerTo]
- [\pageref{CCTK-PointerTo}]
- Returns the address of a variable passed in by reference from a fortran routine
+\item[CCTK\_PointerTo] [\pageref{CCTK-PointerTo}]
+ Returns the address of a variable passed in by reference
+ from a fortran routine
-\item[CCTK\_PrintGroup]
- [\pageref{CCTK-PrintGroup}]
+\item[CCTK\_PrintGroup] [\pageref{CCTK-PrintGroup}]
Prints a group name from its index
-\item[CCTK\_PrintString]
- [\pageref{CCTK-PrintString}]
+\item[CCTK\_PrintString] [\pageref{CCTK-PrintString}]
Prints a Cactus string to screen (from Fortran)
-\item[CCTK\_PrintVar]
- [\pageref{CCTK-PrintVar}]
+\item[CCTK\_PrintVar] [\pageref{CCTK-PrintVar}]
Prints a variable name from its index
-\item[CCTK\_QueryGroupStorage]
- [\pageref{CCTK-QueryGroupStorage}]
+\item[CCTK\_QueryGroupStorage] [\pageref{CCTK-QueryGroupStorage}]
Queries storage for a group given by its group name
-\item[CCTK\_QueryGroupStorageB]
- [\pageref{CCTK-QueryGroupStorageB}]
+\item[CCTK\_QueryGroupStorageB] [\pageref{CCTK-QueryGroupStorageB}]
-\item[CCTK\_QueryGroupStorageI]
- [\pageref{CCTK-QueryGroupStorageI}]
+\item[CCTK\_QueryGroupStorageI] [\pageref{CCTK-QueryGroupStorageI}]
Queries storage for a group given by its group index
@@ -566,12 +500,10 @@ from Fortran.
% [\pageref{CCTK-Reduce}]
% Perform a reduction operation using a registered operator
-\item[CCTK\_ReductionHandle]
- [\pageref{CCTK-ReductionHandle}]
+\item[CCTK\_ReductionHandle] [\pageref{CCTK-ReductionHandle}]
Get the handle for a registered reduction operator
-\item[CCTK\_RegisterBanner]
- [\pageref{CCTK-RegisterBanner}]
+\item[CCTK\_RegisterBanner] [\pageref{CCTK-RegisterBanner}]
Register a banner for a thorn
\item[CCTK\_RegisterGHExtension]
@@ -580,7 +512,8 @@ from Fortran.
\item[CCTK\_RegisterGHExtensionInitGH]
[\pageref{CCTK-RegisterGHExtensionInitGH}]
- Register a routine for providing initialisation for an extension to the Cactus GH
+ Register a routine for providing initialisation for an extension to
+ the Cactus GH
\item[CCTK\_RegisterGHExtensionScheduleTraverseGH]
[\pageref{CCTK-RegisterGHExtensionScheduleTraverseGH}]
@@ -615,55 +548,44 @@ from Fortran.
Register a function as providing a reduction operation
-\item[CCTK\_SetupGH]
- [\pageref{CCTK-SetupGH}]
+\item[CCTK\_SetupGH] [\pageref{CCTK-SetupGH}]
Sets up a CCTK grid hierarchy
-\item[CCTK\_SyncGroup]
- [\pageref{CCTK-SyncGroup}]
+\item[CCTK\_SyncGroup] [\pageref{CCTK-SyncGroup}]
Synchronize the ghost zones for a group of variables
-\item[CCTK\_VarDataPtr]
- [\pageref{CCTK-VarDataPtr}]
+\item[CCTK\_VarDataPtr] [\pageref{CCTK-VarDataPtr}]
Returns the data pointer for a grid variable
-\item[CCTK\_VarDataPtrB]
- [\pageref{CCTK-VarDataPtrB}]
+\item[CCTK\_VarDataPtrB] [\pageref{CCTK-VarDataPtrB}]
Returns the data pointer for a grid variable from the variable index or name
-\item[CCTK\_VarDataPtrI]
- [\pageref{CCTK-VarDataPtrI}]
+\item[CCTK\_VarDataPtrI] [\pageref{CCTK-VarDataPtrI}]
Returns the data pointer for a grid variable from the variable index
\item[CCTK\_VarIndex]
[\pageref{CCTK-VarIndex}]
Get the index for a variable
-\item[CCTK\_VarName]
- [\pageref{CCTK-VarName}]
+\item[CCTK\_VarName] [\pageref{CCTK-VarName}]
Given a variable index, returns the variable name
-\item[CCTK\_VarTypeI]
- [\pageref{CCTK-VarTypeI}]
+\item[CCTK\_VarTypeI] [\pageref{CCTK-VarTypeI}]
Provides variable type index from the variable index
-\item[CCTK\_VarTypeSize]
- [\pageref{CCTK-VarTypeSize}]
+\item[CCTK\_VarTypeSize] [\pageref{CCTK-VarTypeSize}]
Provides variable type size in bytes from the variable type index
-\item[CCTK\_VInfo]
- [\pageref{CCTK-VInfo}]
+\item[CCTK\_VInfo] [\pageref{CCTK-VInfo}]
Prints a formatted string with a variable argument list as an information
message to screen
-\item[CCTK\_VWarn]
- [\pageref{CCTK-VWarn}]
+\item[CCTK\_VWarn] [\pageref{CCTK-VWarn}]
Prints a formatted string with a variable argument list as a warning message
to standard error and possibly stops the code
-\item[CCTK\_WARN]
- [\pageref{CCTK-WARN}]
+\item[CCTK\_WARN] [\pageref{CCTK-WARN}]
Macro to print a single string as a warning message to standard error and
possibly stop the code