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_collections_module.f90 File Reference

Go to the source code of this file.

Modules

module  kim_collections_module
 Provides the interface to the KIM API Collections and is meant to be used by simulators.
 

Functions/Subroutines

recursive subroutine, public kim_collections_module::kim_collections_create (collections_handle, ierr)
 Create a new KIM API Collections object. More...
 
recursive subroutine, public kim_collections_module::kim_collections_destroy (collections_handle)
 Destroy a previously Collections::Create'd object. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_library_file_name_and_collection (collections_handle, item_type, item_name, file_name, collection, ierr)
 Get the item's library file name and its KIM::Collection. More...
 
recursive subroutine kim_collections_module::kim_collections_cache_list_of_item_metadata_files (collections_handle, item_type, item_name, extent, ierr)
 Cache a list of an item's metadata files. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_metadata_file_length (collections_handle, index, file_length, available_as_string, ierr)
 Get item metadata file length and determine if the file is available as a string. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_metadata_file_values (collections_handle, index, file_name, file_raw_data, file_string, ierr)
 Get the item's metadata file values. More...
 
recursive subroutine kim_collections_module::kim_collections_cache_list_of_item_names_by_type (collections_handle, item_type, extent, ierr)
 Cache a list of all item names of a specific type in the KIM API collections. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_name_by_type (collections_handle, index, item_name, ierr)
 Get the name of an item from the cached list. More...
 
recursive subroutine kim_collections_module::kim_collections_cache_list_of_item_names_by_collection_and_type (collections_handle, collection, item_type, extent, ierr)
 Cache a list of all item names of a specific type in a specific collection. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_name_by_collection_and_type (collections_handle, index, item_name, ierr)
 Get the name of an item from the cached list. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_library_file_name_by_coll_and_type (collections_handle, collection, item_type, item_name, file_name, ierr)
 Get the item's library file name. More...
 
recursive subroutine kim_collections_module::kim_colls_cache_list_of_item_metadata_files_by_coll_and_type (collections_handle, collection, item_type, item_name, extent, ierr)
 Cache a list of an item's metadata files. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_metadata_file_length_by_coll_and_type (collections_handle, index, file_length, available_as_string, ierr)
 Get the name and content of one of an item's metadata files. More...
 
recursive subroutine kim_collections_module::kim_collections_get_item_metadata_file_values_by_coll_and_type (collections_handle, index, file_name, file_raw_data, file_string, ierr)
 Get the item's metadata file values. More...
 
recursive subroutine kim_collections_module::kim_collections_get_project_name_and_sem_ver (collections_handle, project_name, sem_ver)
 Get the KIM API project name and full Semantic Version string. More...
 
recursive subroutine kim_collections_module::kim_collections_get_environment_variable_name (collections_handle, item_type, name, ierr)
 Get the names of environment variables that store configuration settings for the KIM::COLLECTION::environmentVariable collection. More...
 
recursive subroutine kim_collections_module::kim_collections_get_configuration_file_environment_variable (collections_handle, name, value)
 Get the name and value of the environment variable that stores the name of the KIM API user configuration file. More...
 
recursive subroutine kim_collections_module::kim_collections_get_configuration_file_name (collections_handle, file_name)
 Get the absolute file and path name of the KIM API user configuration file. More...
 
recursive subroutine kim_collections_module::kim_collections_cache_list_of_directory_names (collections_handle, collection, item_type, extent, ierr)
 Cache a list of directory names where a specific KIM API collection stores library files for a specific item type. More...
 
recursive subroutine kim_collections_module::kim_collections_get_directory_name (collections_handle, index, directory_name, ierr)
 Get the name of a directory from the cached list. More...
 
recursive subroutine kim_collections_module::kim_collections_set_log_id (collections_handle, log_id)
 Set the identity of the Log object associated with the Collections object. More...
 
recursive subroutine kim_collections_module::kim_collections_push_log_verbosity (collections_handle, log_verbosity)
 Push a new LogVerbosity onto the Collections object's Log object verbosity stack. More...
 
recursive subroutine kim_collections_module::kim_collections_pop_log_verbosity (collections_handle)
 Pop a LogVerbosity from the Collections object's Log object verbosity stack. More...
 

Variables

type(kim_collections_handle_type), save, public, protected kim_collections_module::kim_collections_null_handle
 NULL handle for use in comparisons. More...