Chapter A1
Functions Alphabetically

CCTK_Abort

[A46] Causes abnormal Cactus termination

CCTK_ActivatingThorn

[A51] Finds the thorn which activated a particular implementation

CCTK_ActiveTimeLevels

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

CCTK_ActiveTimeLevelsGI

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

CCTK_ActiveTimeLevelsGN

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

CCTK_ActiveTimeLevelsVI

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

CCTK_ActiveTimeLevelsVN

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

CCTK_ArrayGroupSize

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

CCTK_ArrayGroupSizeI

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

CCTK_Barrier

[A61] Synchronizes all processors

CCTK_ClockRegister

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

CCTK_Cmplx

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

CCTK_CmplxAbs

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

CCTK_CmplxAdd

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

CCTK_CmplxConjg

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

CCTK_CmplxCos

[A72] Returns the Cosine of a complex number (only C) [deprecated]

CCTK_CmplxDiv

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

CCTK_CmplxExp

[A76] Returns the Exponentiation of a complex number (only C) [deprecated]

CCTK_CmplxImag

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

CCTK_CmplxLog

[A80] Returns the Logarithm of a complex number (only C) [deprecated]

CCTK_CmplxMul

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

CCTK_CmplxReal

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

CCTK_CmplxSin

[A86] Returns the Sine of a complex number (only C) [deprecated]

CCTK_CmplxSqrt

[A88] Returns the square root of a complex number (only C) [deprecated]

CCTK_CmplxSub

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

CCTK_CommandLine

[A92] Gets the command line arguments.

CCTK_CompileDate

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

CCTK_CompileDateTime

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

CCTK_CompileTime

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

CCTK_CompiledImplementation

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

CCTK_CompiledThorn

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

CCTK_CoordDir

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

CCTK_CoordIndex

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

CCTK_CoordRange

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

CCTK_CoordRegisterData

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

CCTK_CoordRegisterRange

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

CCTK_CoordRegisterSystem

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

CCTK_CoordSystemDim

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

CCTK_CoordSystemHandle

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

CCTK_CoordSystemName

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

CCTK_CreateDirectory

[A134] Creates a directory

CCTK_DeclaredTimeLevels

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

CCTK_DeclaredTimeLevelsGI

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

CCTK_DeclaredTimeLevelsGN

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

CCTK_DeclaredTimeLevelsVI

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

CCTK_DeclaredTimeLevelsVN

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

CCTK_DecomposeName

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

CCTK_DisableGroupComm

[A157] Disable the communication for a group

CCTK_DisableGroupCommI

[A158] Disable the communication for a group

CCTK_DisableGroupStorage

[A160] Disable the storage for a group

CCTK_DisableGroupStorageI

[A161] Disable the storage for a group

CCTK_EnableGroupComm

[A162] Enable the communication for a group

CCTK_EnableGroupCommI

[A164] Enable the communication for a group

CCTK_EnableGroupStorage

[A166] Enable the storage for a group

CCTK_EnableGroupStorageI

[A167] Enable the storage for a group

CCTK_Equals

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

CCTK_ERROR

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

CCTK_Error

[A178] Function to print a single string as error message to standard error and stop the code

CCTK_Exit

[A181] Causes normal Cactus termination

CCTK_FirstVarIndex

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

CCTK_FirstVarIndexI

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

CCTK_FortranString

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

CCTK_FullName

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

CCTK_FullVarName

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

CCTK_GetClockName

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

CCTK_GetClockResolution

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

CCTK_GetClockSeconds

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

CCTK_GetClockValue

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

CCTK_GetClockValueI

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

CCTK_GHExtension

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

CCTK_GHExtensionHandle

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

CCTK_GridArrayReductionOperator

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

CCTK_GroupbboxGI

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

CCTK_GroupbboxGN

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

CCTK_GroupbboxVI

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

CCTK_GroupbboxVN

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

CCTK_GroupData

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

CCTK_GroupDimFromVarI

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

CCTK_GroupDimI

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

CCTK_GroupDynamicData

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

CCTK_GroupGhostsizesI

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

CCTK_GroupgshGI

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

CCTK_GroupgshGN

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

CCTK_GroupgshVI

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

CCTK_GroupgshVN

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

CCTK_GroupIndex

[A239] Get the index number for a group name

CCTK_GroupIndexFromVar

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

CCTK_GroupIndexFromVarI

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

CCTK_GrouplbndGI

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

CCTK_GrouplbndGN

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

CCTK_GrouplbndVI

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

CCTK_GrouplbndVN

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

