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

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

Data Types

interface  kim_from_string
 Create a Numbering 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_numbering_type
 An Extensible Enumeration for the Numbering'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_numberings (number_of_numberings)
 Get the number of standard Numbering's defined by the KIM API. More...
 
recursive subroutine, public kim_get_numbering (index, numbering, ierr)
 Get the identity of each defined standard Numbering. More...
 

Variables

type(kim_numbering_type), save, bind(C, name="KIM_NUMBERING_zeroBased"), public, protected kim_numbering_zero_based
 The standard zeroBased numbering. More...
 
type(kim_numbering_type), save, bind(C, name="KIM_NUMBERING_oneBased"), public, protected kim_numbering_one_based
 The standard oneBased numbering. More...
 

Detailed Description

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

See also
KIM::Numbering, KIM_Numbering
Since
2.0

Function/Subroutine Documentation

◆ kim_get_number_of_numberings()

recursive subroutine, public kim_numbering_module::kim_get_number_of_numberings ( integer(c_int), intent(out)  number_of_numberings)

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

See also
KIM::NUMBERING::GetNumberOfNumberings, KIM_NUMBERING_GetNumberOfNumberings
Since
2.0

Definition at line 231 of file kim_numbering_module.f90.

◆ kim_get_numbering()

recursive subroutine, public kim_numbering_module::kim_get_numbering ( integer(c_int), intent(in)  index,
type(kim_numbering_type), intent(out)  numbering,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard Numbering.

See also
KIM::NUMBERING::GetNumbering, KIM_NUMBERING_GetNumbering
Since
2.0

Definition at line 251 of file kim_numbering_module.f90.

Variable Documentation

◆ kim_numbering_one_based

type(kim_numbering_type), save, bind(C, name="KIM_NUMBERING_oneBased"), public, protected kim_numbering_module::kim_numbering_one_based

The standard oneBased numbering.

See also
KIM::NUMBERING::oneBased, KIM_NUMBERING_oneBased
Since
2.0

Definition at line 78 of file kim_numbering_module.f90.

◆ kim_numbering_zero_based

type(kim_numbering_type), save, bind(C, name="KIM_NUMBERING_zeroBased"), public, protected kim_numbering_module::kim_numbering_zero_based

The standard zeroBased numbering.

See also
KIM::NUMBERING::zeroBased, KIM_NUMBERING_zeroBased
Since
2.0

Definition at line 69 of file kim_numbering_module.f90.