kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
Data Types | Modules | Functions/Subroutines | Variables
kim_model_driver_create_module.f90 File Reference

Go to the source code of this file.

Data Types

type  kim_model_driver_create_module::kim_model_driver_create_handle_type
 Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Create routine. More...
 
interface  kim_model_driver_create_module::kim_get_parameter_file_directory_name
 Get absolute path name of the temporary directory where parameter files provided by the model are written. More...
 
interface  kim_model_driver_create_module::kim_get_number_of_parameter_files
 Get the number of parameter files provided by the parameterized model. More...
 
interface  kim_model_driver_create_module::kim_get_parameter_file_name
 Get a particular parameter file name. More...
 
interface  kim_model_driver_create_module::kim_get_parameter_file_basename
 Get a particular parameter file basename. The file is located in the Model's parameter file directory. More...
 
interface  kim_model_driver_create_module::kim_set_model_numbering
 Set the Model's particle Numbering. More...
 
interface  kim_model_driver_create_module::kim_set_influence_distance_pointer
 Set the Model's influence distance data pointer. More...
 
interface  kim_model_driver_create_module::kim_set_neighbor_list_pointers
 Set the Model's neighbor list data pointers. More...
 
interface  kim_model_driver_create_module::kim_set_routine_pointer
 Set the function pointer for the ModelRoutineName of interest. More...
 
interface  kim_model_driver_create_module::kim_set_species_code
 Set integer code for supported SpeciesName. More...
 
interface  kim_model_driver_create_module::kim_set_parameter_pointer
 Set the next parameter data pointer to be provided by the model. More...
 
interface  kim_model_driver_create_module::kim_set_model_buffer_pointer
 Set the Model's buffer pointer within the Model object. More...
 
interface  kim_model_driver_create_module::kim_set_units
 Set the Model's base unit values. More...
 
interface  kim_model_driver_create_module::kim_convert_unit
 Get the multiplicative factor to convert between a derived unit represented in two different sets of base units. More...
 
interface  kim_model_driver_create_module::kim_log_entry
 Write a log entry into the log file. More...
 
interface  kim_model_driver_create_module::kim_to_string
 Get a string representing the internal state of the Model object. More...
 
interface  get_parameter_file_directory_name
 
interface  get_number_of_parameter_files
 
interface  get_parameter_file_name
 
interface  get_parameter_file_basename
 
interface  set_model_numbering
 
interface  set_influence_distance_pointer
 
interface  set_neighbor_list_pointers
 
interface  set_routine_pointer
 
interface  set_species_code
 
interface  set_parameter_pointer_integer
 
interface  set_model_buffer_pointer
 
interface  set_units
 
interface  convert_unit
 
interface  log_entry
 
interface  model_driver_create_string
 

Modules

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

Functions/Subroutines

recursive subroutine kim_model_driver_create_module::kim_model_driver_create_get_number_of_parameter_files (model_driver_create_handle, number_of_parameter_files)
 Get the number of parameter files provided by the parameterized model. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_get_parameter_file_name (model_driver_create_handle, index, parameter_file_name, ierr)
 Get a particular parameter file name. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_get_parameter_file_basename (model_driver_create_handle, index, parameter_file_basename, ierr)
 Get a particular parameter file basename. The file is located in the Model's parameter file directory. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_model_numbering (model_driver_create_handle, numbering, ierr)
 Set the Model's particle Numbering. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_influence_distance_pointer (model_driver_create_handle, influence_distance)
 Set the Model's influence distance data pointer. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_neighbor_list_pointers (model_driver_create_handle, number_of_neighbor_lists, cutoffs, model_will_not_request_neighbors_of_noncontributing_particles)
 Set the Model's neighbor list data pointers. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_routine_pointer (model_driver_create_handle, model_routine_name, language_name, required, fptr, ierr)
 Set the function pointer for the ModelRoutineName of interest. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_species_code (model_driver_create_handle, species_name, code, ierr)
 Set integer code for supported SpeciesName. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_parameter_pointer_integer (model_driver_create_handle, int1, name, description, ierr)
 Set the next parameter data pointer to be provided by the model. More...
 
recursive subroutine set_parameter (model_driver_create, extent, int1, name, description, ierr)
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_parameter_pointer_double (model_driver_create_handle, double1, name, description, ierr)
 Set the next parameter data pointer to be provided by the model. More...
 
recursive subroutine set_parameter (model_driver_create, extent, double1, name, description, ierr)
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_model_buffer_pointer (model_driver_create_handle, ptr)
 Set the Model's buffer pointer within the Model object. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_set_units (model_driver_create_handle, length_unit, energy_unit, charge_unit, temperature_unit, time_unit, ierr)
 Set the Model's base unit values. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_convert_unit (from_length_unit, from_energy_unit, from_charge_unit, from_temperature_unit, from_time_unit, to_length_unit, to_energy_unit, to_charge_unit, to_temperature_unit, to_time_unit, length_exponent, energy_exponent, charge_exponent, temperature_exponent, time_exponent, conversion_factor, ierr)
 Get the multiplicative factor to convert between a derived unit represented in two different sets of base units. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_log_entry (model_driver_create_handle, log_verbosity, message)
 Write a log entry into the log file. More...
 
recursive subroutine kim_model_driver_create_module::kim_model_driver_create_to_string (model_driver_create_handle, string)
 Get a string representing the internal state of the Model object. More...
 

Variables

type(kim_model_driver_create_handle_type), save, public, protected kim_model_driver_create_module::kim_model_driver_create_null_handle
 NULL handle for use in comparisons. More...
 

Function/Subroutine Documentation

◆ set_parameter() [1/2]

recursive subroutine kim_model_driver_create_set_parameter_pointer_double::set_parameter ( type(kim_model_driver_create_type), intent(in)  model_driver_create,
integer(c_int), intent(in)  extent,
real(c_double), dimension(extent), intent(in), target  double1,
character(len=*, kind=c_char), intent(in)  name,
character(len=*, kind=c_char), intent(in)  description,
integer(c_int), intent(out)  ierr 
)

Definition at line 693 of file kim_model_driver_create_module.f90.

◆ set_parameter() [2/2]

recursive subroutine kim_model_driver_create_set_parameter_pointer_integer::set_parameter ( type(kim_model_driver_create_type), intent(in)  model_driver_create,
integer(c_int), intent(in)  extent,
integer(c_int), dimension(extent), intent(in), target  int1,
character(len=*, kind=c_char), intent(in)  name,
character(len=*, kind=c_char), intent(in)  description,
integer(c_int), intent(out)  ierr 
)

Definition at line 633 of file kim_model_driver_create_module.f90.