Chapter A1
Functions Alphabetically

CCTK_Abort

[A42] Causes abnormal Cactus termination

CCTK_ActivatingThorn

[A47] Finds the thorn which activated a particular implementation

CCTK_ActiveTimeLevels

[A49] Returns the number of active timelevels from a group name

CCTK_ActiveTimeLevelsGI

[A49] Returns the number of active timelevels from a group index

CCTK_ActiveTimeLevelsGN

[A49] Returns the number of active timelevels from a group name

CCTK_ActiveTimeLevelsVI

[A49] Returns the number of active timelevels from a variable index

CCTK_ActiveTimeLevelsVN

[A49] Returns the number of active timelevels from a variable name

CCTK_ArrayGroupSize

[A52] Returns a pointer to the local size for a group, given by its group name

CCTK_ArrayGroupSizeI

[A54] Returns a pointer to the local size for a group, given by its group index

CCTK_Barrier

[A56] Synchronizes all processors

CCTK_ClockRegister

[A58] Registers a new named clock with the Flesh.

CCTK_Cmplx

[A59] Turns two real numbers into a complex number (only C)

CCTK_CmplxAbs

[A61] Returns the absolute value of a complex number (only C)

CCTK_CmplxAdd

[A63] Returns the sum of two complex numbers (only C)

CCTK_CmplxConjg

[A65] Returns the complex conjugate of a complex number (only C)

CCTK_CmplxCos

[A67] Returns the Cosine of a complex number (only C) [not yet available]

CCTK_CmplxDiv

[A69] Returns the division of two complex numbers (only C)

CCTK_CmplxExp

[A71] Returns the Exponentiation of a complex number (only C) [not yet available]

CCTK_CmplxImag

[A73] Returns the imaginary part of a complex number (only C)

CCTK_CmplxLog

[A75] Returns the Logarithm of a complex number (only C) [not yet available]

CCTK_CmplxMul

[A77] Returns the multiplication of two complex numbers (only C)

CCTK_CmplxReal

[A79] Returns the real part of a complex number (only C)

CCTK_CmplxSin

[A81] Returns the Sine of a complex number (only C) [not yet available]

CCTK_CmplxSqrt

[A83] Returns the square root of a complex number (only C) [not yet available]

CCTK_CmplxSub

[A85] Returns the subtraction of two complex numbers (only C)

CCTK_CompileDate

[A87] Returns a formatted string containing the date stamp when Cactus was compiled

CCTK_CompileDateTime

[A88] Returns a formatted string containing the datetime stamp when Cactus was compiled

CCTK_CompileTime

[A89] Returns a formatted string containing the time stamp when Cactus was compiled

CCTK_CompiledImplementation

[A90] Return the name of the compiled implementation with given index

CCTK_CompiledThorn

[A92] Return the name of the compiled thorn with given index

CCTK_CoordDir

[A94] Give the direction for a given coordinate name (deprecated)

CCTK_CoordIndex

[A98] Give the grid variable index for a given coordinate (deprecated)

CCTK_CoordRange

[A102] Return the global upper and lower bounds for a given coordinate name on a cctkGH (deprecated)

CCTK_CoordRegisterData

[A106] Register a coordinate as belonging to a coordinate system, with a given name and direction, and optionally with a grid variable (deprecated)

CCTK_CoordRegisterRange

[A110] Saves the global upper and lower bounds for a given coordinate name on a cctkGH (deprecated)

CCTK_CoordRegisterSystem

[A114] Registers a coordinate system with a given dimension (deprecated)

CCTK_CoordSystemDim

[A118] Provides the dimension of a given coordinate system (deprecated)

CCTK_CoordSystemHandle

[A122] Get the handle associated with a registered coordinate system (deprecated)

CCTK_CoordSystemName

[A126] Provides the name of the coordinate system identified by its handle (deprecated)

CCTK_CreateDirectory

[A128] Creates a directory

CCTK_DecomposeName

[A132] Given the full name of a variable/group, separates the name returning both the implementation and the variable/group

CCTK_DisableGroupComm

[A134] Disable the communication for a group

CCTK_DisableGroupCommI

[A135] Disable the communication for a group

CCTK_DisableGroupStorage

[A137] Disable the storage for a group

