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

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

Functions/Subroutines

recursive subroutine kim_model_extension_to_model (model_extension_handle, model_handle)
 Convert the ModelExtension interface to the Model object to a Model interface. More...
 
recursive subroutine kim_model_extension_to_model_compute (model_extension_handle, model_compute_handle)
 Convert the ModelExtension interface to the Model object to a ModelCompute interface. More...
 
recursive subroutine kim_model_extension_to_model_create (model_extension_handle, model_create_handle)
 Convert the ModelExtension interface to the Model object to a ModelCompute interface. More...
 
recursive subroutine kim_model_extension_to_model_destroy (model_extension_handle, model_destroy_handle)
 Convert the ModelExtension interface to the Model object to a ModelDestroy interface. More...
 
recursive subroutine kim_model_extension_to_model_driver_create (model_extension_handle, model_driver_create_handle)
 Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface. More...
 
recursive subroutine kim_model_extension_to_model_refresh (model_extension_handle, model_refresh_handle)
 Convert the ModelExtension interface to the Model object to a ModelRefresh interface. More...
 
recursive subroutine kim_model_extension_to_model_write_parameterized_model (model_extension_handle, model_write_parameterized_model_handle)
 Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface. More...
 
recursive subroutine kim_model_extension_to_model_compute_arguments (model_extension_handle, compute_arguments_c_ptr, model_compute_arguments_handle)
 Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface. More...
 
recursive subroutine kim_model_extension_to_model_compute_arguments_create (model_extension_handle, compute_arguments_c_ptr, model_compute_arguments_create_handle)
 Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface. More...
 
recursive subroutine kim_model_extension_to_model_compute_arguments_destroy (model_extension_handle, compute_arguments_c_ptr, model_compute_arguments_destroy_handle)
 Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface. More...
 
recursive subroutine kim_model_extension_convert_c_char_array_to_string (c_char_array, string)
 Copy C character array to Fortran string. More...
 
recursive subroutine kim_model_extension_convert_c_char_ptr_to_string (c_char_ptr, string)
 Copy C character pointer to Fortran string. More...
 
recursive subroutine kim_model_extension_convert_string_to_c_char_array (string, c_char_array)
 Convert Fortran string to C character array. More...
 
recursive subroutine kim_model_extension_get_model_buffer_pointer (model_extension_handle, ptr)
 Get the Model's buffer pointer within the Model object. More...
 
recursive subroutine kim_model_extension_log_entry (model_extension_handle, log_verbosity, message)
 Write a log entry into the log file. More...
 
recursive subroutine kim_model_extension_to_string (model_extension_handle, string)
 Get a string representing the internal state of the Model object. More...
 

Variables

type(kim_model_extension_handle_type), save, public, protected kim_model_extension_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::Extension routine.

See also
KIM::ModelExtension, KIM_ModelExtension
Since
2.0

Function/Subroutine Documentation

◆ kim_model_extension_convert_c_char_array_to_string()

recursive subroutine kim_model_extension_module::kim_model_extension_convert_c_char_array_to_string ( character(len=1, kind=c_char), dimension(:), intent(in)  c_char_array,
character(len=*, kind=c_char), intent(out)  string 
)

Copy C character array to Fortran string.

Since
2.0

Definition at line 493 of file kim_model_extension_module.f90.

◆ kim_model_extension_convert_c_char_ptr_to_string()

recursive subroutine kim_model_extension_module::kim_model_extension_convert_c_char_ptr_to_string ( type(c_ptr), intent(in)  c_char_ptr,
character(len=*, kind=c_char), intent(out)  string 
)

Copy C character pointer to Fortran string.

Since
2.0

Definition at line 506 of file kim_model_extension_module.f90.

◆ kim_model_extension_convert_string_to_c_char_array()

recursive subroutine kim_model_extension_module::kim_model_extension_convert_string_to_c_char_array ( character(len=*, kind=c_char), intent(in)  string,
character(len=1, kind=c_char), dimension(:), intent(out)  c_char_array 
)

Convert Fortran string to C character array.

Since
2.0

Definition at line 519 of file kim_model_extension_module.f90.

◆ kim_model_extension_get_model_buffer_pointer()

