kim-api
2.3.1-git+v2.3.0-git-2-g378406f9.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
#include "KIM_FunctionTypes.h"
Go to the source code of this file.
Typedefs | |
typedef struct KIM_LogVerbosity | KIM_LogVerbosity |
Forward declaration. More... | |
typedef struct KIM_LanguageName | KIM_LanguageName |
Forward declaration. More... | |
typedef struct KIM_ComputeArgumentName | KIM_ComputeArgumentName |
Forward declaration. More... | |
typedef struct KIM_ComputeCallbackName | KIM_ComputeCallbackName |
Forward declaration. More... | |
typedef struct KIM_SupportStatus | KIM_SupportStatus |
Forward declaration. More... | |
typedef struct KIM_ComputeArguments | KIM_ComputeArguments |
Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators. More... | |
Functions | |
int | KIM_ComputeArguments_GetArgumentSupportStatus (KIM_ComputeArguments const *const computeArguments, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus *const supportStatus) |
Get the SupportStatus of a ComputeArgumentName. More... | |
int | KIM_ComputeArguments_GetCallbackSupportStatus (KIM_ComputeArguments const *const computeArguments, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus *const supportStatus) |
Get the SupportStatus of a ComputeCallbackName. More... | |
int | KIM_ComputeArguments_SetArgumentPointerInteger (KIM_ComputeArguments *const computeArguments, KIM_ComputeArgumentName const computeArgumentName, int const *const ptr) |
Set the data pointer for a ComputeArgumentName. More... | |
int | KIM_ComputeArguments_SetArgumentPointerDouble (KIM_ComputeArguments *const computeArguments, KIM_ComputeArgumentName const computeArgumentName, double const *const ptr) |
Set the data pointer for a ComputeArgumentName. More... | |
int | KIM_ComputeArguments_SetCallbackPointer (KIM_ComputeArguments *const computeArguments, KIM_ComputeCallbackName const computeCallbackName, KIM_LanguageName const languageName, KIM_Function *const fptr, void *const dataObject) |
Set the function pointer for a ComputeCallbackName. More... | |
void | KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent (KIM_ComputeArguments const *const computeArguments, int *const result) |
Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's with SupportStatus values of SUPPORT_STATUS::requiredByAPI or SUPPORT_STATUS::required. More... | |
void | KIM_ComputeArguments_SetSimulatorBufferPointer (KIM_ComputeArguments *const computeArguments, void *const ptr) |
Set the Simulator's buffer pointer within the ComputeArguments object. More... | |
void | KIM_ComputeArguments_GetSimulatorBufferPointer (KIM_ComputeArguments const *const computeArguments, void **const ptr) |
Get the Simulator's buffer pointer from the ComputeArguments object. More... | |
char const * | KIM_ComputeArguments_ToString (KIM_ComputeArguments const *const computeArguments) |
Get a string representing the internal state of the ComputeArguments object. More... | |
void | KIM_ComputeArguments_SetLogID (KIM_ComputeArguments *const computeArguments, char const *const logID) |
Set the identity of the Log object associated with the ComputeArguments object. More... | |
void | KIM_ComputeArguments_PushLogVerbosity (KIM_ComputeArguments *const computeArguments, KIM_LogVerbosity const logVerbosity) |
Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack. More... | |
void | KIM_ComputeArguments_PopLogVerbosity (KIM_ComputeArguments *const computeArguments) |
Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack. More... | |
typedef struct KIM_ComputeArgumentName KIM_ComputeArgumentName |
typedef struct KIM_ComputeArguments KIM_ComputeArguments |
Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators.
Definition at line 100 of file KIM_ComputeArguments.h.
typedef struct KIM_ComputeCallbackName KIM_ComputeCallbackName |
typedef struct KIM_LanguageName KIM_LanguageName |
typedef struct KIM_LogVerbosity KIM_LogVerbosity |
typedef struct KIM_SupportStatus KIM_SupportStatus |
void KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent | ( | KIM_ComputeArguments const *const | computeArguments, |
int *const | result | ||
) |
Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's with SupportStatus values of SUPPORT_STATUS::requiredByAPI or SUPPORT_STATUS::required.
int KIM_ComputeArguments_GetArgumentSupportStatus | ( | KIM_ComputeArguments const *const | computeArguments, |
KIM_ComputeArgumentName const | computeArgumentName, | ||
KIM_SupportStatus *const | supportStatus | ||
) |
Get the SupportStatus of a ComputeArgumentName.
int KIM_ComputeArguments_GetCallbackSupportStatus | ( | KIM_ComputeArguments const *const | computeArguments, |
KIM_ComputeCallbackName const | computeCallbackName, | ||
KIM_SupportStatus *const | supportStatus | ||
) |
Get the SupportStatus of a ComputeCallbackName.
void KIM_ComputeArguments_GetSimulatorBufferPointer | ( | KIM_ComputeArguments const *const | computeArguments, |
void **const | ptr | ||
) |
Get the Simulator's buffer pointer from the ComputeArguments object.
void KIM_ComputeArguments_PopLogVerbosity | ( | KIM_ComputeArguments *const | computeArguments | ) |
Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack.
void KIM_ComputeArguments_PushLogVerbosity | ( | KIM_ComputeArguments *const | computeArguments, |
KIM_LogVerbosity const | logVerbosity | ||
) |
Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack.
int KIM_ComputeArguments_SetArgumentPointerDouble | ( | KIM_ComputeArguments *const | computeArguments, |
KIM_ComputeArgumentName const | computeArgumentName, | ||
double const *const | ptr | ||
) |
Set the data pointer for a ComputeArgumentName.
int KIM_ComputeArguments_SetArgumentPointerInteger | ( | KIM_ComputeArguments *const | computeArguments, |
KIM_ComputeArgumentName const | computeArgumentName, | ||
int const *const | ptr | ||
) |
Set the data pointer for a ComputeArgumentName.
int KIM_ComputeArguments_SetCallbackPointer | ( | KIM_ComputeArguments *const | computeArguments, |
KIM_ComputeCallbackName const | computeCallbackName, | ||
KIM_LanguageName const | languageName, | ||
KIM_Function *const | fptr, | ||
void *const | dataObject | ||
) |
Set the function pointer for a ComputeCallbackName.
void KIM_ComputeArguments_SetLogID | ( | KIM_ComputeArguments *const | computeArguments, |
char const *const | logID | ||
) |
Set the identity of the Log object associated with the ComputeArguments object.
void KIM_ComputeArguments_SetSimulatorBufferPointer | ( | KIM_ComputeArguments *const | computeArguments, |
void *const | ptr | ||
) |
Set the Simulator's buffer pointer within the ComputeArguments object.
char const* KIM_ComputeArguments_ToString | ( | KIM_ComputeArguments const *const | computeArguments | ) |
Get a string representing the internal state of the ComputeArguments object.