CCTK_DisableGroupStorageI

[A138] Disable the storage for a group

CCTK_EnableGroupComm

[A139] Enable the communication for a group

CCTK_EnableGroupCommI

[A141] Enable the communication for a group

CCTK_EnableGroupStorage

[A143] Enable the storage for a group

CCTK_EnableGroupStorageI

[A144] Enable the storage for a group

CCTK_Equals

[A145] Check a STRING or KEYWORD parameter for equality equality with a given string

CCTK_Exit

[A150] Causes normal Cactus termination

CCTK_FirstVarIndex

[A152] Given a group name returns the first variable index in the group

CCTK_FirstVarIndexI

[A155] Given a group index returns the first variable index in the group

CCTK_FortranString

[A158] Copy the contents of a C string into a Fortran string variable

CCTK_FullName

[A162] Given a variable index, returns the full name of the variable

CCTK_GetClockName

[A164] Given a pointer to a clock cTimerVal structure, returns the name of the clock.

CCTK_GetClockResolution

[A165] Given a pointer to a clock cTimerVal structure, returns the resolution of the clock.

CCTK_GetClockSeconds

[A166] Given a pointer to a clock cTimerVal structure, returns the elapsed time.

CCTK_GetClockValue

[A167] Given the name of a clock, returns a pointer to the corresponding cTimerVal structure within the cTimerData structure.

CCTK_GetClockValueI

[A168] Given the index of a clock, returns a pointer to the corresponding cTimerVal structure within the cTimerData structure.

CCTK_GHExtension

[A169] Get the pointer to a registered extension to the Cactus GH structure

CCTK_GHExtensionHandle

[A171] Get the handle associated with a extension to the Cactus GH structure

CCTK_GridArrayReductionOperator

[A175] The name of the implementation of a grid array reduction operator, or NULL if the handle is invalid

CCTK_GroupbboxGI

[A176] Given a group index, return an array of the bounding box of the group for each face

CCTK_GroupbboxGN

[A176] Given a group name, return an array of the bounding box of the group for each face

CCTK_GroupbboxVI

[A180] Given a variable index, return an array of the bounding box of the variable for each face

CCTK_GroupbboxVN

[A180] Given a variable name, return an array of the bounding box of the variable for each face

CCTK_GroupData

[A183] Given a group index, returns information about the variables held in the group

CCTK_GroupDimFromVarI

[A187] Given a variable index, returns the dimension of all variables in the group associated with this variable

CCTK_GroupDimI

[A189] Given a group index, returns the dimension of variables in that group

CCTK_GroupDynamicData

[A192] Given a group index, returns information about the variables held in the group

CCTK_GroupGhostsizesI

[A195] Given a group index, returns the ghost size array of that group

CCTK_GroupgshGI

[A196] Given a group index, return an array of the global size of the group in each dimension

CCTK_GroupgshGN

[A196] Given a group name, return an array of the global size of the group in each dimension

CCTK_GroupgshVI

[A200] Given a variable index, return an array of the global size of the variable in each dimension

CCTK_GroupgshVN

[A200] Given a variable name, return an array of the global size of the variable in each dimension

CCTK_GroupIndex

[A203] Get the index number for a group name

CCTK_GroupIndexFromVar

[A207] Given a variable name, returns the index of the associated group

CCTK_GroupIndexFromVarI

[A211] Given a variable index, returns the index of the associated group

CCTK_GrouplbndGI

[A215] Given a group index, return an array of the lower bounds of the group in each dimension

CCTK_GrouplbndGN

[A215] Given a group name, return an array of the lower bounds of the group in each dimension

CCTK_GrouplbndVI

[A218] Given a variable index, return an array of the lower bounds of the variable in each dimension

CCTK_GrouplbndVN

[A218] Given a variable name, return an array of the lower bounds of the variable in each dimension

CCTK_GrouplshGI

[A221] Given a group index, return an array of the local size of the group in each dimension

CCTK_GrouplshGN

[A221] Given a group name, return an array of the local size of the group in each dimension

CCTK_GrouplshVI

[A224] Given a variable index, return an array of the local size of the variable in each dimension

CCTK_GrouplshVN

[A224] Given a variable name, return an array of the local size of the variable in each dimension

CCTK_GroupName

