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

Contains the enumeration constants and the discovery routines for the ComputeCallbackName Extensible Enumeration. More...

Classes

struct  Comparator
 Structure provided for use with std::map. More...
 

Functions

void GetNumberOfComputeCallbackNames (int *const numberOfComputeCallbackNames)
 Get the number of standard ComputeCallbackName's defined by the KIM API. More...
 
int GetComputeCallbackName (int const index, ComputeCallbackName *const computeCallbackName)
 Get the identity of each defined standard ComputeCallbackName. More...
 

Variables

ComputeCallbackName const GetNeighborList
 The standard GetNeighborList callback. More...
 
ComputeCallbackName const ProcessDEDrTerm
 The standard ProcessDEDrTerm callback. More...
 
ComputeCallbackName const ProcessD2EDr2Term
 The standard ProcessD2EDr2Term callback. More...
 

Detailed Description

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

Function Documentation

◆ GetComputeCallbackName()

int KIM::COMPUTE_CALLBACK_NAME::GetComputeCallbackName ( int const  index,
ComputeCallbackName *const  computeCallbackName 
)

Get the identity of each defined standard ComputeCallbackName.

Parameters
[in]indexZero-based index uniquely labeling each defined standard ComputeCallbackName. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]computeCallbackNameThe ComputeCallbackName object associated with index.
Returns
true if index < 0 or index >= numberOfComputeCallbackNames.
false otherwise.
See also
KIM_COMPUTE_CALLBACK_NAME_GetComputeCallbackName, kim_compute_callback_name_module::kim_get_compute_callback_name
Since
2.0

◆ GetNumberOfComputeCallbackNames()

void KIM::COMPUTE_CALLBACK_NAME::GetNumberOfComputeCallbackNames ( int *const  numberOfComputeCallbackNames)

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

Parameters
[out]numberOfComputeCallbackNamesThe number of standard ComputeCallbackName's defined by the KIM API.
See also
KIM_COMPUTE_CALLBACK_NAME_GetNumberOfComputeCallbackNames, kim_compute_callback_name_module::kim_get_number_of_compute_callback_names
Since
2.0

Variable Documentation

◆ GetNeighborList

ComputeCallbackName const KIM::COMPUTE_CALLBACK_NAME::GetNeighborList

The standard GetNeighborList callback.

The C++ prototype for this routine is GetNeighborListFunction(). The C prototype for this routine is KIM_GetNeighborListFunction().

Todo:
Add more detailed description of callback.
See also
KIM_COMPUTE_CALLBACK_NAME_GetNeighborList, kim_compute_callback_name_module::kim_compute_callback_name_get_neighbor_list
Since
2.0

◆ ProcessD2EDr2Term

ComputeCallbackName const KIM::COMPUTE_CALLBACK_NAME::ProcessD2EDr2Term

The standard ProcessD2EDr2Term callback.

The C++ prototype for this routine is ProcessD2EDr2TermFunction(). The C prototype for this routine is KIM_ProcessD2EDr2TermFunction().

Todo:
Add more detailed description of callback.
See also
KIM_COMPUTE_CALLBACK_NAME_ProcessD2EDr2Term, kim_compute_callback_name_module::kim_compute_callback_name_process_d2edr2_term
Since
2.0

◆ ProcessDEDrTerm

ComputeCallbackName const KIM::COMPUTE_CALLBACK_NAME::ProcessDEDrTerm

The standard ProcessDEDrTerm callback.

The C++ prototype for this routine is ProcessDEDrTermFunction(). The C prototype for this routine is KIM_ProcessDEDrTermFunction().

Todo:
Add more detailed description of callback.
See also
KIM_COMPUTE_CALLBACK_NAME_ProcessDEDrTerm, kim_compute_callback_name_module::kim_compute_callback_name_process_dedr_term
Since
2.0