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).
|
Contains the enumeration constants and the discovery routines for the ModelRoutineName Extensible Enumeration. More...
Classes | |
struct | Comparator |
Structure provided for use with std::map. More... | |
Functions | |
void | GetNumberOfModelRoutineNames (int *const numberOfModelRoutineNames) |
Get the number of standard ModelRoutineName's defined by the KIM API. More... | |
int | GetModelRoutineName (int const index, ModelRoutineName *const modelRoutineName) |
Get the identity of each defined standard ModelRoutineName. More... | |
Variables | |
ModelRoutineName const | Create |
The standard Create routine. More... | |
ModelRoutineName const | ComputeArgumentsCreate |
The standard ComputeArgumentsCreate routine. More... | |
ModelRoutineName const | Compute |
The standard Compute routine. More... | |
ModelRoutineName const | Extension |
The standard Extension routine. More... | |
ModelRoutineName const | Refresh |
The standard Refresh routine. More... | |
ModelRoutineName const | WriteParameterizedModel |
The standard WriteParameterizedModel routine. More... | |
ModelRoutineName const | ComputeArgumentsDestroy |
The standard ComputeArgumentsDestroy routine. More... | |
ModelRoutineName const | Destroy |
The standard Destroy routine. More... | |
Contains the enumeration constants and the discovery routines for the ModelRoutineName Extensible Enumeration.
int KIM::MODEL_ROUTINE_NAME::GetModelRoutineName | ( | int const | index, |
ModelRoutineName *const | modelRoutineName | ||
) |
Get the identity of each defined standard ModelRoutineName.
[in] | index | Zero-based index uniquely labeling each defined standard ModelRoutineName. This index ordering is only guaranteed to be stable during the lifetime of the current process. |
[out] | modelRoutineName | The ModelRoutineName object associated with index . |
true
if index < 0
or index >= numberOfModelRoutineNames
. false
otherwise.void KIM::MODEL_ROUTINE_NAME::GetNumberOfModelRoutineNames | ( | int *const | numberOfModelRoutineNames | ) |
Get the number of standard ModelRoutineName's defined by the KIM API.
[out] | numberOfModelRoutineNames | The number of standard ModelRoutineName's defined by the KIM API. |
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::Compute |
The standard Compute
routine.
The C++ prototype for this routine is ModelComputeFunction(). The C prototype for this routine is KIM_ModelComputeFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::ComputeArgumentsCreate |
The standard ComputeArgumentsCreate
routine.
The C++ prototype for this routine is ModelComputeArgumentsCreateFunction(). The C prototype for this routine is KIM_ModelComputeArgumentsCreateFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::ComputeArgumentsDestroy |
The standard ComputeArgumentsDestroy
routine.
The C++ prototype for this routine is ModelComputeArgumentsDestroyFunction(). The C prototype for this routine is KIM_ModelComputeArgumentsDestroyFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::Create |
The standard Create
routine.
The C++ prototype for this routine is ModelCreateFunction(). The C prototype for this routine is KIM_ModelCreateFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::Destroy |
The standard Destroy
routine.
The C++ prototype for this routine is ModelDestroyFunction(). The C prototype for this routine is KIM_ModelDestroyFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::Extension |
The standard Extension
routine.
The C++ prototype for this routine is ModelExtensionFunction(). The C prototype for this routine is KIM_ModelExtensionFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::Refresh |
The standard Refresh
routine.
The C++ prototype for this routine is ModelRefreshFunction(). The C prototype for this routine is KIM_ModelRefreshFunction().
ModelRoutineName const KIM::MODEL_ROUTINE_NAME::WriteParameterizedModel |
The standard WriteParameterizedModel
routine.
The C++ prototype for this routine is ModelWriteParameterizedModelFunction(). The C prototype for this routine is KIM_ModelWriteParameterizedModelFunction().