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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/* */
/* 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_MODEL_ROUTINE_NAME_H_
#define KIM_MODEL_ROUTINE_NAME_H_
/**
** \brief \copybrief KIM::ModelRoutineName
**
** \sa KIM::ModelRoutineName,
** kim_model_routine_name_module::kim_model_routine_name_type
**
** \since 2.0
**/
struct KIM_ModelRoutineName
{
/**
** \brief \copybrief KIM::ModelRoutineName::modelRoutineNameID
**
** \sa KIM::ModelRoutineName::modelRoutineNameID,
** kim_model_routine_name_module::kim_model_routine_name_type::<!--
** -->model_routine_name_id
**
** \since 2.0
**/
int modelRoutineNameID;
};
#ifndef KIM_MODEL_ROUTINE_NAME_DEFINED_
#define KIM_MODEL_ROUTINE_NAME_DEFINED_
/**
** \brief Convenience typedef.
**
** \since 2.0
**/
typedef struct KIM_ModelRoutineName KIM_ModelRoutineName;
#endif
/**
** \brief \copybrief <!--
** --> KIM::ModelRoutineName::ModelRoutineName(std::string const &)
**
** \sa KIM::ModelRoutineName::ModelRoutineName(std::string const &),
** kim_model_routine_name_module::kim_from_string
**
** \since 2.0
**/
KIM_ModelRoutineName KIM_ModelRoutineName_FromString(char const * const str);
/**
** \brief \copybrief KIM::ModelRoutineName::Known
**
** \sa KIM::ModelRoutineName::Known, kim_model_routine_name_module::kim_known
**
** \since 2.0
**/
int KIM_ModelRoutineName_Known(KIM_ModelRoutineName const modelRoutineName);
/**
** \brief \copybrief KIM::ModelRoutineName::operator==()
**
** \sa KIM::ModelRoutineName::operator==(),
** kim_model_routine_name_module::operator(.eq.)
**
** \since 2.0
**/
int KIM_ModelRoutineName_Equal(KIM_ModelRoutineName const lhs,
KIM_ModelRoutineName const rhs);
/**
** \brief \copybrief KIM::ModelRoutineName::operator!=()
**
** \sa KIM::ModelRoutineName::operator!=(),
** kim_model_routine_name_module::operator(.ne.)
**
** \since 2.0
**/
int KIM_ModelRoutineName_NotEqual(KIM_ModelRoutineName const lhs,
KIM_ModelRoutineName const rhs);
/**
** \brief \copybrief KIM::ModelRoutineName::ToString
**
** \sa KIM::ModelRoutineName::ToString,
** kim_model_routine_name_module::kim_to_string
**
** \since 2.0
**/
char const *
KIM_ModelRoutineName_ToString(KIM_ModelRoutineName const modelRoutineName);
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::Create
**
** \sa KIM::MODEL_ROUTINE_NAME::Create,
** kim_model_routine_name_module::kim_model_routine_name_create
**
** \since 2.0
**/
extern KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Create;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::ComputeArgumentsCreate
**
** \sa KIM::MODEL_ROUTINE_NAME::ComputeArgumentsCreate,
** kim_model_routine_name_module::<!--
** -->kim_model_routine_name_compute_arguments_create
**
** \since 2.0
**/
extern KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::Compute
**
** \sa KIM::MODEL_ROUTINE_NAME::Compute,
** kim_model_routine_name_module::kim_model_routine_name_compute
**
** \since 2.0
**/
extern KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::Extension
**
** \sa KIM::MODEL_ROUTINE_NAME::Extension,
** kim_model_routine_name_module::kim_model_routine_name_extension
**
** \since 2.0
**/
extern KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Extension;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::Refresh
**
** \sa KIM::MODEL_ROUTINE_NAME::Refresh,
** kim_model_routine_name_module::kim_model_routine_name_refresh
**
** \since 2.0
**/
extern KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Refresh;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::WriteParameterizedModel
**
** \sa KIM::MODEL_ROUTINE_NAME::WriteParameterizedModel,
** kim_model_routine_name_module::<!--
** -->kim_model_routine_name_write_parameterized_model
**
** \since 2.0
**/
extern KIM_ModelRoutineName const
KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::ComputeArgumentsDestroy
**
** \sa KIM::MODEL_ROUTINE_NAME::ComputeArgumentsDestroy,
** kim_model_routine_name_module::<!--
** -->kim_model_routine_name_compute_arguments_destroy
**
** \since 2.0
**/
extern KIM_ModelRoutineName const
KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::Destroy
**
** \sa KIM::MODEL_ROUTINE_NAME::Destroy,
** kim_model_routine_name_module::kim_model_routine_name_destroy
**
** \since 2.0
**/
extern KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy;
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::GetNumberOfModelRoutineNames
**
** \sa KIM::MODEL_ROUTINE_NAME::GetNumberOfModelRoutineNames,
** kim_model_routine_name_module::kim_get_number_of_model_routine_names
**
** \since 2.0
**/
void KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames(
int * const numberOfModelRoutineNames);
/**
** \brief \copybrief KIM::MODEL_ROUTINE_NAME::GetModelRoutineName
**
** \sa KIM::MODEL_ROUTINE_NAME::GetModelRoutineName,
** kim_model_routine_name_module::kim_get_model_routine_name
**
** \since 2.0
**/
int KIM_MODEL_ROUTINE_NAME_GetModelRoutineName(
int const index, KIM_ModelRoutineName * const modelRoutineName);
#endif /* KIM_MODEL_ROUTINE_NAME_H_ */
|