CCTK_GrouplshGI

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

CCTK_GrouplshGN

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

CCTK_GrouplshVI

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

CCTK_GrouplshVN

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

CCTK_GroupashGI

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

CCTK_GroupashGN

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

CCTK_GroupashVI

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

CCTK_GroupashVN

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

CCTK_GroupName

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

CCTK_GroupNameFromVarI

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

CCTK_GroupnghostzonesGI

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

CCTK_GroupnghostzonesGN

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

CCTK_GroupnghostzonesVI

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

CCTK_GroupnghostzonesVN

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

CCTK_GroupSizesI

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

CCTK_GroupStorageDecrease

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

CCTK_GroupStorageIncrease

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

CCTK_GroupTagsTable

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

CCTK_GroupTagsTableI

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

CCTK_GroupTypeFromVarI

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

CCTK_GroupTypeI

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

CCTK_GroupubndGI

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

CCTK_GroupubndGN

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

CCTK_GroupubndVI

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

CCTK_GroupubndVN

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

CCTK_ImpFromVarI

[A303] Given a variable index, returns the implementation name for a public or protected variable, the thorn name otherwise.

CCTK_ImplementationRequires

[A305] Return the ancestors for an implementation

CCTK_ImplementationThorn

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

CCTK_ImpThornList

[A309] Return the thorns for an implementation

CCTK_INFO

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

CCTK_Info

[A316] Function to print a single string as an information message to screen

CCTK_InfoCallbackRegister

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

CCTK_InterpGridArrays

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

CCTK_InterpHandle

[A332] Returns the handle for a given interpolation operator

CCTK_InterpLocalUniform

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

CCTK_InterpRegisterOpLocalUniform

[A343] Registers a routine as a CCTK_InterpLocalUniform interpolation operator

CCTK_IsFunctionAliased

[A346] Reports whether an aliased function has been provided

CCTK_IsImplementationActive

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

CCTK_IsImplementationCompiled

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

CCTK_IsThornActive

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

CCTK_IsThornCompiled

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

CCTK_LocalArrayReduceOperator

[A357] Returns the name of a registered reduction operator

CCTK_LocalArrayReduceOperatorImplementation

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

CCTK_LocalArrayReductionHandle

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

CCTK_MaxActiveTimeLevels

[A363] Returns the maximum number of timeleves that were ever active from a group name

CCTK_MaxActiveTimeLevelsGI

[A363] Returns the maximum number of timeleves that were ever active from a group index

CCTK_MaxActiveTimeLevelsGN

[A363] Returns the maximum number of timeleves that were ever active from a group name

CCTK_MaxActiveTimeLevelsVI

[A363] Returns the maximum number of timeleves that were ever active from a variable index

CCTK_MaxActiveTimeLevelsVN

[A363] Returns the maximum number of timeleves that were ever active from a variable name

CCTK_MaxDim

[A366] Get the maximum dimension of any grid variable

CCTK_MaxGFDim

[A370] Get the maximum dimension of all grid functions

CCTK_MaxTimeLevels

[A374] Decprecated. Use CCTK_DeclaredTimeLevels instead.

CCTK_MyProc

[A374] Get the local processor number

CCTK_nProcs

[A375] Get the total number of processors used

CCTK_NullPointer

[A377] Returns a C-style NULL pointer value

CCTK_NumCompiledImplementations

[A379] Return the number of implementations compiled in

CCTK_NumCompiledThorns

[A381] Return the number of thorns compiled in

CCTK_NumGridArrayReductionOperators

[A383] The number of grid array reduction operators registered

CCTK_NumGroups

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

CCTK_NumIOMethods

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

CCTK_NumLocalArrayReduceOperators

[A391] The number of local reduction operators registered

CCTK_NumReductionArraysGloballyOperators

[A393] The number of global array reduction operators registered

CCTK_NumTimerClocks

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

CCTK_NumVars

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

CCTK_NumVarsInGroup

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

CCTK_NumVarsInGroupI

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

CCTK_OutputGH

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

CCTK_OutputVar

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

CCTK_OutputVarAs

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

CCTK_OutputVarAsByMethod

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

CCTK_OutputVarByMethod

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

CCTK_ParallelInit

[A421] Initializes the parallel subsystem

CCTK_ParameterData

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

CCTK_ParameterGet

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

CCTK_ParameterFilename

[A425] Returns the parameter filename

CCTK_ParameterLevel

[A430] Return the parameter checking level

CCTK_ParameterQueryTimesSet

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

CCTK_ParameterSet

