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 | Functions/Subroutines | Variables
kim_collections_module Module Reference

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

Data Types

interface  kim_cache_list_of_directory_names
 Cache a list of directory names where a specific KIM API collection stores library files for a specific item type. More...
 
interface  kim_cache_list_of_item_metadata_files
 Cache a list of an item's metadata files. More...
 
interface  kim_cache_list_of_item_metadata_files_by_collection_and_type
 KIM::Collections::CacheListOfItemMetadataFilesByCollectionAndType More...
 
interface  kim_cache_list_of_item_names_by_collection_and_type
 Cache a list of all item names of a specific type in a specific collection. More...
 
interface  kim_cache_list_of_item_names_by_type
 Cache a list of all item names of a specific type in the KIM API collections. More...
 
type  kim_collections_handle_type
 Provides the interface to the KIM API Collections and is meant to be used by simulators. More...
 
interface  kim_get_configuration_file_environment_variable
 Get the name and value of the environment variable that stores the name of the KIM API user configuration file. More...
 
interface  kim_get_configuration_file_name
 Get the absolute file and path name of the KIM API user configuration file. More...
 
interface  kim_get_directory_name
 Get the name of a directory from the cached list. More...
 
interface  kim_get_environment_variable_name
 Get the names of environment variables that store configuration settings for the KIM::COLLECTION::environmentVariable collection. More...
 
interface  kim_get_item_library_file_name_and_collection
 Get the item's library file name and its KIM::Collection. More...
 
interface  kim_get_item_library_file_name_by_collection_and_type
 KIM::Collections::GetItemLibraryFileNameByCollectionAndType More...
 
interface  kim_get_item_metadata_file_length
 Get item metadata file length and determine if the file is available as a string. More...
 
interface  kim_get_item_metadata_file_length_by_collection_and_type
 Get item metadata file length and determine if the file is available as a string. More...
 
interface  kim_get_item_metadata_file_values
 Get the item's metadata file values. More...
 
interface  kim_get_item_metadata_file_values_by_collection_and_type
 Get the item's metadata file values. More...
 
interface  kim_get_item_name_by_collection_and_type
 Get the name of an item from the cached list. More...
 
interface  kim_get_item_name_by_type
 Get the name of an item from the cached list. More...
 
interface  kim_get_item_type
 Get the KIM::CollectionItemType of the item in the KIM API collections with a specific name. More...
 
interface  kim_get_project_name_and_sem_ver
 Get the KIM API project name and full Semantic Version string. More...
 
interface  kim_pop_log_verbosity
 Pop a LogVerbosity from the Collections object's Log object verbosity stack. More...
 
interface  kim_push_log_verbosity
 Push a new LogVerbosity onto the Collections object's Log object verbosity stack. More...
 
interface  kim_set_log_id
 Set the identity of the Log object associated with the Collections object. More...
 
interface  operator(.eq.)
 Compares kim_collections_handle_type's for equality. More...
 
interface  operator(.ne.)
 Compares kim_collections_handle_type's for inequality. More...
 

Functions/Subroutines

recursive subroutine, public kim_collections_create (collections_handle, ierr)
 Create a new KIM API Collections object.
 
recursive subroutine, public kim_collections_destroy (collections_handle)
 Destroy a previously Collections::Create'd object.
 

Variables

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

Detailed Description

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

See also
KIM::Collections, KIM_Collections
Since
2.1

Function/Subroutine Documentation

◆ kim_collections_create()

recursive subroutine, public kim_collections_module::kim_collections_create ( type(kim_collections_handle_type), intent(out)  collections_handle,
integer(c_int), intent(out)  ierr 
)

Create a new KIM API Collections object.

See also
KIM::Collections::Create, KIM_Collections_Create
Since
2.1

Definition at line 357 of file kim_collections_module.f90.

◆ kim_collections_destroy()

recursive subroutine, public kim_collections_module::kim_collections_destroy ( type(kim_collections_handle_type), intent(inout)  collections_handle)

Destroy a previously Collections::Create'd object.

See also
KIM::Collections::Destroy, KIM_Collections_Destroy
Since
2.1

Definition at line 381 of file kim_collections_module.f90.

Variable Documentation

◆ kim_collections_null_handle

type(kim_collections_handle_type), save, public, protected kim_collections_module::kim_collections_null_handle

NULL handle for use in comparisons.

Since
2.1

Definition at line 85 of file kim_collections_module.f90.