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).
Typedefs
KIM_FunctionTypes.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef struct KIM_LengthUnit KIM_LengthUnit
 Forward declaration. More...
 
typedef struct KIM_EnergyUnit KIM_EnergyUnit
 Forward declaration. More...
 
typedef struct KIM_ChargeUnit KIM_ChargeUnit
 Forward declaration. More...
 
typedef struct KIM_TemperatureUnit KIM_TemperatureUnit
 Forward declaration. More...
 
typedef struct KIM_TimeUnit KIM_TimeUnit
 Forward declaration. More...
 
typedef struct KIM_ModelCreate KIM_ModelCreate
 Forward declaration. More...
 
typedef struct KIM_ModelDriverCreate KIM_ModelDriverCreate
 Forward declaration. More...
 
typedef struct KIM_ModelCompute KIM_ModelCompute
 Forward declaration. More...
 
typedef struct KIM_ModelExtension KIM_ModelExtension
 Forward declaration. More...
 
typedef struct KIM_ModelComputeArgumentsCreate KIM_ModelComputeArgumentsCreate
 Forward declaration. More...
 
typedef struct KIM_ModelComputeArguments KIM_ModelComputeArguments
 Forward declaration. More...
 
typedef struct KIM_ModelRefresh KIM_ModelRefresh
 Forward declaration. More...
 
typedef struct KIM_ModelWriteParameterizedModel KIM_ModelWriteParameterizedModel
 Forward declaration. More...
 
typedef struct KIM_ModelComputeArgumentsDestroy KIM_ModelComputeArgumentsDestroy
 Forward declaration. More...
 
typedef struct KIM_ModelDestroy KIM_ModelDestroy
 Forward declaration. More...
 
typedef void() KIM_Function(void)
 Generic function type. More...
 
typedef int KIM_ModelCreateFunction(KIM_ModelCreate *const modelCreate, KIM_LengthUnit const requestedLengthUnit, KIM_EnergyUnit const requestedEnergyUnit, KIM_ChargeUnit const requestedChargeUnit, KIM_TemperatureUnit const requestedTemperatureUnit, KIM_TimeUnit const requestedTimeUnit)
 Prototype for MODEL_ROUTINE_NAME::Create routine. More...
 
typedef int KIM_ModelDriverCreateFunction(KIM_ModelDriverCreate *const modelDriverCreate, KIM_LengthUnit const requestedLengthUnit, KIM_EnergyUnit const requestedEnergyUnit, KIM_ChargeUnit const requestedChargeUnit, KIM_TemperatureUnit const requestedTemperatureUnit, KIM_TimeUnit const requestedTimeUnit)
 Prototype for MODEL_ROUTINE_NAME::Create routine. More...
 
typedef int KIM_ModelComputeArgumentsCreateFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate)
 Prototype for MODEL_ROUTINE_NAME::ComputeArgumentsCreate routine. More...
 
typedef int KIM_ModelComputeFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArguments const *const modelComputeArguments)
 Prototype for MODEL_ROUTINE_NAME::Compute routine. More...
 
typedef int KIM_GetNeighborListFunction(void *const dataObject, int const numberOfNeighborLists, double const *const cutoffs, int const neighborListIndex, int const particleNumber, int *const numberOfNeighbors, int const **const neighborsOfParticle)
 Prototype for COMPUTE_CALLBACK_NAME::GetNeighborList routine. More...
 
typedef int KIM_ProcessDEDrTermFunction(void *const dataObject, double const de, double const r, double const *const dx, int const i, int const j)
 Prototype for COMPUTE_CALLBACK_NAME::ProcessDEDrTerm routine. More...
 
typedef int KIM_ProcessD2EDr2TermFunction(void *const dataObject, double const de, double const *const r, double const *const dx, int const *const i, int const *const j)
 Prototype for COMPUTE_CALLBACK_NAME::ProcessD2EDr2Term routine. More...
 
typedef int KIM_ModelExtensionFunction(KIM_ModelExtension *const modelExtension, void *const extensionStructure)
 Prototype for MODEL_ROUTINE_NAME::Extension routine. More...
 
typedef int KIM_ModelRefreshFunction(KIM_ModelRefresh *const modelRefresh)
 Prototype for MODEL_ROUTINE_NAME::Refresh routine. More...
 
typedef int KIM_ModelWriteParameterizedModelFunction(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel)
 Prototype for MODEL_ROUTINE_NAME::WriteParameterizedModel routine. More...
 
