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

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

Functions/Subroutines

recursive subroutine, public kim_get_number_of_energy_units (number_of_energy_units)
 Get the number of standard EnergyUnit's defined by the KIM API. More...
 
recursive subroutine, public kim_get_energy_unit (index, energy_unit, ierr)
 Get the identity of each defined standard EnergyUnit. More...
 

Variables

type(kim_energy_unit_type), save, public, protected kim_energy_unit_unused
 
type(kim_energy_unit_type), save, public, protected kim_energy_unit_amu_a2_per_ps2
 
type(kim_energy_unit_type), save, public, protected kim_energy_unit_erg
 
type(kim_energy_unit_type), save, public, protected kim_energy_unit_ev
 
type(kim_energy_unit_type), save, public, protected kim_energy_unit_hartree
 
type(kim_energy_unit_type), save, public, protected kim_energy_unit_j
 
type(kim_energy_unit_type), save, public, protected kim_energy_unit_kcal_mol
 

Detailed Description

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

See also
KIM::EnergyUnit, KIM_EnergyUnit
Since
2.0

Function/Subroutine Documentation

◆ kim_get_energy_unit()

recursive subroutine, public kim_energy_unit_module::kim_get_energy_unit ( integer(c_int), intent(in)  index,
type(kim_energy_unit_type), intent(out)  energy_unit,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard EnergyUnit.

See also
KIM::ENERGY_UNIT::GetEnergyUnit, KIM_ENERGY_UNIT_GetEnergyUnit
Since
2.0

Definition at line 314 of file kim_energy_unit_module.f90.

◆ kim_get_number_of_energy_units()

recursive subroutine, public kim_energy_unit_module::kim_get_number_of_energy_units ( integer(c_int), intent(out)  number_of_energy_units)

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

See also
KIM::ENERGY_UNIT::GetNumberOfEnergyUnits, KIM_ENERGY_UNIT_GetNumberOfEnergyUnits
Since
2.0

Definition at line 295 of file kim_energy_unit_module.f90.

Variable Documentation

◆ kim_energy_unit_amu_a2_per_ps2

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_amu_a2_per_ps2

Definition at line 95 of file kim_energy_unit_module.f90.

◆ kim_energy_unit_erg

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_erg

Definition at line 104 of file kim_energy_unit_module.f90.

◆ kim_energy_unit_ev

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_ev

Definition at line 113 of file kim_energy_unit_module.f90.

◆ kim_energy_unit_hartree

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_hartree

Definition at line 122 of file kim_energy_unit_module.f90.

◆ kim_energy_unit_j

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_j

Definition at line 131 of file kim_energy_unit_module.f90.

◆ kim_energy_unit_kcal_mol

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_kcal_mol

Definition at line 140 of file kim_energy_unit_module.f90.

◆ kim_energy_unit_unused

type(kim_energy_unit_type), save, public, protected kim_energy_unit_module::kim_energy_unit_unused

Definition at line 86 of file kim_energy_unit_module.f90.