[A433] Sets the value of a parameter

CCTK_ParameterSetNotifyRegister

[A436] Registers a parameter set operation notify callback

CCTK_ParameterSetNotifyUnregister

[A441] Unregisters a parameter set operation notify callback

CCTK_ParameterValString

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

CCTK_ParameterWalk

[A447] Walk through the list of parameters

CCTK_PARAMWARN

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

CCTK_PointerTo

[A454] Returns a pointer to a Fortran variable.

CCTK_PrintGroup

[A456] Prints a group name from its index

CCTK_PrintString

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

CCTK_PrintVar

[A464] Prints a variable name from its index

CCTK_QueryGroupStorage

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

CCTK_QueryGroupStorageB

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

CCTK_QueryGroupStorageI

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

CCTK_ReduceArraysGlobally

[A474] Reduces a list of local arrays globally

CCTK_ReduceGridArrays

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

CCTK_ReduceLocalArrays

[A486] 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

[A495] Get the handle for a registered reduction operator

CCTK_RegexMatch

[A499] Perform a regular expression match of string against pattern

CCTK_RegisterBanner

[A501] Register a banner for a thorn

CCTK_RegisterGHExtension

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

CCTK_RegisterGHExtensionInitGH

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

CCTK_RegisterGHExtensionScheduleTraverseGH

[A507] Register a GH extension schedule traversal routine

CCTK_RegisterGridArrayReductionOperator

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

CCTK_RegisterGHExtensionSetupGH

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

CCTK_RegisterIOMethod

[A511] Registers a new I/O method

CCTK_RegisterIOMethodOutputGH

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

CCTK_RegisterIOMethodOutputVarAs

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

CCTK_RegisterIOMethodTimeToOutput

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

CCTK_RegisterIOMethodTriggerOutput

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

CCTK_RegisterLocalArrayReductionOperator

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

CCTK_RegisterReduceArraysGloballyOperator

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

CCTK_RegisterReductionOperator

[A521] Register a function as providing a reduction operation

CCTK_RunTime

[A522] Return the number of seconds since the run started

CCTK_SchedulePrintTimes

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

CCTK_SchedulePrintTimesToFile

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

CCTK_ScheduleQueryCurrentFunction

[A527] Return the cFunctionData of the function currently executing via CCTK_CallFunction

CCTK_ScheduleTraverse

[A529] Traverses a schedule point, and its entry and exit points if necessary

CCTK_SetupGH

[A531] Sets up a CCTK grid hierarchy

CCTK_SyncGroup

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

CCTK_SyncGroupI

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

CCTK_SyncGroupsI

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

CCTK_TerminateNext

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

CCTK_TerminationReached

[A548] Returns true if CCTK_TerminateNext has been called.

CCTK_ThornImplementation

[A550] Returns the implementation provided by the thorn

CCTK_Timer

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

CCTK_TimerCreate

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

CCTK_TimerCreateData

[A555] Allocates a timer cTimerData structure.

CCTK_TimerCreateI

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

CCTK_TimerDestroy

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

CCTK_TimerDestroyData

[A558] Reclaims resources of a timer cTimerData structure.

CCTK_TimerDestroyI

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

CCTK_TimerI

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

CCTK_TimerReset

[A561] Initialises the timer with a given name.

CCTK_TimerResetI

[A562] Initialises the timer with a given index.

CCTK_TimerStart

[A563] Initialises the timer with a given name.

CCTK_TimerStartI

[A564] Initialises the timer with a given index.

CCTK_TimerStop

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

CCTK_TimerStopI

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

CCTK_TraverseString

[A571] Traverse through all variables and/or groups whose names appear in the given string.

CCTK_VarDataPtr

[A573] Returns the data pointer for a grid variable

CCTK_VarDataPtrB

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

CCTK_VarDataPtrI

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

CCTK_VarIndex

[A583] Get the index for a variable

CCTK_VarName

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

CCTK_VarTypeI

[A590] Provides variable type index from the variable index

CCTK_VarTypeSize

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

CCTK_VERROR

[A596] Macro to print a formatted string with a variable argument list as error message to standard error and stops the code

CCTK_VError

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

CCTK_VINFO

[A602] Macro to print a formatted string with a variable argument list as an information message to screen

CCTK_VInfo

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

CCTK_VParamWarn

[A608] Prints a formatted string with a variable argument list as a warning from parameter checking, and possibly stops the code

CCTK_VWARN

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

CCTK_VWarn

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

CCTK_WARN

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

CCTK_Warn

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

CCTK_WarnCallbackRegister

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