typedef int KIM_ModelComputeArgumentsDestroyFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsDestroy *const modelComputeArgumentsDestroy)
 Prototype for MODEL_ROUTINE_NAME::ComputeArgumentsDestroy routine. More...
 
typedef int KIM_ModelDestroyFunction(KIM_ModelDestroy *const modelDestroy)
 Prototype for MODEL_ROUTINE_NAME::Destroy routine. More...
 

Typedef Documentation

◆ KIM_ChargeUnit

Forward declaration.

Since
2.0

Definition at line 67 of file KIM_FunctionTypes.h.

◆ KIM_EnergyUnit

Forward declaration.

Since
2.0

Definition at line 57 of file KIM_FunctionTypes.h.

◆ KIM_Function

typedef void() KIM_Function(void)

Generic function type.

See also
KIM::Function
Since
2.0

Definition at line 200 of file KIM_FunctionTypes.h.

◆ KIM_GetNeighborListFunction

typedef int KIM_GetNeighborListFunction(void *const dataObject, int const numberOfNeighborLists, double const *const cutoffs, int const neighborListIndex, int const particleNumber, int *const numberOfNeighbors, int const **const neighborsOfParticle)

Prototype for COMPUTE_CALLBACK_NAME::GetNeighborList routine.

See also
KIM::GetNeighborListFunction, kim_model_compute_arguments_module::kim_model_compute_arguments_get_neighbor_list
Since
2.0

Definition at line 263 of file KIM_FunctionTypes.h.

◆ KIM_LengthUnit

Forward declaration.

Since
2.0

Definition at line 47 of file KIM_FunctionTypes.h.

◆ KIM_ModelCompute

Forward declaration.

Since
2.0

Definition at line 117 of file KIM_FunctionTypes.h.

◆ KIM_ModelComputeArguments

Forward declaration.

Since
2.0

Definition at line 147 of file KIM_FunctionTypes.h.

◆ KIM_ModelComputeArgumentsCreate

Forward declaration.

Since
2.0

Definition at line 137 of file KIM_FunctionTypes.h.

◆ KIM_ModelComputeArgumentsCreateFunction

typedef int KIM_ModelComputeArgumentsCreateFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate)

Prototype for MODEL_ROUTINE_NAME::ComputeArgumentsCreate routine.

See also
KIM::ModelComputeArgumentsCreateFunction, kim_model_module::kim_model_compute_arguments_create
Since
2.0

Definition at line 240 of file KIM_FunctionTypes.h.

◆ KIM_ModelComputeArgumentsDestroy

Forward declaration.

Since
2.0

Definition at line 178 of file KIM_FunctionTypes.h.

◆ KIM_ModelComputeArgumentsDestroyFunction

typedef int KIM_ModelComputeArgumentsDestroyFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArgumentsDestroy *const modelComputeArgumentsDestroy)

Prototype for MODEL_ROUTINE_NAME::ComputeArgumentsDestroy routine.

See also
KIM::ModelComputeArgumentsDestroyFunction, kim_model_module::kim_model_compute_arguments_destroy
Since
2.0

Definition at line 343 of file KIM_FunctionTypes.h.

◆ KIM_ModelComputeFunction

typedef int KIM_ModelComputeFunction(KIM_ModelCompute const *const modelCompute, KIM_ModelComputeArguments const *const modelComputeArguments)

Prototype for MODEL_ROUTINE_NAME::Compute routine.

See also
KIM::ModelComputeFunction, kim_model_module::kim_model_compute
Since
2.0

Definition at line 251 of file KIM_FunctionTypes.h.

◆ KIM_ModelCreate

Forward declaration.

Since
2.0

Definition at line 97 of file KIM_FunctionTypes.h.

◆ KIM_ModelCreateFunction

typedef int KIM_ModelCreateFunction(KIM_ModelCreate *const modelCreate, KIM_LengthUnit const requestedLengthUnit, KIM_EnergyUnit const requestedEnergyUnit, KIM_ChargeUnit const requestedChargeUnit, KIM_TemperatureUnit const requestedTemperatureUnit, KIM_TimeUnit const requestedTimeUnit)

Prototype for MODEL_ROUTINE_NAME::Create routine.

See also
KIM::ModelCreateFunction, kim_model_module::kim_model_create
Since
2.0

