kim-api
2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
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 struct KIM_EnergyUnit KIM_EnergyUnit |
int KIM_ENERGY_UNIT_GetEnergyUnit | ( | int const | index, |
KIM_EnergyUnit *const | energyUnit | ||
) |
Get the identity of each defined standard EnergyUnit.
void KIM_ENERGY_UNIT_GetNumberOfEnergyUnits | ( | int *const | numberOfEnergyUnits | ) |
Get the number of standard EnergyUnit's defined by the KIM API.
int KIM_EnergyUnit_Equal | ( | KIM_EnergyUnit const | lhs, |
KIM_EnergyUnit const | rhs | ||
) |
Compares EnergyUnit objects for equality.
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.
int KIM_EnergyUnit_Known | ( | KIM_EnergyUnit const | energyUnit | ) |
Determines if the object is a quantity known to the KIM API.
int KIM_EnergyUnit_NotEqual | ( | KIM_EnergyUnit const | lhs, |
KIM_EnergyUnit const | rhs | ||
) |
Compares EnergyUnit objects for inequality.
char const* KIM_EnergyUnit_ToString | ( | KIM_EnergyUnit const | energyUnit | ) |
Converts the object to a string.
KIM_EnergyUnit const KIM_ENERGY_UNIT_amu_A2_per_ps2 |
The standard amu*A
\(^2\)/ps
\(^2\) unit of energy.
KIM_EnergyUnit const KIM_ENERGY_UNIT_erg |
The standard erg unit of energy.
KIM_EnergyUnit const KIM_ENERGY_UNIT_eV |
The standard electronvolt unit of energy.
KIM_EnergyUnit const KIM_ENERGY_UNIT_Hartree |
The standard Hartree unit of energy.
KIM_EnergyUnit const KIM_ENERGY_UNIT_J |
The standard Joule unit of energy.
KIM_EnergyUnit const KIM_ENERGY_UNIT_kcal_mol |
The standard kilocalorie per mole unit of energy.
KIM_EnergyUnit const KIM_ENERGY_UNIT_unused |
Indicates that a EnergyUnit is not used.