kim-api  2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelRoutineName.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_MODEL_ROUTINE_NAME_H_
32 #define KIM_MODEL_ROUTINE_NAME_H_
33 
43 {
54 };
55 #ifndef KIM_MODEL_ROUTINE_NAME_DEFINED_
56 #define KIM_MODEL_ROUTINE_NAME_DEFINED_
57 
63 #endif
64 
75 
83 int KIM_ModelRoutineName_Known(KIM_ModelRoutineName const modelRoutineName);
84 
94  KIM_ModelRoutineName const rhs);
95 
105  KIM_ModelRoutineName const rhs);
106 
115 char const *
117 
127 
138 
148 
158 
168 
178 extern KIM_ModelRoutineName const
180 
190 extern KIM_ModelRoutineName const
192 
202 
212  int * const numberOfModelRoutineNames);
213 
223  int const index, KIM_ModelRoutineName * const modelRoutineName);
224 
225 #endif /* KIM_MODEL_ROUTINE_NAME_H_ */
void KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames(int *const numberOfModelRoutineNames)
Get the number of standard ModelRoutineName's defined by the KIM API.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate
The standard ComputeArgumentsCreate routine.
KIM_ModelRoutineName KIM_ModelRoutineName_FromString(char const *const str)
Create a ModelRoutineName object corresponding to the provided string. If the string does not match o...
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel
The standard WriteParameterizedModel routine.
int KIM_MODEL_ROUTINE_NAME_GetModelRoutineName(int const index, KIM_ModelRoutineName *const modelRoutineName)
Get the identity of each defined standard ModelRoutineName.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute
The standard Compute routine.
int KIM_ModelRoutineName_Equal(KIM_ModelRoutineName const lhs, KIM_ModelRoutineName const rhs)
Compares ModelRoutineName objects for equality.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy
The standard Destroy routine.
char const * KIM_ModelRoutineName_ToString(KIM_ModelRoutineName const modelRoutineName)
Converts the object to a string.
int KIM_ModelRoutineName_Known(KIM_ModelRoutineName const modelRoutineName)
Determines if the object is a quantity known to the KIM API.
An Extensible Enumeration for the ModelRoutineName's supported by the KIM API.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Create
The standard Create routine.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy
The standard ComputeArgumentsDestroy routine.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Extension
The standard Extension routine.
int KIM_ModelRoutineName_NotEqual(KIM_ModelRoutineName const lhs, KIM_ModelRoutineName const rhs)
Compares ModelRoutineName objects for inequality.
int modelRoutineNameID
Integer identifying the specific ModelRoutineName represented.
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Refresh
The standard Refresh routine.