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_TemperatureUnit.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_TemperatureUnit
 An Extensible Enumeration for the TemperatureUnit's supported by the KIM API. More...
 

Typedefs

typedef struct KIM_TemperatureUnit KIM_TemperatureUnit
 Convenience typedef. More...
 

Functions

KIM_TemperatureUnit KIM_TemperatureUnit_FromString (char const *const str)
 Create a TemperatureUnit 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_TemperatureUnit_Known (KIM_TemperatureUnit const temperatureUnit)
 Determines if the object is a quantity known to the KIM API. More...
 
int KIM_TemperatureUnit_Equal (KIM_TemperatureUnit const lhs, KIM_TemperatureUnit const rhs)
 Compares TemperatureUnit objects for equality. More...
 
int KIM_TemperatureUnit_NotEqual (KIM_TemperatureUnit const lhs, KIM_TemperatureUnit const rhs)
 Compares TemperatureUnit objects for inequality. More...
 
char const * KIM_TemperatureUnit_ToString (KIM_TemperatureUnit const temperatureUnit)
 Converts the object to a string. More...
 
void KIM_TEMPERATURE_UNIT_GetNumberOfTemperatureUnits (int *const numberOfTemperatureUnits)
 Get the number of standard TemperatureUnit's defined by the KIM API. More...
 
int KIM_TEMPERATURE_UNIT_GetTemperatureUnit (int const index, KIM_TemperatureUnit *const temperatureUnit)
 Get the identity of each defined standard TemperatureUnit. More...
 

Variables

KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_unused
 Indicates that a TemperatureUnit is not used. More...
 
KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_K
 The standard Kelvin unit of temperature. More...
 

Typedef Documentation

◆ KIM_TemperatureUnit

Convenience typedef.

Since
2.0

Definition at line 67 of file KIM_TemperatureUnit.h.

Function Documentation

◆ KIM_TEMPERATURE_UNIT_GetNumberOfTemperatureUnits()

void KIM_TEMPERATURE_UNIT_GetNumberOfTemperatureUnits ( int *const  numberOfTemperatureUnits)

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

See also
KIM::TEMPERATURE_UNIT::GetNumberOfTemperatureUnits, kim_temperature_unit_module::kim_get_number_of_temperature_units
Since
2.0

◆ KIM_TEMPERATURE_UNIT_GetTemperatureUnit()

int KIM_TEMPERATURE_UNIT_GetTemperatureUnit ( int const  index,
KIM_TemperatureUnit *const  temperatureUnit 
)

Get the identity of each defined standard TemperatureUnit.

See also
KIM::TEMPERATURE_UNIT::GetTemperatureUnit, kim_temperature_unit_module::kim_get_temperature_unit
Since
2.0

◆ KIM_TemperatureUnit_Equal()

int KIM_TemperatureUnit_Equal ( KIM_TemperatureUnit const  lhs,
KIM_TemperatureUnit const  rhs 
)

Compares TemperatureUnit objects for equality.

See also
KIM::TemperatureUnit::operator==(), kim_temperature_unit_module::operator(.eq.)
Since
2.0

◆ KIM_TemperatureUnit_FromString()

KIM_TemperatureUnit KIM_TemperatureUnit_FromString ( char const *const  str)

Create a TemperatureUnit 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::TemperatureUnit::TemperatureUnit(std::string const &), kim_temperature_unit_module::kim_from_string
Since
2.0

◆ KIM_TemperatureUnit_Known()

int KIM_TemperatureUnit_Known ( KIM_TemperatureUnit const  temperatureUnit)

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

See also
KIM::TemperatureUnit::Known, kim_temperature_unit_module::kim_known
Since
2.0

◆ KIM_TemperatureUnit_NotEqual()

int KIM_TemperatureUnit_NotEqual ( KIM_TemperatureUnit const  lhs,
KIM_TemperatureUnit const  rhs 
)

Compares TemperatureUnit objects for inequality.

See also
KIM::TemperatureUnit::operator!=(), kim_temperature_unit_module::operator(.ne.)
Since
2.0

◆ KIM_TemperatureUnit_ToString()

char const* KIM_TemperatureUnit_ToString ( KIM_TemperatureUnit const  temperatureUnit)

Converts the object to a string.

See also
KIM::TemperatureUnit::ToString, kim_temperature_unit_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_TEMPERATURE_UNIT_K

KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_K

The standard Kelvin unit of temperature.

See also
KIM::TEMPERATURE_UNIT::K, kim_temperature_unit_module::kim_temperature_unit_k
Since
2.0

◆ KIM_TEMPERATURE_UNIT_unused

KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_unused

Indicates that a TemperatureUnit is not used.

See also
KIM::TEMPERATURE_UNIT::unused, kim_temperature_unit_module::kim_temperature_unit_unused
Since
2.0