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_compute_arguments_create_module Module Reference

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

Functions/Subroutines

recursive subroutine kim_model_compute_arguments_create_set_callback_support_status (model_commpute_arguments_create_handle, compute_callback_name, support_status, ierr)
 Set the SupportStatus of a ComputeCallbackName. More...
 
recursive subroutine kim_model_compute_arguments_create_set_model_buffer_pointer (model_commpute_arguments_create_handle, ptr)
 Set the Model's buffer pointer within the ComputeArguments object. More...
 
recursive subroutine kim_model_compute_arguments_create_log_entry (model_commpute_arguments_create_handle, log_verbosity, message)
 Write a log entry into the log file. More...
 
recursive subroutine kim_model_compute_arguments_create_to_string (model_commpute_arguments_create_handle, string)
 Get a string representing the internal state of the ComputeArguments object. More...
 

Variables

type(kim_model_compute_arguments_create_handle_type), save, public, protected kim_model_compute_arguments_create_null_handle
 NULL handle for use in comparisons. More...
 

Detailed Description

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

See also
KIM::ModelComputeArgumentsCreate, KIM_ModelComputeArgumentsCreate
Since
2.0

Function/Subroutine Documentation

◆ kim_model_compute_arguments_create_log_entry()

recursive subroutine kim_model_compute_arguments_create_module::kim_model_compute_arguments_create_log_entry ( type(kim_model_compute_arguments_create_handle_type), intent(in)  model_commpute_arguments_create_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::ModelComputeArgumentsCreate::LogEntry, KIM_ModelComputeArgumentsCreate_LogEntry
Since
2.0

Definition at line 325 of file kim_model_compute_arguments_create_module.f90.

◆ kim_model_compute_arguments_create_set_callback_support_status()

recursive subroutine kim_model_compute_arguments_create_module::kim_model_compute_arguments_create_set_callback_support_status ( type(kim_model_compute_arguments_create_handle_type), intent(in)  model_commpute_arguments_create_handle,
type(kim_compute_callback_name_type), intent(in)  compute_callback_name,
type(kim_support_status_type), intent(in)  support_status,
integer(c_int), intent(out)  ierr 
)

◆ kim_model_compute_arguments_create_set_model_buffer_pointer()

recursive subroutine kim_model_compute_arguments_create_module::kim_model_compute_arguments_create_set_model_buffer_pointer ( type(kim_model_compute_arguments_create_handle_type), intent(in)  model_commpute_arguments_create_handle,
type(c_ptr), intent(in)  ptr 
)

◆ kim_model_compute_arguments_create_to_string()

recursive subroutine kim_model_compute_arguments_create_module::kim_model_compute_arguments_create_to_string ( type(kim_model_compute_arguments_create_handle_type), intent(in)  model_commpute_arguments_create_handle,
character(len=*, kind=c_char), intent(out)  string 
)

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

See also
KIM::ModelComputeArgumentsCreate::ToString, KIM_ModelComputeArgumentsCreate_ToString
Since
2.0

Definition at line 367 of file kim_model_compute_arguments_create_module.f90.

Variable Documentation

◆ kim_model_compute_arguments_create_null_handle

type(kim_model_compute_arguments_create_handle_type), save, public, protected kim_model_compute_arguments_create_module::kim_model_compute_arguments_create_null_handle

NULL handle for use in comparisons.

Since
2.0

Definition at line 75 of file kim_model_compute_arguments_create_module.f90.