[A227] Given a group index, returns the group name

CCTK_GroupNameFromVarI

[A229] Given a variable index, return the name of the associated group

CCTK_GroupnghostzonesGI

[A231] Given a group index, return an array with the number of ghostzones in each dimension of the group

CCTK_GroupnghostzonesGN

[A231] Given a group name, return an array with the number of ghostzones in each dimension of the group

CCTK_GroupnghostzonesVI

[A234] Given a variable index, return an array with the number of ghostzones in each dimension of the variable’s group

CCTK_GroupnghostzonesVN

[A234] Given a group variable, return an array with the number of ghostzones in each dimension of the variable’s group

CCTK_GroupSizesI

[A237] Given a group index, returns the size array of that group

CCTK_GroupStorageDecrease

[A238] Decrease the active number of timelevels for a list of groups

CCTK_GroupStorageIncrease

[A241] Increase the active number of timelevels for a list of groups

CCTK_GroupTagsTable

[A243] Given a group name, return the table handle of the group’s tags table.

CCTK_GroupTagsTableI

[A246] Given a group index, return the table handle of the group’s tags table.

CCTK_GroupTypeFromVarI

[A249] Provides a group’s group type index given a variable index

CCTK_GroupTypeI

[A253] Provides a group’s group type index given a group index

CCTK_GroupubndGI

[A254] Given a group index, return an array of the upper bounds of the group in each dimension

CCTK_GroupubndGN

[A254] Given a group name, return an array of the upper bounds of the group in each dimension

CCTK_GroupubndVI

[A258] Given a variable index, return an array of the upper bounds of the variable in each dimension

CCTK_GroupubndVN

[A258] Given a variable name, return an array of the upper bounds of the variable in each dimension

CCTK_ImpFromVarI

[A261] Given a variable index, returns the implementation name

CCTK_ImplementationRequires

[A263] Return the ancestors for an implementation

CCTK_ImplementationThorn

[A265] Returns the name of one thorn providing an implementation

CCTK_ImpThornList

[A267] Return the thorns for an implementation

CCTK_INFO

[A269] Macro to print a single string as an information message to screen

CCTK_InfoCallbackRegister

[A274] Register one or more routines for dealing with information messages in addition to printing them to screen

CCTK_InterpGridArrays

[A277] Performs an interpolation on a list of CCTK grid variables, using a chosen external local interpolation operator

CCTK_InterpHandle

[A286] Returns the handle for a given interpolation operator

CCTK_InterpLocalUniform

[A290] Interpolate a list of processor-local arrays which define a uniformly-spaced data grid

CCTK_InterpRegisterOpLocalUniform

[A297] Registers a routine as a CCTK_InterpLocalUniform interpolation operator

CCTK_IsFunctionAliased

[A300] Reports whether an aliased function has been provided

CCTK_IsImplementationActive

[A302] Reports whether an implementation was activated in a parameter file

CCTK_IsImplementationCompiled

[A304] Reports whether an implementation was compiled into a configuration

CCTK_IsThornActive

[A306] Reports whether a thorn was activated in a parameter file

CCTK_IsThornCompiled

[A308] Reports whether a thorn was compiled into a configuration

CCTK_LocalArrayReduceOperator

[A311] Returns the name of a registered reduction operator

CCTK_LocalArrayReduceOperatorImplementation

[A313] Provide the implementation which provides an local array reduction operator

CCTK_LocalArrayReductionHandle

[A315] Returns the handle of a given local array reduction operator

CCTK_MaxDim

[A317] Get the maximum dimension of any grid variable

CCTK_MaxGFDim

[A321] Get the maximum dimension of all grid functions

CCTK_MaxTimeLevels

[A325] Gives the maximum number of timelevels for a group

CCTK_MaxTimeLevelsGI

[A329] Gives the maximum number of timelevels for a group

CCTK_MaxTimeLevelsGN

[A333] Gives the maximum number of timelevels for a group

CCTK_MaxTimeLevelsVI

[A334] Gives the maximum number of timelevels for a variable

CCTK_MaxTimeLevelsVN

[A338] Gives the maximum number of timelevels for a variable

CCTK_MyProc

[A342] Get the local processor number

CCTK_nProcs

[A343] Get the total number of processors used

CCTK_NullPointer

