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

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

Data Types

interface  kim_from_string
 Create a LengthUnit 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_length_unit_type
 An Extensible Enumeration for the LengthUnit'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_length_units (number_of_length_units)
 Get the number of standard LengthUnit's defined by the KIM API. More...
 
recursive subroutine, public kim_get_length_unit (index, length_unit, ierr)
 Get the identity of each defined standard LengthUnit. More...
 

Variables

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_unused"), public, protected kim_length_unit_unused
 Indicates that a LengthUnit is not used. More...
 
type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_A"), public, protected kim_length_unit_a
 The standard angstrom unit of length. More...
 
type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_Bohr"), public, protected kim_length_unit_bohr
 The standard Bohr unit of length. More...
 
type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_cm"), public, protected kim_length_unit_cm
 The standard centimeter unit of length. More...
 
type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_m"), public, protected kim_length_unit_m
 The standard meter unit of length. More...
 
type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_nm"), public, protected kim_length_unit_nm
 The standard nanometer unit of length. More...
 

Detailed Description

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

See also
KIM::LengthUnit, KIM_LengthUnit
Since
2.0

Function/Subroutine Documentation

◆ kim_get_length_unit()

recursive subroutine, public kim_length_unit_module::kim_get_length_unit ( integer(c_int), intent(in)  index,
type(kim_length_unit_type), intent(out)  length_unit,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard LengthUnit.

See also
KIM::LENGTH_UNIT::GetLengthUnit, KIM_LENGTH_UNIT_GetLengthUnit
Since
2.0

Definition at line 296 of file kim_length_unit_module.f90.

◆ kim_get_number_of_length_units()

recursive subroutine, public kim_length_unit_module::kim_get_number_of_length_units ( integer(c_int), intent(out)  number_of_length_units)

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

See also
KIM::LENGTH_UNIT::GetNumberOfLengthUnits, KIM_LENGTH_UNIT_GetNumberOfLengthUnits
Since
2.0

Definition at line 277 of file kim_length_unit_module.f90.

Variable Documentation

◆ kim_length_unit_a

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_A"), public, protected kim_length_unit_module::kim_length_unit_a

The standard angstrom unit of length.

See also
KIM::LENGTH_UNIT::A, KIM_LENGTH_UNIT_A
Since
2.0

Definition at line 87 of file kim_length_unit_module.f90.

◆ kim_length_unit_bohr

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_Bohr"), public, protected kim_length_unit_module::kim_length_unit_bohr

The standard Bohr unit of length.

See also
KIM::LENGTH_UNIT::Bohr, KIM_LENGTH_UNIT_Bohr
Since
2.0

Definition at line 96 of file kim_length_unit_module.f90.

◆ kim_length_unit_cm

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_cm"), public, protected kim_length_unit_module::kim_length_unit_cm

The standard centimeter unit of length.

See also
KIM::LENGTH_UNIT::cm, KIM_LENGTH_UNIT_cm
Since
2.0

Definition at line 105 of file kim_length_unit_module.f90.

◆ kim_length_unit_m

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_m"), public, protected kim_length_unit_module::kim_length_unit_m

The standard meter unit of length.

See also
KIM::LENGTH_UNIT::m, KIM_LENGTH_UNIT_m
Since
2.0

Definition at line 114 of file kim_length_unit_module.f90.

◆ kim_length_unit_nm

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_nm"), public, protected kim_length_unit_module::kim_length_unit_nm

The standard nanometer unit of length.

See also
KIM::LENGTH_UNIT::nm, KIM_LENGTH_UNIT_nm
Since
2.0

Definition at line 123 of file kim_length_unit_module.f90.

◆ kim_length_unit_unused

type(kim_length_unit_type), save, bind(C, name="KIM_LENGTH_UNIT_unused"), public, protected kim_length_unit_module::kim_length_unit_unused

Indicates that a LengthUnit is not used.

See also
KIM::LENGTH_UNIT::unused, KIM_LENGTH_UNIT_unused
Since
2.0

Definition at line 78 of file kim_length_unit_module.f90.