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).
Data Types | Functions/Subroutines | Variables
kim_model_refresh_module Module Reference

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

Functions/Subroutines

recursive subroutine kim_model_refresh_set_neighbor_list_pointers (model_refresh_handle, number_of_neighbor_lists, cutoffs, modelWillNotRequestNeighborsOfNoncontributingParticles)
 Set the Model's neighbor list data pointers. More...
 
recursive subroutine kim_model_refresh_get_model_buffer_pointer (model_refresh_handle, ptr)
 Get the Model's buffer pointer within the Model object. More...
 
recursive subroutine kim_model_refresh_log_entry (model_refresh_handle, log_verbosity, message)
 Write a log entry into the log file. More...
 
recursive subroutine kim_model_refresh_to_string (model_refresh_handle, string)
 Get a string representing the internal state of the Model object. More...
 

Variables

type(kim_model_refresh_handle_type), save, public, protected kim_model_refresh_null_handle
 NULL handle for use in comparisons. More...
 

Detailed Description

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_ModelRefresh
Since
2.0

Function/Subroutine Documentation

◆ kim_model_refresh_get_model_buffer_pointer()

recursive subroutine kim_model_refresh_module::kim_model_refresh_get_model_buffer_pointer ( type(kim_model_refresh_handle_type), intent(in)  model_refresh_handle,
type(c_ptr), intent(out)  ptr 
)

◆ kim_model_refresh_log_entry()

recursive subroutine kim_model_refresh_module::kim_model_refresh_log_entry ( type(kim_model_refresh_handle_type), intent(in)  model_refresh_handle,
type(kim_log_verbosity_type), intent(in)  log_verbosity,
character(len=*, kind=c_char), intent(in)  message 
)

Write a log entry into the log file.

See also
KIM::ModelRefresh::LogEntry, KIM_ModelRefresh_LogEntry
Since
2.0

Definition at line 273 of file kim_model_refresh_module.f90.

◆ kim_model_refresh_set_neighbor_list_pointers()

recursive subroutine kim_model_refresh_module::kim_model_refresh_set_neighbor_list_pointers ( type(kim_model_refresh_handle_type), intent(in)  model_refresh_handle,
integer(c_int), intent(in)  number_of_neighbor_lists,
real(c_double), dimension(number_of_neighbor_lists), intent(in), target  cutoffs,
integer(c_int), dimension( number_of_neighbor_lists), intent(in), target  modelWillNotRequestNeighborsOfNoncontributingParticles 
)

Set the Model's neighbor list data pointers.

See also
KIM::ModelRefresh::SetNeighborListPointers, KIM_ModelRefresh_SetNeighborListPointers
Since
2.0

Definition at line 205 of file kim_model_refresh_module.f90.

◆ kim_model_refresh_to_string()

recursive subroutine kim_model_refresh_module::kim_model_refresh_to_string ( type(kim_model_refresh_handle_type), intent(in)  model_refresh_handle,
character(len=*, kind=c_char), intent(out)  string 
)

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

See also
KIM::ModelRefresh::ToString, KIM_ModelRefresh_ToString
Since
2.0

Definition at line 307 of file kim_model_refresh_module.f90.

Variable Documentation

◆ kim_model_refresh_null_handle

type(kim_model_refresh_handle_type), save, public, protected kim_model_refresh_module::kim_model_refresh_null_handle

NULL handle for use in comparisons.

Since
2.0

Definition at line 73 of file kim_model_refresh_module.f90.