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).
KIM_TemperatureUnit.h
Go to the documentation of this file.
1 /* */
2 /* CDDL HEADER START */
3 /* */
4 /* The contents of this file are subject to the terms of the Common */
5 /* Development and Distribution License Version 1.0 (the "License"). */
6 /* */
7 /* You can obtain a copy of the license at */
8 /* http://www.opensource.org/licenses/CDDL-1.0. See the License for the */
9 /* specific language governing permissions and limitations under the License. */
10 /* */
11 /* When distributing Covered Code, include this CDDL HEADER in each file and */
12 /* include the License file in a prominent location with the name */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2019, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api.git repository. */
33 /* */
34 
35 
36 #ifndef KIM_TEMPERATURE_UNIT_H_
37 #define KIM_TEMPERATURE_UNIT_H_
38 
48 {
59 };
60 #ifndef KIM_TEMPERATURE_UNIT_DEFINED_
61 #define KIM_TEMPERATURE_UNIT_DEFINED_
62 
68 #endif
69 
79 
87 int KIM_TemperatureUnit_Known(KIM_TemperatureUnit const temperatureUnit);
88 
98  KIM_TemperatureUnit const rhs);
99 
109  KIM_TemperatureUnit const rhs);
110 
119 char const *
121 
131 
141 
151  int * const numberOfTemperatureUnits);
152 
162  int const index, KIM_TemperatureUnit * const temperatureUnit);
163 
164 #endif /* KIM_TEMPERATURE_UNIT_H_ */
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_TemperatureUnit_Known(KIM_TemperatureUnit const temperatureUnit)
Determines if the object is a quantity known to the KIM API.
int temperatureUnitID
Integer identifying the specific TemperatureUnit represented.
int KIM_TEMPERATURE_UNIT_GetTemperatureUnit(int const index, KIM_TemperatureUnit *const temperatureUnit)
Get the identity of each defined standard TemperatureUnit.
int KIM_TemperatureUnit_NotEqual(KIM_TemperatureUnit const lhs, KIM_TemperatureUnit const rhs)
Compares TemperatureUnit objects for inequality.
char const * KIM_TemperatureUnit_ToString(KIM_TemperatureUnit const temperatureUnit)
Converts the object to a string.
int KIM_TemperatureUnit_Equal(KIM_TemperatureUnit const lhs, KIM_TemperatureUnit const rhs)
Compares TemperatureUnit objects for equality.
void KIM_TEMPERATURE_UNIT_GetNumberOfTemperatureUnits(int *const numberOfTemperatureUnits)
Get the number of standard TemperatureUnit's defined by the KIM API.
An Extensible Enumeration for the TemperatureUnit's supported by the KIM API.
KIM_TemperatureUnit const KIM_TEMPERATURE_UNIT_K
The standard Kelvin unit of temperature.