kim-api 2.4.1+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
 
Loading...
Searching...
No Matches
KIM_ModelExtension.h File Reference

Go to the source code of this file.

Functions

void KIM_ModelExtension_GetExtensionID (KIM_ModelExtension const *const modelExtension, char const **const extensionID)
 Get the extension identification string.
 
KIM_ModelKIM_ModelExtension_ToModel (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a Model interface.
 
KIM_ModelComputeKIM_ModelExtension_ToModelCompute (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a ModelCompute interface.
 
KIM_ModelCreateKIM_ModelExtension_ToModelCreate (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a ModelCreate interface.
 
KIM_ModelDestroyKIM_ModelExtension_ToModelDestroy (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a ModelDestroy interface.
 
KIM_ModelDriverCreateKIM_ModelExtension_ToModelDriverCreate (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface.
 
KIM_ModelRefreshKIM_ModelExtension_ToModelRefresh (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a ModelRefresh interface.
 
KIM_ModelWriteParameterizedModelKIM_ModelExtension_ToModelWriteParameterizedModel (KIM_ModelExtension *const modelExtension)
 Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface.
 
KIM_ModelComputeArgumentsKIM_ModelExtension_ToModelComputeArguments (KIM_ModelExtension const *const modelExtension, KIM_ComputeArguments *const computeArguments)
 Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface.
 
KIM_ModelComputeArgumentsCreateKIM_ModelExtension_ToModelComputeArgumentsCreate (KIM_ModelExtension const *const modelExtension, KIM_ComputeArguments *const computeArguments)
 Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface.
 
KIM_ModelComputeArgumentsDestroyKIM_ModelExtension_ToModelComputeArgumentsDestroy (KIM_ModelExtension const *const modelExtension, KIM_ComputeArguments *const computeArguments)
 Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface.
 
void KIM_ModelExtension_GetModelBufferPointer (KIM_ModelExtension const *const modelCompute, void **const ptr)
 Get the Model's buffer pointer within the Model object.
 
void KIM_ModelExtension_LogEntry (KIM_ModelExtension const *const modelCompute, KIM_LogVerbosity const logVerbosity, char const *const message, int const lineNumber, char const *const fileName)
 Write a log entry into the log file.
 
char const * KIM_ModelExtension_ToString (KIM_ModelExtension const *const modelCompute)
 Get a string representing the internal state of the Model object.
 

Function Documentation

◆ KIM_ModelExtension_GetExtensionID()

void KIM_ModelExtension_GetExtensionID ( KIM_ModelExtension const *const modelExtension,
char const **const extensionID )

Get the extension identification string.

See also
KIM::ModelExtension::GetExtensionID, kim_model_extension_module::kim_get_extension_id
Since
2.0

◆ KIM_ModelExtension_GetModelBufferPointer()

void KIM_ModelExtension_GetModelBufferPointer ( KIM_ModelExtension const *const modelCompute,
void **const ptr )

◆ KIM_ModelExtension_LogEntry()

void KIM_ModelExtension_LogEntry ( KIM_ModelExtension const *const modelCompute,
KIM_LogVerbosity const logVerbosity,
char const *const message,
int const lineNumber,
char const *const fileName )

Write a log entry into the log file.

See also
KIM::ModelExtension::LogEntry, kim_model_extension_module::kim_log_entry
Since
2.0

◆ KIM_ModelExtension_ToModel()

KIM_Model * KIM_ModelExtension_ToModel ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a Model interface.

See also
KIM::ModelExtension::Model, kim_model_extension_module::kim_to_model
Since
2.0

◆ KIM_ModelExtension_ToModelCompute()

KIM_ModelCompute * KIM_ModelExtension_ToModelCompute ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a ModelCompute interface.

See also
KIM::ModelExtension::ModelCompute, kim_model_extension_module::kim_to_model_compute
Since
2.0

◆ KIM_ModelExtension_ToModelComputeArguments()

KIM_ModelComputeArguments * KIM_ModelExtension_ToModelComputeArguments ( KIM_ModelExtension const *const modelExtension,
KIM_ComputeArguments *const computeArguments )

Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface.

See also
KIM::ModelExtension::ModelComputeArguments, kim_model_extension_module::kim_to_model_compute_arguments
Since
2.0

◆ KIM_ModelExtension_ToModelComputeArgumentsCreate()

KIM_ModelComputeArgumentsCreate * KIM_ModelExtension_ToModelComputeArgumentsCreate ( KIM_ModelExtension const *const modelExtension,
KIM_ComputeArguments *const computeArguments )

Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface.

See also
KIM::ModelExtension::ModelComputeArgumentsCreate, kim_model_extension_module::kim_to_model_compute_arguments_create
Since
2.0

◆ KIM_ModelExtension_ToModelComputeArgumentsDestroy()

KIM_ModelComputeArgumentsDestroy * KIM_ModelExtension_ToModelComputeArgumentsDestroy ( KIM_ModelExtension const *const modelExtension,
KIM_ComputeArguments *const computeArguments )

Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface.

See also
KIM::ModelExtension::ModelComputeArgumentsDestroy, kim_model_extension_module::kim_to_model_compute_arguments_destroy
Since
2.0

◆ KIM_ModelExtension_ToModelCreate()

KIM_ModelCreate * KIM_ModelExtension_ToModelCreate ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a ModelCreate interface.

See also
KIM::ModelExtension::ModelCreate, kim_model_extension_module::kim_to_model_create
Since
2.0

◆ KIM_ModelExtension_ToModelDestroy()

KIM_ModelDestroy * KIM_ModelExtension_ToModelDestroy ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a ModelDestroy interface.

See also
KIM::ModelExtension::ModelDestroy, kim_model_extension_module::kim_to_model_destroy
Since
2.0

◆ KIM_ModelExtension_ToModelDriverCreate()

KIM_ModelDriverCreate * KIM_ModelExtension_ToModelDriverCreate ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface.

See also
KIM::ModelExtension::ModelDriverCreate, kim_model_extension_module::kim_to_model_driver_create
Since
2.0

◆ KIM_ModelExtension_ToModelRefresh()

KIM_ModelRefresh * KIM_ModelExtension_ToModelRefresh ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a ModelRefresh interface.

See also
KIM::ModelExtension::ModelRefresh, kim_model_extension_module::kim_to_model_refresh
Since
2.0

◆ KIM_ModelExtension_ToModelWriteParameterizedModel()

KIM_ModelWriteParameterizedModel * KIM_ModelExtension_ToModelWriteParameterizedModel ( KIM_ModelExtension *const modelExtension)

Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface.

See also
KIM::ModelExtension::ModelWriteParameterizedModel, kim_model_extension_module::kim_to_model_write_parameterized_model
Since
2.0

◆ KIM_ModelExtension_ToString()

char const * KIM_ModelExtension_ToString ( KIM_ModelExtension const *const modelCompute)

Get a string representing the internal state of the Model object.

See also
KIM::ModelExtension::ToString, kim_model_extension_module::kim_to_string
Since
2.0