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 | Functions
KIM_ModelCompute.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_LogVerbosity KIM_LogVerbosity
 Forward declaration. More...
 
typedef struct KIM_ModelCompute KIM_ModelCompute
 Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Compute routine. More...
 

Functions

void KIM_ModelCompute_GetModelBufferPointer (KIM_ModelCompute const *const modelCompute, void **const ptr)
 Get the Model's buffer pointer within the Model object. More...
 
void KIM_ModelCompute_LogEntry (KIM_ModelCompute 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. More...
 
char const * KIM_ModelCompute_ToString (KIM_ModelCompute const *const modelCompute)
 Get a string representing the internal state of the Model object. More...
 

Typedef Documentation

◆ KIM_LogVerbosity

Forward declaration.

Since
2.0

Definition at line 47 of file KIM_ModelCompute.h.

◆ KIM_ModelCompute

Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Compute routine.

See also
KIM::ModelCompute, kim_model_compute_module::kim_model_compute_handle_type
Since
2.0

Definition at line 61 of file KIM_ModelCompute.h.

Function Documentation

◆ KIM_ModelCompute_GetModelBufferPointer()

void KIM_ModelCompute_GetModelBufferPointer ( KIM_ModelCompute const *const  modelCompute,
void **const  ptr 
)

Get the Model's buffer pointer within the Model object.

See also
KIM::ModelCompute::GetModelBufferPointer, kim_model_compute_module::kim_get_model_buffer_pointer
Since
2.0

◆ KIM_ModelCompute_LogEntry()

void KIM_ModelCompute_LogEntry ( KIM_ModelCompute 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::ModelCompute::LogEntry, kim_model_compute_module::kim_log_entry
Since
2.0

◆ KIM_ModelCompute_ToString()

char const* KIM_ModelCompute_ToString ( KIM_ModelCompute const *const  modelCompute)

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

See also
KIM::ModelCompute::ToString, kim_model_compute_module::kim_to_string
Since
2.0