kim-api  2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_LengthUnit.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_LENGTH_UNIT_H_
32 #define KIM_LENGTH_UNIT_H_
33 
42 {
52 };
53 #ifndef KIM_LENGTH_UNIT_DEFINED_
54 #define KIM_LENGTH_UNIT_DEFINED_
55 
61 #endif
62 
71 KIM_LengthUnit KIM_LengthUnit_FromString(char const * const str);
72 
80 int KIM_LengthUnit_Known(KIM_LengthUnit const lengthUnit);
81 
89 int KIM_LengthUnit_Equal(KIM_LengthUnit const lhs, KIM_LengthUnit const rhs);
90 
98 int KIM_LengthUnit_NotEqual(KIM_LengthUnit const lhs, KIM_LengthUnit const rhs);
99 
107 char const * KIM_LengthUnit_ToString(KIM_LengthUnit const lengthUnit);
108 
118 
126 extern KIM_LengthUnit const KIM_LENGTH_UNIT_A;
127 
136 
145 
153 extern KIM_LengthUnit const KIM_LENGTH_UNIT_m;
154 
163 
172 void KIM_LENGTH_UNIT_GetNumberOfLengthUnits(int * const numberOfLengthUnits);
173 
182 int KIM_LENGTH_UNIT_GetLengthUnit(int const index,
183  KIM_LengthUnit * const lengthUnit);
184 
185 #endif /* KIM_LENGTH_UNIT_H_ */
KIM_LengthUnit const KIM_LENGTH_UNIT_nm
The standard nanometer unit of length.
int KIM_LengthUnit_Known(KIM_LengthUnit const lengthUnit)
Determines if the object is a quantity known to the KIM API.
int KIM_LENGTH_UNIT_GetLengthUnit(int const index, KIM_LengthUnit *const lengthUnit)
Get the identity of each defined standard LengthUnit.
KIM_LengthUnit KIM_LengthUnit_FromString(char const *const str)
Create a LengthUnit object corresponding to the provided string. If the string does not match one of ...
An Extensible Enumeration for the LengthUnit's supported by the KIM API.
int KIM_LengthUnit_Equal(KIM_LengthUnit const lhs, KIM_LengthUnit const rhs)
Compares LengthUnit objects for equality.
char const * KIM_LengthUnit_ToString(KIM_LengthUnit const lengthUnit)
Converts the object to a string.
KIM_LengthUnit const KIM_LENGTH_UNIT_cm
The standard centimeter unit of length.
int lengthUnitID
Integer identifying the specific LengthUnit represented.
KIM_LengthUnit const KIM_LENGTH_UNIT_unused
Indicates that a LengthUnit is not used.
void KIM_LENGTH_UNIT_GetNumberOfLengthUnits(int *const numberOfLengthUnits)
Get the number of standard LengthUnit's defined by the KIM API.
int KIM_LengthUnit_NotEqual(KIM_LengthUnit const lhs, KIM_LengthUnit const rhs)
Compares LengthUnit objects for inequality.
KIM_LengthUnit const KIM_LENGTH_UNIT_Bohr
The standard Bohr unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_m
The standard meter unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_A
The standard angstrom unit of length.