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

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

Data Types

interface  kim_from_string
 Create a SupportStatus 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...
 
type  kim_support_status_type
 An Extensible Enumeration for the SupportStatus's supported by the KIM API. More...
 
interface  kim_to_string
 Converts the object to a string. More...
 

Functions/Subroutines

recursive subroutine, public kim_get_number_of_support_statuses (number_of_support_statuses)
 Get the number of standard SupportStatus's defined by the KIM API. More...
 
recursive subroutine, public kim_get_support_status (index, support_status, ierr)
 Get the identity of each defined standard SupportStatus. More...
 

Variables

type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_requiredByAPI"), public, protected kim_support_status_required_by_api
 The standard requiredByAPI status. More...
 
type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_notSupported"), public, protected kim_support_status_not_supported
 The standard notSupported status. More...
 
type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_required"), public, protected kim_support_status_required
 The standard required status. More...
 
type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_optional"), public, protected kim_support_status_optional
 The standard optional status. More...
 

Detailed Description

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

See also
KIM::SupportStatus, KIM_SupportStatus
Since
2.0

Function/Subroutine Documentation

◆ kim_get_number_of_support_statuses()

recursive subroutine, public kim_support_status_module::kim_get_number_of_support_statuses ( integer(c_int), intent(out)  number_of_support_statuses)

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

See also
KIM::SUPPORT_STATUS::GetNumberOfSupportStatuses, KIM_SUPPORT_STATUS_GetNumberOfSupportStatuses
Since
2.0

Definition at line 258 of file kim_support_status_module.f90.

◆ kim_get_support_status()

recursive subroutine, public kim_support_status_module::kim_get_support_status ( integer(c_int), intent(in)  index,
type(kim_support_status_type), intent(out)  support_status,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard SupportStatus.

See also
KIM::SUPPORT_STATUS::GetSupportStatus, KIM_SUPPORT_STATUS_GetSupportStatus
Since
2.0

Definition at line 281 of file kim_support_status_module.f90.

Variable Documentation

◆ kim_support_status_not_supported

type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_notSupported"), public, protected kim_support_status_module::kim_support_status_not_supported

The standard notSupported status.

See also
KIM::SUPPORT_STATUS::notSupported, KIM_SUPPORT_STATUS_notSupported
Since
2.0

Definition at line 86 of file kim_support_status_module.f90.

◆ kim_support_status_optional

type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_optional"), public, protected kim_support_status_module::kim_support_status_optional

The standard optional status.

See also
KIM::SUPPORT_STATUS::optional, KIM_SUPPORT_STATUS_optional
Since
2.0

Definition at line 104 of file kim_support_status_module.f90.

◆ kim_support_status_required

type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_required"), public, protected kim_support_status_module::kim_support_status_required

The standard required status.

See also
KIM::SUPPORT_STATUS::required, KIM_SUPPORT_STATUS_required
Since
2.0

Definition at line 95 of file kim_support_status_module.f90.

◆ kim_support_status_required_by_api

type(kim_support_status_type), save, bind(C, name="KIM_SUPPORT_STATUS_requiredByAPI"), public, protected kim_support_status_module::kim_support_status_required_by_api

The standard requiredByAPI status.

See also
KIM::SUPPORT_STATUS::requiredByAPI, KIM_SUPPORT_STATUS_requiredByAPI
Since
2.0

Definition at line 77 of file kim_support_status_module.f90.