Definition at line 210 of file KIM_FunctionTypes.h.

◆ KIM_ModelDestroy

Forward declaration.

Since
2.0

Definition at line 189 of file KIM_FunctionTypes.h.

◆ KIM_ModelDestroyFunction

typedef int KIM_ModelDestroyFunction(KIM_ModelDestroy *const modelDestroy)

Prototype for MODEL_ROUTINE_NAME::Destroy routine.

See also
KIM::ModelDestroyFunction, kim_model_module::kim_model_destroy
Since
2.0

Definition at line 354 of file KIM_FunctionTypes.h.

◆ KIM_ModelDriverCreate

Forward declaration.

Since
2.0

Definition at line 107 of file KIM_FunctionTypes.h.

◆ KIM_ModelDriverCreateFunction

typedef int KIM_ModelDriverCreateFunction(KIM_ModelDriverCreate *const modelDriverCreate, KIM_LengthUnit const requestedLengthUnit, KIM_EnergyUnit const requestedEnergyUnit, KIM_ChargeUnit const requestedChargeUnit, KIM_TemperatureUnit const requestedTemperatureUnit, KIM_TimeUnit const requestedTimeUnit)

Prototype for MODEL_ROUTINE_NAME::Create routine.

See also
KIM::ModelDriverCreateFunction, kim_model_module::kim_model_create
Since
2.0

Definition at line 224 of file KIM_FunctionTypes.h.

◆ KIM_ModelExtension

Forward declaration.

Since
2.0

Definition at line 127 of file KIM_FunctionTypes.h.

◆ KIM_ModelExtensionFunction

typedef int KIM_ModelExtensionFunction(KIM_ModelExtension *const modelExtension, void *const extensionStructure)

Prototype for MODEL_ROUTINE_NAME::Extension routine.

See also
KIM::ModelExtensionFunction, kim_model_module::kim_model_extension
Since
2.0

Definition at line 310 of file KIM_FunctionTypes.h.

◆ KIM_ModelRefresh

Forward declaration.

Since
2.0

Definition at line 157 of file KIM_FunctionTypes.h.

◆ KIM_ModelRefreshFunction

typedef int KIM_ModelRefreshFunction(KIM_ModelRefresh *const modelRefresh)

Prototype for MODEL_ROUTINE_NAME::Refresh routine.

See also
KIM::ModelRefreshFunction, kim_model_module::kim_model_clear_then_refresh
Since
2.0

Definition at line 321 of file KIM_FunctionTypes.h.

◆ KIM_ModelWriteParameterizedModel

Forward declaration.

Since
2.0

Definition at line 167 of file KIM_FunctionTypes.h.

◆ KIM_ModelWriteParameterizedModelFunction

typedef int KIM_ModelWriteParameterizedModelFunction(KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel)

Prototype for MODEL_ROUTINE_NAME::WriteParameterizedModel routine.

See also
KIM::ModelWriteParameterizedModelFunction, kim_model_module::

Definition at line 331 of file KIM_FunctionTypes.h.

◆ KIM_ProcessD2EDr2TermFunction

typedef int KIM_ProcessD2EDr2TermFunction(void *const dataObject, double const de, double const *const r, double const *const dx, int const *const i, int const *const j)

Prototype for COMPUTE_CALLBACK_NAME::ProcessD2EDr2Term routine.

See also
KIM::ProcessD2EDr2TermFunction, kim_model_compute_arguments_module::kim_model_compute_arguments_process_d2edr2_term
Since
2.0

Definition at line 295 of file KIM_FunctionTypes.h.

◆ KIM_ProcessDEDrTermFunction

typedef int KIM_ProcessDEDrTermFunction(void *const dataObject, double const de, double const r, double const *const dx, int const i, int const j)

Prototype for COMPUTE_CALLBACK_NAME::ProcessDEDrTerm routine.

See also
KIM::ProcessDEDrTermFunction, kim_model_compute_arguments_module::kim_model_compute_arguments_process_dedr_term
Since
2.0

Definition at line 279 of file KIM_FunctionTypes.h.

◆ KIM_TemperatureUnit

Forward declaration.

Since
2.0

Definition at line 77 of file KIM_FunctionTypes.h.

◆ KIM_TimeUnit

typedef struct KIM_TimeUnit KIM_TimeUnit

Forward declaration.

Since
2.0

Definition at line 87 of file KIM_FunctionTypes.h.