[A345] Returns a C-style NULL pointer value

CCTK_NumCompiledImplementations

[A347] Return the number of implementations compiled in

CCTK_NumCompiledThorns

[A349] Return the number of thorns compiled in

CCTK_NumGridArrayReductionOperators

[A351] The number of grid array reduction operators registered

CCTK_NumGroups

[A353] Get the number of groups of variables compiled in the code

CCTK_NumIOMethods

[A357] Returns the total number of I/O methods registered with the flesh

CCTK_NumLocalArrayReduceOperators

[A359] The number of local reduction operators registered

CCTK_NumReductionArraysGloballyOperators

[A361] The number of global array reduction operators registered

CCTK_NumTimeLevels

[A362] Returns the number of active timelevels from a group name (deprecated)

CCTK_NumTimeLevelsGI

[A362] Returns the number of active timelevels from a group index (deprecated)

CCTK_NumTimeLevelsGN

[A362] Returns the number of active timelevels from a group name (deprecated)

CCTK_NumTimeLevelsVI

[A362] Returns the number of active timelevels from a variable index (deprecated)

CCTK_NumTimeLevelsVN

[A362] Returns the number of active timelevels from a variable name (deprecated)

CCTK_NumTimerClocks

[A366] Returns the number of clocks in a cTimerData structure.

CCTK_NumVars

[A367] Get the number of grid variables compiled in the code

CCTK_NumVarsInGroup

[A371] Provides the number of variables in a group from the group name

CCTK_NumVarsInGroupI

[A375] Provides the number of variables in a group from the group index

CCTK_OutputGH

[A379] Conditional output of all variables on a GH by all I/O methods

CCTK_OutputVar

[A381] Output of a single variable by all I/O methods

CCTK_OutputVarAs

[A383] Output of a single variable as an alias by all I/O methods

CCTK_OutputVarAsByMethod

[A386] Output of a single variable as an alias by a single I/O method

CCTK_OutputVarByMethod

[A389] Output of a single variable by a single I/O method

CCTK_ParallelInit

[A392] Initializes the parallel subsystem

CCTK_ParameterData

[A394] Get parameter properties for given parameter/thorn pair

CCTK_ParameterGet

[A396] Get the data pointer to and type of a parameter’s value

CCTK_ParameterLevel

[A398] Return the parameter checking level

CCTK_ParameterQueryTimesSet

[A399] Return number of times a parameter has been set

CCTK_ParameterSet

[A401] Sets the value of a parameter

CCTK_ParameterSetNotifyRegister

[A404] Registers a parameter set operation notify callback

CCTK_ParameterSetNotifyUnregister

[A409] Unregisters a parameter set operation notify callback

CCTK_ParameterValString

[A412] Get the string representation of a parameter’s value

CCTK_ParameterWalk

[A415] Walk through the list of parameters

CCTK_PARAMWARN

[A417] Prints a warning from parameter checking, and possibly stops the code

CCTK_PointerTo

[A421] Returns a pointer to a Fortran variable.

CCTK_PrintGroup

[A423] Prints a group name from its index

CCTK_PrintString

[A427] Prints a Cactus string to screen (from Fortran)

CCTK_PrintVar

[A431] Prints a variable name from its index

CCTK_QueryGroupStorage

[A435] Queries storage for a group given by its group name

CCTK_QueryGroupStorageB

[A437] Queries storage for a group given by its group name or index

CCTK_QueryGroupStorageI

[A438] Queries storage for a group given by its group index

CCTK_ReduceArraysGlobally

[A441] Reduces a list of local arrays globally

CCTK_ReduceGridArrays

[A447] Reduces a list of local arrays (new grid array reduction API)

CCTK_ReduceLocalArrays

[A453] Reduces a list of local arrays (new local array reduction API) Returns the address of a variable passed in by reference from a Fortran routine

CCTK_ReductionHandle

[A462] Get the handle for a registered reduction operator

CCTK_RegisterBanner

[A466] Register a banner for a thorn

CCTK_RegisterGHExtension

[A470] Register the name of an extension to the Cactus GH

CCTK_RegisterGHExtensionInitGH

[A471] Register a routine for providing initialisation for an extension to the Cactus GH

CCTK_RegisterGHExtensionScheduleTraverseGH

