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 | Modules | Functions/Subroutines | Variables
kim_compute_arguments_module.f90 File Reference

Go to the source code of this file.

Modules

module  kim_compute_arguments_module
 Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators.
 

Functions/Subroutines

recursive subroutine kim_compute_arguments_module::kim_compute_arguments_get_callback_support_status (compute_arguments_handle, compute_callback_name, support_status, ierr)
 Get the SupportStatus of a ComputeCallbackName. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_argument_pointer_int0 (compute_arguments_handle, compute_argument_name, int0, ierr)
 Set the data pointer for a ComputeArgumentName. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_argument_pointer_int1 (compute_arguments_handle, compute_argument_name, int1, ierr)
 Set the data pointer for a ComputeArgumentName. More...
 
recursive subroutine set (compute_arguments, compute_argument_name, extent1, int1, ierr)
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_argument_pointer_int2 (compute_arguments_handle, compute_argument_name, int2, ierr)
 Set the data pointer for a ComputeArgumentName. More...
 
recursive subroutine set (compute_arguments, compute_argument_name, extent1, extent2, int2, ierr)
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_argument_pointer_double0 (compute_arguments_handle, compute_argument_name, double0, ierr)
 Set the data pointer for a ComputeArgumentName. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_argument_pointer_double1 (compute_arguments_handle, compute_argument_name, double1, ierr)
 Set the data pointer for a ComputeArgumentName. More...
 
recursive subroutine set (compute_arguments, compute_argument_name, extent1, double1, ierr)
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_argument_pointer_double2 (compute_arguments_handle, compute_argument_name, double2, ierr)
 Set the data pointer for a ComputeArgumentName. More...
 
recursive subroutine set (compute_arguments, compute_argument_name, extent1, extent2, double2, ierr)
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_callback_pointer (compute_arguments_handle, compute_callback_name, language_name, fptr, data_object, ierr)
 Set the function pointer for a ComputeCallbackName. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_are_all_required_present (compute_arguments_handle, result_value, ierr)
 Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's with SupportStatus values of SUPPORT_STATUS::requiredByAPI or SUPPORT_STATUS::required. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_simulator_buffer_pointer (compute_arguments_handle, ptr)
 Set the Simulator's buffer pointer within the ComputeArguments object. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_get_simulator_buffer_pointer (compute_arguments_handle, ptr)
 Get the Simulator's buffer pointer from the ComputeArguments object. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_to_string (compute_arguments_handle, string)
 Get a string representing the internal state of the ComputeArguments object. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_set_log_id (compute_arguments_handle, log_id)
 Set the identity of the Log object associated with the ComputeArguments object. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_push_log_verbosity (compute_arguments_handle, log_verbosity)
 Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack. More...
 
recursive subroutine kim_compute_arguments_module::kim_compute_arguments_pop_log_verbosity (compute_arguments_handle)
 Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack. More...
 

Variables

type(kim_compute_arguments_handle_type), save, public, protected kim_compute_arguments_module::kim_compute_arguments_null_handle
 NULL handle for use in comparisons. More...
 

Function/Subroutine Documentation

◆ set() [1/4]

recursive subroutine kim_compute_arguments_set_argument_pointer_int1::set ( type(kim_compute_arguments_type), intent(in)  compute_arguments,
type(kim_compute_argument_name_type), intent(in)  compute_argument_name,
integer(c_int), intent(in)  extent1,
integer(c_int), dimension(extent1), intent(in), target  int1,
integer(c_int), intent(out)  ierr 
)

Definition at line 387 of file kim_compute_arguments_module.f90.

◆ set() [2/4]

recursive subroutine kim_compute_arguments_set_argument_pointer_int2::set ( type(kim_compute_arguments_type), intent(in)  compute_arguments,
type(kim_compute_argument_name_type), intent(in)  compute_argument_name,
integer(c_int), intent(in)  extent1,
integer(c_int), intent(in)  extent2,
integer(c_int), dimension(extent1,extent2), intent(in), target  int2,
integer(c_int), intent(out)  ierr 
)

Definition at line 445 of file kim_compute_arguments_module.f90.

◆ set() [3/4]

recursive subroutine kim_compute_arguments_set_argument_pointer_double1::set ( type(kim_compute_arguments_type), intent(in)  compute_arguments,
type(kim_compute_argument_name_type), intent(in)  compute_argument_name,
integer(c_int), intent(in)  extent1,
real(c_double), dimension(extent1), intent(in), target  double1,
integer(c_int), intent(out)  ierr 
)

Definition at line 543 of file kim_compute_arguments_module.f90.

◆ set() [4/4]

recursive subroutine kim_compute_arguments_set_argument_pointer_double2::set ( type(kim_compute_arguments_type), intent(in)  compute_arguments,
type(kim_compute_argument_name_type), intent(in)  compute_argument_name,
integer(c_int), intent(in)  extent1,
integer(c_int), intent(in)  extent2,
real(c_double), dimension(extent1,extent2), intent(in), target  double2,
integer(c_int), intent(out)  ierr 
)

Definition at line 601 of file kim_compute_arguments_module.f90.