kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Functions | Variables
KIM::MODEL_ROUTINE_NAME Namespace Reference

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...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the ModelRoutineName Extensible Enumeration.

Function Documentation

◆ GetModelRoutineName()

int KIM::MODEL_ROUTINE_NAME::GetModelRoutineName ( int const  index,
ModelRoutineName *const  modelRoutineName 
)

Get the identity of each defined standard ModelRoutineName.

Parameters
[in]indexZero-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]modelRoutineNameThe ModelRoutineName object associated with index.
Returns
true if index < 0 or index >= numberOfModelRoutineNames.
false otherwise.
See also
KIM_MODEL_ROUTINE_NAME_GetModelRoutineName, kim_model_routine_name_module::kim_get_model_routine_name
Since
2.0

◆ GetNumberOfModelRoutineNames()

void KIM::MODEL_ROUTINE_NAME::GetNumberOfModelRoutineNames ( int *const  numberOfModelRoutineNames)

Get the number of standard ModelRoutineName's defined by the KIM API.

Parameters
[out]numberOfModelRoutineNamesThe number of standard ModelRoutineName's defined by the KIM API.
See also
KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames, kim_model_routine_name_module::kim_get_number_of_model_routine_names
Since
2.0

Variable Documentation

◆ Compute

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_Compute, kim_model_routine_name_module::kim_model_routine_name_compute
Since
2.0

◆ ComputeArgumentsCreate

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate, kim_model_routine_name_module::kim_model_routine_name_compute_arguments_create
Since
2.0

◆ ComputeArgumentsDestroy

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy, kim_model_routine_name_module::kim_model_routine_name_compute_arguments_destroy
Since
2.0

◆ Create

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_Create, kim_model_routine_name_module::kim_model_routine_name_create
Since
2.0

◆ Destroy

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_Destroy, kim_model_routine_name_module::kim_model_routine_name_destroy
Since
2.0

◆ Extension

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_Extension, kim_model_routine_name_module::kim_model_routine_name_extension
Since
2.0

◆ Refresh

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_Refresh, kim_model_routine_name_module::kim_model_routine_name_refresh
Since
2.0

◆ WriteParameterizedModel

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().

Todo:
Add more detailed description of routine.
See also
KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel, kim_model_routine_name_module::kim_model_routine_name_write_parameterized_model
Since
2.0