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

An Extensible Enumeration for the Collection's supported by the KIM API. More...

Functions/Subroutines

recursive subroutine, public kim_get_number_of_collections (number_of_collections)
 Get the number of standard Collection's defined by the KIM API. More...
 
recursive subroutine, public kim_get_collection (index, collection, ierr)
 Get the identity of each defined standard Collection. More...
 

Variables

type(kim_collection_type), save, public, protected kim_collection_system
 
type(kim_collection_type), save, public, protected kim_collection_user
 
type(kim_collection_type), save, public, protected kim_collection_environment_variable
 
type(kim_collection_type), save, public, protected kim_collection_current_working_directory
 

Detailed Description

An Extensible Enumeration for the Collection's supported by the KIM API.

See also
KIM::Collection, KIM_Collection
Since
2.1

Function/Subroutine Documentation

◆ kim_get_collection()

recursive subroutine, public kim_collection_module::kim_get_collection ( integer(c_int), intent(in)  index,
type(kim_collection_type), intent(out)  collection,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard Collection.

See also
KIM::COLLECTION::GetCollection, KIM_COLLECTION_GetCollection
Since
2.1

Definition at line 287 of file kim_collection_module.f90.

◆ kim_get_number_of_collections()

recursive subroutine, public kim_collection_module::kim_get_number_of_collections ( integer(c_int), intent(out)  number_of_collections)

Get the number of standard Collection's defined by the KIM API.

See also
KIM::COLLECTION::GetNumberOfCollections, KIM_COLLECTION_GetNumberOfCollections
Since
2.1

Definition at line 267 of file kim_collection_module.f90.

Variable Documentation

◆ kim_collection_current_working_directory

type(kim_collection_type), save, public, protected kim_collection_module::kim_collection_current_working_directory

Definition at line 112 of file kim_collection_module.f90.

◆ kim_collection_environment_variable

type(kim_collection_type), save, public, protected kim_collection_module::kim_collection_environment_variable

Definition at line 102 of file kim_collection_module.f90.

◆ kim_collection_system

type(kim_collection_type), save, public, protected kim_collection_module::kim_collection_system

Definition at line 83 of file kim_collection_module.f90.

◆ kim_collection_user

type(kim_collection_type), save, public, protected kim_collection_module::kim_collection_user

Definition at line 92 of file kim_collection_module.f90.