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).
Classes | Typedefs | Functions | Variables
KIM_EnergyUnit.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

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

Typedefs

typedef struct KIM_EnergyUnit KIM_EnergyUnit
 Convenience typedef. More...
 

Functions

KIM_EnergyUnit KIM_EnergyUnit_FromString (char const *const str)
 Create an EnergyUnit 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...
 
int KIM_EnergyUnit_Known (KIM_EnergyUnit const energyUnit)
 Determines if the object is a quantity known to the KIM API. More...
 
int KIM_EnergyUnit_Equal (KIM_EnergyUnit const lhs, KIM_EnergyUnit const rhs)
 Compares EnergyUnit objects for equality. More...
 
int KIM_EnergyUnit_NotEqual (KIM_EnergyUnit const lhs, KIM_EnergyUnit const rhs)
 Compares EnergyUnit objects for inequality. More...
 
char const * KIM_EnergyUnit_ToString (KIM_EnergyUnit const energyUnit)
 Converts the object to a string. More...
 
void KIM_ENERGY_UNIT_GetNumberOfEnergyUnits (int *const numberOfEnergyUnits)
 Get the number of standard EnergyUnit's defined by the KIM API. More...
 
int KIM_ENERGY_UNIT_GetEnergyUnit (int const index, KIM_EnergyUnit *const energyUnit)
 Get the identity of each defined standard EnergyUnit. More...
 

Variables

KIM_EnergyUnit const KIM_ENERGY_UNIT_unused
 Indicates that a EnergyUnit is not used. More...
 
KIM_EnergyUnit const KIM_ENERGY_UNIT_amu_A2_per_ps2
 The standard amu*A \(^2\)/ps \(^2\) unit of energy. More...
 
KIM_EnergyUnit const KIM_ENERGY_UNIT_erg
 The standard erg unit of energy. More...
 
KIM_EnergyUnit const KIM_ENERGY_UNIT_eV
 The standard electronvolt unit of energy. More...
 
KIM_EnergyUnit const KIM_ENERGY_UNIT_Hartree
 The standard Hartree unit of energy. More...
 
KIM_EnergyUnit const KIM_ENERGY_UNIT_J
 The standard Joule unit of energy. More...
 
KIM_EnergyUnit const KIM_ENERGY_UNIT_kcal_mol
 The standard kilocalorie per mole unit of energy. More...
 

Typedef Documentation

◆ KIM_EnergyUnit

Convenience typedef.

Since
2.0

Definition at line 65 of file KIM_EnergyUnit.h.

Function Documentation

◆ KIM_ENERGY_UNIT_GetEnergyUnit()

int KIM_ENERGY_UNIT_GetEnergyUnit ( int const  index,
KIM_EnergyUnit *const  energyUnit 
)

Get the identity of each defined standard EnergyUnit.

See also
KIM::ENERGY_UNIT::GetEnergyUnit, kim_energy_unit_module::kim_get_energy_unit
Since
2.0

◆ KIM_ENERGY_UNIT_GetNumberOfEnergyUnits()

void KIM_ENERGY_UNIT_GetNumberOfEnergyUnits ( int *const  numberOfEnergyUnits)

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

See also
KIM::ENERGY_UNIT::GetNumberOfEnergyUnits, kim_energy_unit_module::kim_get_number_of_energy_units
Since
2.0

◆ KIM_EnergyUnit_Equal()

int KIM_EnergyUnit_Equal ( KIM_EnergyUnit const  lhs,
KIM_EnergyUnit const  rhs 
)

Compares EnergyUnit objects for equality.

See also
KIM::EnergyUnit::operator==(), kim_energy_unit_module::operator(.eq.)
Since
2.0

◆ KIM_EnergyUnit_FromString()

KIM_EnergyUnit KIM_EnergyUnit_FromString ( char const *const  str)

Create an EnergyUnit 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.

See also
KIM::EnergyUnit::EnergyUnit(std::string const &), kim_energy_unit_module::kim_from_string
Since
2.0

◆ KIM_EnergyUnit_Known()

int KIM_EnergyUnit_Known ( KIM_EnergyUnit const  energyUnit)

Determines if the object is a quantity known to the KIM API.

See also
KIM::EnergyUnit::Known, kim_energy_unit_module::kim_known
Since
2.0

◆ KIM_EnergyUnit_NotEqual()

int KIM_EnergyUnit_NotEqual ( KIM_EnergyUnit const  lhs,
KIM_EnergyUnit const  rhs 
)

Compares EnergyUnit objects for inequality.

See also
KIM::EnergyUnit::operator!=(), kim_energy_unit_module::operator(.ne.)
Since
2.0

◆ KIM_EnergyUnit_ToString()

char const* KIM_EnergyUnit_ToString ( KIM_EnergyUnit const  energyUnit)

Converts the object to a string.

See also
KIM::EnergyUnit::ToString, kim_energy_unit_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_ENERGY_UNIT_amu_A2_per_ps2

KIM_EnergyUnit const KIM_ENERGY_UNIT_amu_A2_per_ps2

The standard amu*A \(^2\)/ps \(^2\) unit of energy.

See also
KIM::ENERGY_UNIT::amu_A2_per_ps2, kim_energy_unit_module::kim_energy_unit_amu_a2_per_ps2
Since
2.0

◆ KIM_ENERGY_UNIT_erg

KIM_EnergyUnit const KIM_ENERGY_UNIT_erg

The standard erg unit of energy.

See also
KIM::ENERGY_UNIT::erg, kim_energy_unit_module::kim_energy_unit_erg
Since
2.0

◆ KIM_ENERGY_UNIT_eV

KIM_EnergyUnit const KIM_ENERGY_UNIT_eV

The standard electronvolt unit of energy.

See also
KIM::ENERGY_UNIT::eV, kim_energy_unit_module::kim_energy_unit_ev
Since
2.0

◆ KIM_ENERGY_UNIT_Hartree

KIM_EnergyUnit const KIM_ENERGY_UNIT_Hartree

The standard Hartree unit of energy.

See also
KIM::ENERGY_UNIT::Hartree, kim_energy_unit_module::kim_energy_unit_hartree
Since
2.0

◆ KIM_ENERGY_UNIT_J

KIM_EnergyUnit const KIM_ENERGY_UNIT_J

The standard Joule unit of energy.

See also
KIM::ENERGY_UNIT::J, kim_energy_unit_module::kim_energy_unit_j
Since
2.0

◆ KIM_ENERGY_UNIT_kcal_mol

KIM_EnergyUnit const KIM_ENERGY_UNIT_kcal_mol

The standard kilocalorie per mole unit of energy.

See also
KIM::ENERGY_UNIT::kcal_mol, kim_energy_unit_module::kim_energy_unit_kcal_mol
Since
2.0

◆ KIM_ENERGY_UNIT_unused

KIM_EnergyUnit const KIM_ENERGY_UNIT_unused

Indicates that a EnergyUnit is not used.

See also
KIM::ENERGY_UNIT::unused, kim_energy_unit_module::kim_energy_unit_unused
Since
2.0