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).
Typedefs | Functions
KIM_ModelRefresh.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_ModelRefresh KIM_ModelRefresh
 Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Refresh routine. More...
 

Functions

void KIM_ModelRefresh_SetInfluenceDistancePointer (KIM_ModelRefresh *const modelRefresh, double const *const influenceDistance)
 Set the Model's influence distance data pointer. More...
 
void KIM_ModelRefresh_SetNeighborListPointers (KIM_ModelRefresh *const modelRefresh, int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)
 Set the Model's neighbor list data pointers. More...
 
void KIM_ModelRefresh_GetModelBufferPointer (KIM_ModelRefresh const *const modelRefresh, void **const ptr)
 Get the Model's buffer pointer within the Model object. More...
 
void KIM_ModelRefresh_LogEntry (KIM_ModelRefresh const *const modelRefresh, 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_ModelRefresh_ToString (KIM_ModelRefresh const *const modelRefresh)
 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_ModelRefresh.h.

◆ KIM_ModelRefresh

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

See also
KIM::ModelRefresh, kim_model_refresh_module::kim_model_refresh_handle_type
Since
2.0

Definition at line 61 of file KIM_ModelRefresh.h.

Function Documentation

◆ KIM_ModelRefresh_GetModelBufferPointer()

void KIM_ModelRefresh_GetModelBufferPointer ( KIM_ModelRefresh const *const  modelRefresh,
void **const  ptr 
)

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

See also
KIM::ModelRefresh::GetModelBufferPointer, kim_model_refresh_module::kim_get_model_buffer_pointer
Since
2.0

◆ KIM_ModelRefresh_LogEntry()

void KIM_ModelRefresh_LogEntry ( KIM_ModelRefresh const *const  modelRefresh,
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::ModelRefresh::LogEntry, kim_model_refresh_module::kim_log_entry
Since
2.0

◆ KIM_ModelRefresh_SetInfluenceDistancePointer()

void KIM_ModelRefresh_SetInfluenceDistancePointer ( KIM_ModelRefresh *const  modelRefresh,
double const *const  influenceDistance 
)

Set the Model's influence distance data pointer.

See also
KIM::ModelRefresh::SetInfluenceDistancePointer, kim_model_refresh_module::kim_set_influence_distance_pointer
Since
2.0

◆ KIM_ModelRefresh_SetNeighborListPointers()

void KIM_ModelRefresh_SetNeighborListPointers ( KIM_ModelRefresh *const  modelRefresh,
int const  numberOfNeighborLists,
double const *const  cutoffs,
int const *const  modelWillNotRequestNeighborsOfNoncontributingParticles 
)

Set the Model's neighbor list data pointers.

See also
KIM::ModelRefresh::SetNeighborListPointers, kim_model_refresh_module::kim_set_neighbor_list_pointers
Since
2.0

◆ KIM_ModelRefresh_ToString()

char const* KIM_ModelRefresh_ToString ( KIM_ModelRefresh const *const  modelRefresh)

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

See also
KIM::ModelRefresh::ToString, kim_model_refresh_module::kim_to_string
Since
2.0