1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
/* */
/* KIM-API: An API for interatomic models */
/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
/* All rights reserved. */
/* */
/* Contributors: */
/* Ryan S. Elliott */
/* */
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/* */
/* This library is free software; you can redistribute it and/or */
/* modify it under the terms of the GNU Lesser General Public */
/* License as published by the Free Software Foundation; either */
/* version 2.1 of the License, or (at your option) any later version. */
/* */
/* This library is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
/* Lesser General Public License for more details. */
/* */
/* You should have received a copy of the GNU Lesser General Public License */
/* along with this library; if not, write to the Free Software Foundation, */
/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
/* */
/* */
/* Release: This file is part of the kim-api.git repository. */
/* */
#ifndef KIM_LENGTH_UNIT_H_
#define KIM_LENGTH_UNIT_H_
/**
** \brief \copybrief KIM::LengthUnit
**
** \sa KIM::LengthUnit, kim_length_unit_module::kim_length_unit_type
**
** \since 2.0
**/
struct KIM_LengthUnit
{
/**
** \brief \copybrief KIM::LengthUnit::lengthUnitID
**
** \sa KIM::LengthUnit::lengthUnitID,
** kim_length_unit_module::kim_length_unit_type::length_unit_id
**
** \since 2.0
**/
int lengthUnitID;
};
#ifndef KIM_LENGTH_UNIT_DEFINED_
#define KIM_LENGTH_UNIT_DEFINED_
/**
** \brief Convenience typedef.
**
** \since 2.0
**/
typedef struct KIM_LengthUnit KIM_LengthUnit;
#endif
/**
** \brief \copybrief KIM::LengthUnit::LengthUnit(std::string const &)
**
** \sa KIM::LengthUnit::LengthUnit(std::string const &),
** kim_length_unit_module::kim_from_string
**
** \since 2.0
**/
KIM_LengthUnit KIM_LengthUnit_FromString(char const * const str);
/**
** \brief \copybrief KIM::LengthUnit::Known
**
** \sa KIM::LengthUnit::Known, kim_length_unit_module::kim_known
**
** \since 2.0
**/
int KIM_LengthUnit_Known(KIM_LengthUnit const lengthUnit);
/**
** \brief \copybrief KIM::LengthUnit::operator==()
**
** \sa KIM::LengthUnit::operator==(), kim_length_unit_module::operator(.eq.)
**
** \since 2.0
**/
int KIM_LengthUnit_Equal(KIM_LengthUnit const lhs, KIM_LengthUnit const rhs);
/**
** \brief \copybrief KIM::LengthUnit::operator!=()
**
** \sa KIM::LengthUnit::operator!=(), kim_length_unit_module::operator(.ne.)
**
** \since 2.0
**/
int KIM_LengthUnit_NotEqual(KIM_LengthUnit const lhs, KIM_LengthUnit const rhs);
/**
** \brief \copybrief KIM::LengthUnit::ToString
**
** \sa KIM::LengthUnit::ToString, kim_length_unit_module::kim_to_string
**
** \since 2.0
**/
char const * KIM_LengthUnit_ToString(KIM_LengthUnit const lengthUnit);
/**
** \brief \copybrief KIM::LENGTH_UNIT::unused
**
** \sa KIM::LENGTH_UNIT::unused,
** kim_length_unit_module::kim_length_unit_unused
**
** \since 2.0
**/
extern KIM_LengthUnit const KIM_LENGTH_UNIT_unused;
/**
** \brief \copybrief KIM::LENGTH_UNIT::A
**
** \sa KIM::LENGTH_UNIT::A, kim_length_unit_module::kim_length_unit_a
**
** \since 2.0
**/
extern KIM_LengthUnit const KIM_LENGTH_UNIT_A;
/**
** \brief \copybrief KIM::LENGTH_UNIT::Bohr
**
** \sa KIM::LENGTH_UNIT::Bohr, kim_length_unit_module::kim_length_unit_bohr
**
** \since 2.0
**/
extern KIM_LengthUnit const KIM_LENGTH_UNIT_Bohr;
/**
** \brief \copybrief KIM::LENGTH_UNIT::cm
**
** \sa KIM::LENGTH_UNIT::cm, kim_length_unit_module::kim_length_unit_cm
**
** \since 2.0
**/
extern KIM_LengthUnit const KIM_LENGTH_UNIT_cm;
/**
** \brief \copybrief KIM::LENGTH_UNIT::m
**
** \sa KIM::LENGTH_UNIT::m, kim_length_unit_module::kim_length_unit_m
**
** \since 2.0
**/
extern KIM_LengthUnit const KIM_LENGTH_UNIT_m;
/**
** \brief \copybrief KIM::LENGTH_UNIT::nm
**
** \sa KIM::LENGTH_UNIT::nm, kim_length_unit_module::kim_length_unit_nm
**
** \since 2.0
**/
extern KIM_LengthUnit const KIM_LENGTH_UNIT_nm;
/**
** \brief \copybrief KIM::LENGTH_UNIT::GetNumberOfLengthUnits
**
** \sa KIM::LENGTH_UNIT::GetNumberOfLengthUnits,
** kim_length_unit_module::kim_get_number_of_length_units
**
** \since 2.0
**/
void KIM_LENGTH_UNIT_GetNumberOfLengthUnits(int * const numberOfLengthUnits);
/**
** \brief \copybrief KIM::LENGTH_UNIT::GetLengthUnit
**
** \sa KIM::LENGTH_UNIT::GetLengthUnit,
** kim_length_unit_module::kim_get_length_unit
**
** \since 2.0
**/
int KIM_LENGTH_UNIT_GetLengthUnit(int const index,
KIM_LengthUnit * const lengthUnit);
#endif /* KIM_LENGTH_UNIT_H_ */
|