recursive subroutine kim_model_extension_module::kim_model_extension_get_model_buffer_pointer ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(c_ptr), intent(out)  ptr 
)

◆ kim_model_extension_log_entry()

recursive subroutine kim_model_extension_module::kim_model_extension_log_entry ( type(kim_model_extension_handle_type), intent(in)  model_extension_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::ModelExtension::LogEntry, KIM_ModelExtension_LogEntry
Since
2.0

Definition at line 562 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_handle_type), intent(out)  model_handle 
)

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

See also
KIM::ModelExtension::Model, KIM_ModelExtension_ToModel
Since
2.0

Definition at line 320 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_compute()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_compute ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_compute_handle_type), intent(out)  model_compute_handle 
)

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

See also
KIM::ModelExtension::ModelCompute, KIM_ModelExtension_ToModelCompute
Since
2.0

Definition at line 335 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_compute_arguments()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_compute_arguments ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(c_ptr), intent(in)  compute_arguments_c_ptr,
type(kim_model_compute_arguments_handle_type), intent(out)  model_compute_arguments_handle 
)

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

See also
KIM::ModelExtension::ModelComputeArguments, KIM_ModelExtension_ToModelComputeArguments
Since
2.0

Definition at line 431 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_compute_arguments_create()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_compute_arguments_create ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(c_ptr), intent(in)  compute_arguments_c_ptr,
type(kim_model_compute_arguments_create_handle_type), intent(out)  model_compute_arguments_create_handle 
)

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

See also
KIM::ModelExtension::ModelComputeArgumentsCreate, KIM_ModelExtension_ToModelComputeArgumentsCreate
Since
2.0

Definition at line 453 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_compute_arguments_destroy()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_compute_arguments_destroy ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(c_ptr), intent(in)  compute_arguments_c_ptr,
type(kim_model_compute_arguments_destroy_handle_type), intent(out)  model_compute_arguments_destroy_handle 
)

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

See also
KIM::ModelExtension::ModelComputeArgumentsDestroy, KIM_ModelExtension_ToModelComputeArgumentsDestroy
Since
2.0

Definition at line 475 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_create()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_create ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_create_handle_type), intent(out)  model_create_handle 
)

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

See also
KIM::ModelExtension::ModelCompute, KIM_ModelExtension_ToModelCompute
Since
2.0

Definition at line 350 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_destroy()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_destroy ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_destroy_handle_type), intent(out)  model_destroy_handle 
)

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

See also
KIM::ModelExtension::ModelDestroy, KIM_ModelExtension_ToModelDestroy
Since
2.0

Definition at line 365 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_driver_create()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_driver_create ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_driver_create_handle_type), intent(out)  model_driver_create_handle 
)

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

See also
KIM::ModelExtension::ModelDriverCreate, KIM_ModelExtension_ToModelDriverCreate
Since
2.0

Definition at line 381 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_refresh()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_refresh ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_refresh_handle_type), intent(out)  model_refresh_handle 
)

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

See also
KIM::ModelExtension::ModelRefresh, KIM_ModelExtension_ToModelRefresh
Since
2.0

Definition at line 397 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_model_write_parameterized_model()

recursive subroutine kim_model_extension_module::kim_model_extension_to_model_write_parameterized_model ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
type(kim_model_write_parameterized_model_handle_type), intent(out)  model_write_parameterized_model_handle 
)

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

See also
KIM::ModelExtension::ModelWriteParameterizedModel, KIM_ModelExtension_ToModelWriteParameterizedModel
Since
2.0

Definition at line 413 of file kim_model_extension_module.f90.

◆ kim_model_extension_to_string()

recursive subroutine kim_model_extension_module::kim_model_extension_to_string ( type(kim_model_extension_handle_type), intent(in)  model_extension_handle,
character(len=*, kind=c_char), intent(out)  string 
)

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

See also
KIM::ModelExtension::ToString, KIM_ModelExtension_ToString
Since
2.0

Definition at line 596 of file kim_model_extension_module.f90.

Variable Documentation

◆ kim_model_extension_null_handle

type(kim_model_extension_handle_type), save, public, protected kim_model_extension_module::kim_model_extension_null_handle

NULL handle for use in comparisons.

Since
2.0

Definition at line 85 of file kim_model_extension_module.f90.