kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_EnergyUnit.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_ENERGY_UNIT_H_
37 #define KIM_ENERGY_UNIT_H_
38 
47 {
57 };
58 #ifndef KIM_ENERGY_UNIT_DEFINED_
59 #define KIM_ENERGY_UNIT_DEFINED_
60 
66 #endif
67 
76 KIM_EnergyUnit KIM_EnergyUnit_FromString(char const * const str);
77 
85 int KIM_EnergyUnit_Known(KIM_EnergyUnit const energyUnit);
86 
94 int KIM_EnergyUnit_Equal(KIM_EnergyUnit const lhs, KIM_EnergyUnit const rhs);
95 
103 int KIM_EnergyUnit_NotEqual(KIM_EnergyUnit const lhs, KIM_EnergyUnit const rhs);
104 
112 char const * KIM_EnergyUnit_ToString(KIM_EnergyUnit const energyUnit);
113 
123 
133 
142 
151 
161 
169 extern KIM_EnergyUnit const KIM_ENERGY_UNIT_J;
170 
180 
189 void KIM_ENERGY_UNIT_GetNumberOfEnergyUnits(int * const numberOfEnergyUnits);
190 
199 int KIM_ENERGY_UNIT_GetEnergyUnit(int const index,
200  KIM_EnergyUnit * const energyUnit);
201 
202 #endif /* KIM_ENERGY_UNIT_H_ */
int KIM_ENERGY_UNIT_GetEnergyUnit(int const index, KIM_EnergyUnit *const energyUnit)
Get the identity of each defined standard EnergyUnit.
KIM_EnergyUnit const KIM_ENERGY_UNIT_kcal_mol
The standard kilocalorie per mole unit of energy.
char const * KIM_EnergyUnit_ToString(KIM_EnergyUnit const energyUnit)
Converts the object to a string.
KIM_EnergyUnit const KIM_ENERGY_UNIT_erg
The standard erg unit of energy.
An Extensible Enumeration for the EnergyUnit's supported by the KIM API.
int KIM_EnergyUnit_NotEqual(KIM_EnergyUnit const lhs, KIM_EnergyUnit const rhs)
Compares EnergyUnit objects for inequality.
int KIM_EnergyUnit_Equal(KIM_EnergyUnit const lhs, KIM_EnergyUnit const rhs)
Compares EnergyUnit objects for equality.
KIM_EnergyUnit const KIM_ENERGY_UNIT_unused
Indicates that a EnergyUnit is not used.
void KIM_ENERGY_UNIT_GetNumberOfEnergyUnits(int *const numberOfEnergyUnits)
Get the number of standard EnergyUnit's defined by the KIM API.
KIM_EnergyUnit const KIM_ENERGY_UNIT_amu_A2_per_ps2
The standard amu*A /ps unit of energy.
int KIM_EnergyUnit_Known(KIM_EnergyUnit const energyUnit)
Determines if the object is a quantity known to the KIM API.
KIM_EnergyUnit const KIM_ENERGY_UNIT_eV
The standard electronvolt unit of energy.
int energyUnitID
Integer identifying the specific EnergyUnit represented.
KIM_EnergyUnit const KIM_ENERGY_UNIT_Hartree
The standard Hartree unit of energy.
KIM_EnergyUnit KIM_EnergyUnit_FromString(char const *const str)
Create an EnergyUnit object corresponding to the provided string. If the string does not match one of...
KIM_EnergyUnit const KIM_ENERGY_UNIT_J
The standard Joule unit of energy.