kim-api
2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Contains the enumeration constants and the discovery routines for the TemperatureUnit Extensible Enumeration. More...
Classes | |
struct | Comparator |
Structure provided for use with std::map. More... | |
Functions | |
void | GetNumberOfTemperatureUnits (int *const numberOfTemperatureUnits) |
Get the number of standard TemperatureUnit's defined by the KIM API. More... | |
int | GetTemperatureUnit (int const index, TemperatureUnit *const temperatureUnit) |
Get the identity of each defined standard TemperatureUnit. More... | |
Variables | |
TemperatureUnit const | unused |
Indicates that a TemperatureUnit is not used. More... | |
TemperatureUnit const | K |
The standard Kelvin unit of temperature. More... | |
Contains the enumeration constants and the discovery routines for the TemperatureUnit Extensible Enumeration.
void KIM::TEMPERATURE_UNIT::GetNumberOfTemperatureUnits | ( | int *const | numberOfTemperatureUnits | ) |
Get the number of standard TemperatureUnit's defined by the KIM API.
[out] | numberOfTemperatureUnits | The number of standard TemperatureUnit's defined by the KIM API. |
int KIM::TEMPERATURE_UNIT::GetTemperatureUnit | ( | int const | index, |
TemperatureUnit *const | temperatureUnit | ||
) |
Get the identity of each defined standard TemperatureUnit.
[in] | index | Zero-based index uniquely labeling each defined standard TemperatureUnit. This index ordering is only guaranteed to be stable during the lifetime of the current process. |
[out] | temperatureUnit | The TemperatureUnit object associated with index . |
true
if index < 0
or index >= numberOfTemperatureUnits
. false
otherwise.TemperatureUnit const KIM::TEMPERATURE_UNIT::K |
The standard Kelvin unit of temperature.
TemperatureUnit const KIM::TEMPERATURE_UNIT::unused |
Indicates that a TemperatureUnit is not used.