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

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

Data Types

type  kim_collection_type
 An Extensible Enumeration for the Collection's supported by the KIM API. More...
 
interface  kim_from_string
 Create a Collection object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More...
 
interface  kim_known
 Determines if the object is a quantity known to the KIM API. More...
 
interface  kim_to_string
 Converts the object to a string. 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, bind(C, name="KIM_COLLECTION_system"), public, protected kim_collection_system
 The standard system Collection. More...
 
type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_user"), public, protected kim_collection_user
 The standard user Collection. More...
 
type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_environmentVariable"), public, protected kim_collection_environment_variable
 The standard environmentVariable Collection. More...
 
type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_currentWorkingDirectory"), public, protected kim_collection_current_working_directory
 The standard currentWorkingDirectory Collection. More...
 

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 279 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 259 of file kim_collection_module.f90.

Variable Documentation

◆ kim_collection_current_working_directory

type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_currentWorkingDirectory"), public, protected kim_collection_module::kim_collection_current_working_directory

The standard currentWorkingDirectory Collection.

See also
KIM::COLLECTION::currentWorkingDirectory, KIM_COLLECTION_currentWorkingDirectory
Since
2.1

Definition at line 105 of file kim_collection_module.f90.

◆ kim_collection_environment_variable

type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_environmentVariable"), public, protected kim_collection_module::kim_collection_environment_variable

The standard environmentVariable Collection.

See also
KIM::COLLECTION::environmentVariable, KIM_COLLECTION_environmentVariable
Since
2.1

Definition at line 95 of file kim_collection_module.f90.

◆ kim_collection_system

type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_system"), public, protected kim_collection_module::kim_collection_system

The standard system Collection.

See also
KIM::COLLECTION::system, KIM_COLLECTION_system
Since
2.1

Definition at line 76 of file kim_collection_module.f90.

◆ kim_collection_user

type(kim_collection_type), save, bind(C, name="KIM_COLLECTION_user"), public, protected kim_collection_module::kim_collection_user

The standard user Collection.

See also
KIM::COLLECTION::user, KIM_COLLECTION_user
Since
2.1

Definition at line 85 of file kim_collection_module.f90.