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_ModelRoutineName.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_MODEL_ROUTINE_NAME_H_
37 #define KIM_MODEL_ROUTINE_NAME_H_
38 
48 {
59 };
60 #ifndef KIM_MODEL_ROUTINE_NAME_DEFINED_
61 #define KIM_MODEL_ROUTINE_NAME_DEFINED_
62 
68 #endif
69 
80 
88 int KIM_ModelRoutineName_Known(KIM_ModelRoutineName const modelRoutineName);
89 
99  KIM_ModelRoutineName const rhs);
100 
110  KIM_ModelRoutineName const rhs);
111 
120 char const *
122 
132 
143 
153 
163 
173 
183 extern KIM_ModelRoutineName const
185 
195 extern KIM_ModelRoutineName const
197 
207 
217  int * const numberOfModelRoutineNames);
218 
228  int const index, KIM_ModelRoutineName * const modelRoutineName);
229 
230 #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.