[A472] Register a GH extension schedule traversal routine

CCTK_RegisterGridArrayReductionOperator

[A474] Registers a function as a grid array reduction operator of a certain name

CCTK_RegisterGHExtensionSetupGH

[A473] Register a routine for setting up an extension to the Cactus GH

CCTK_RegisterIOMethod

[A476] Registers a new I/O method

CCTK_RegisterIOMethodOutputGH

[A478] Registers an I/O method’s routine for conditional output

CCTK_RegisterIOMethodOutputVarAs

[A479] Registers an I/O method’s routine for unconditional output

CCTK_RegisterIOMethodTimeToOutput

[A480] Register a routine for deciding if it is time to output for an IO method

CCTK_RegisterIOMethodTriggerOutput

[A481] Register a routine for dealing with trigger output for an IO method

CCTK_RegisterLocalArrayReductionOperator

[A482] Registers a function as a reduction operator of a certain name

CCTK_RegisterReduceArraysGloballyOperator

[A484] Register a function as providing a global array reduction operation

CCTK_RegisterReductionOperator

[A486] Register a function as providing a reduction operation

CCTK_SchedulePrintTimes

[A487] Output the timing results for a certain schedule item to stdout

CCTK_SchedulePrintTimesToFile

[A489] Output the timing results for a certain schedule item to a file

CCTK_SetupGH

[A491] Sets up a CCTK grid hierarchy

CCTK_SyncGroup

[A492] Synchronize the ghost zones for a group of variables (identified by the group name)

CCTK_SyncGroupI

[A496] Synchronize the ghost zones for a group of variables (identified by the group index)

CCTK_SyncGroupsI

[A500] Synchronize the ghost zones for a list of groups of variables (identified by their group indices)

CCTK_TerminateNext

[A506] Causes a Cactus simulation to terminate after the next iteration

CCTK_TerminationReached

[A508] Returns true if CCTK_TerminateNext has been called.

CCTK_ThornImplementation

[A510] Returns the implementation provided by the thorn

CCTK_Timer

[A513] Fills a timer cTimerData structure with current values of all clocks of a timer with a given name.

CCTK_TimerCreate

[A514] Create a timer with a given name, returns a timer index.

CCTK_TimerCreateData

[A515] Allocates a timer cTimerData structure.

CCTK_TimerCreateI

[A516] Create an unnamed timer, returns a timer index.

CCTK_TimerDestroy

[A517] Reclaims resources for a timer with a given name.

CCTK_TimerDestroyData

[A518] Reclaims resources of a timer cTimerData structure.

CCTK_TimerDestroyI

[A519] Reclaims resources for a timer with a given index.

CCTK_TimerI

[A520] Fills a timer cTimerData structure with current values of all clocks of a timer with a given index.

CCTK_TimerReset

[A521] Initialises the timer with a given name.

CCTK_TimerResetI

[A522] Initialises the timer with a given index.

CCTK_TimerStart

[A523] Initialises the timer with a given name.

CCTK_TimerStartI

[A524] Initialises the timer with a given index.

CCTK_TimerStop

[A525] Gets current values for all clocks of the timer with a given name.

CCTK_TimerStopI

[A526] Gets current values for all clocks of the timer with a given index.

CCTK_VarDataPtr

[A527] Returns the data pointer for a grid variable

CCTK_VarDataPtrB

[A529] Returns the data pointer for a grid variable from the variable index or name

CCTK_VarDataPtrI

[A531] Returns the data pointer for a grid variable from the variable index

CCTK_VarIndex

[A533] Get the index for a variable

CCTK_VarName

[A537] Given a variable index, returns the variable name

CCTK_VarTypeI

[A539] Provides variable type index from the variable index

CCTK_VarTypeSize

[A543] Provides variable type size in bytes from the variable type index

CCTK_VInfo

[A545] Prints a formatted string with a variable argument list as an information message to screen

CCTK_VWarn

[A547] Prints a formatted string with a variable argument list as a warning message to standard error and possibly stops the code

CCTK_WARN

[A551] Macro to print a single string as a warning message to standard error and possibly stop the code

CCTK_WarnCallbackRegister

[A555] Register one or more routines for dealing with warning messages in addition to printing them to standard error