kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_TemperatureUnit.h
Go to the documentation of this file.
1/* */
2/* KIM-API: An API for interatomic models */
3/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4/* All rights reserved. */
5/* */
6/* Contributors: */
7/* Ryan S. Elliott */
8/* */
9/* SPDX-License-Identifier: LGPL-2.1-or-later */
10/* */
11/* This library is free software; you can redistribute it and/or */
12/* modify it under the terms of the GNU Lesser General Public */
13/* License as published by the Free Software Foundation; either */
14/* version 2.1 of the License, or (at your option) any later version. */
15/* */
16/* This library is distributed in the hope that it will be useful, */
17/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19/* Lesser General Public License for more details. */
20/* */
21/* You should have received a copy of the GNU Lesser General Public License */
22/* along with this library; if not, write to the Free Software Foundation, */
23/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24/* */
25
26/* */
27/* Release: This file is part of the kim-api-2.3.0 package. */
28/* */
29
30
31#ifndef KIM_TEMPERATURE_UNIT_H_
32#define KIM_TEMPERATURE_UNIT_H_
33
43{
54};
55#ifndef KIM_TEMPERATURE_UNIT_DEFINED_
56#define KIM_TEMPERATURE_UNIT_DEFINED_
63#endif
64
74
83
93 KIM_TemperatureUnit const rhs);
94
104 KIM_TemperatureUnit const rhs);
105
114char const *
116
126
136
146 int * const numberOfTemperatureUnits);
147
157 int const index, KIM_TemperatureUnit * const temperatureUnit);
158
159#endif /* KIM_TEMPERATURE_UNIT_H_ */
int KIM_TemperatureUnit_Known(KIM_TemperatureUnit const temperatureUnit)
Determines if the object is a quantity known to the KIM API.
int KIM_TemperatureUnit_NotEqual(KIM_TemperatureUnit const lhs, KIM_TemperatureUnit const rhs)
Compares TemperatureUnit objects for inequality.
KIM_TemperatureUnit KIM_TemperatureUnit_FromString(char const *const str)
Create a TemperatureUnit object corresponding to the provided string. If the string does not match on...
KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_unused
Indicates that a TemperatureUnit is not used.
int KIM_TEMPERATURE_UNIT_GetTemperatureUnit(int const index, KIM_TemperatureUnit *const temperatureUnit)
Get the identity of each defined standard TemperatureUnit.
int KIM_TemperatureUnit_Equal(KIM_TemperatureUnit const lhs, KIM_TemperatureUnit const rhs)
Compares TemperatureUnit objects for equality.
KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_K
The standard Kelvin unit of temperature.
void KIM_TEMPERATURE_UNIT_GetNumberOfTemperatureUnits(int *const numberOfTemperatureUnits)
Get the number of standard TemperatureUnit's defined by the KIM API.
char const * KIM_TemperatureUnit_ToString(KIM_TemperatureUnit const temperatureUnit)
Converts the object to a string.
An Extensible Enumeration for the TemperatureUnit's supported by the KIM API.
int temperatureUnitID
Integer identifying the specific TemperatureUnit represented.