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_ComputeCallbackName.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_COMPUTE_CALLBACK_NAME_H_
37 #define KIM_COMPUTE_CALLBACK_NAME_H_
38 
48 {
59 };
60 #ifndef KIM_COMPUTE_CALLBACK_NAME_DEFINED_
61 #define KIM_COMPUTE_CALLBACK_NAME_DEFINED_
62 
68 #endif
69 
80 KIM_ComputeCallbackName_FromString(char const * const str);
81 
91  KIM_ComputeCallbackName const computeCallbackName);
92 
102  KIM_ComputeCallbackName const rhs);
103 
113  KIM_ComputeCallbackName const rhs);
114 
124  KIM_ComputeCallbackName const computeCallbackName);
125 
136 
147 
157 extern KIM_ComputeCallbackName const
159 
170  int * const numberOfComputeCallbackNames);
171 
181  int const index, KIM_ComputeCallbackName * const computeCallbackName);
182 
183 #endif /* KIM_COMPUTE_CALLBACK_NAME_H_ */
void KIM_COMPUTE_CALLBACK_NAME_GetNumberOfComputeCallbackNames(int *const numberOfComputeCallbackNames)
KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_ProcessD2EDr2Term
The standard ProcessD2EDr2Term callback.
char const * KIM_ComputeCallbackName_ToString(KIM_ComputeCallbackName const computeCallbackName)
Converts the object to a string.
int KIM_ComputeCallbackName_Equal(KIM_ComputeCallbackName const lhs, KIM_ComputeCallbackName const rhs)
Compares ComputeCallbackName objects for equality.
int KIM_ComputeCallbackName_NotEqual(KIM_ComputeCallbackName const lhs, KIM_ComputeCallbackName const rhs)
Compares ComputeCallbackName objects for inequality.
KIM_ComputeCallbackName KIM_ComputeCallbackName_FromString(char const *const str)
Create a ComputeCallbackName object corresponding to the provided string. If the string does not matc...
KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_GetNeighborList
The standard GetNeighborList callback.
int KIM_COMPUTE_CALLBACK_NAME_GetComputeCallbackName(int const index, KIM_ComputeCallbackName *const computeCallbackName)
Get the identity of each defined standard ComputeCallbackName.
An Extensible Enumeration for the ComputeCallbackName's supported by the KIM API. ...
int KIM_ComputeCallbackName_Known(KIM_ComputeCallbackName const computeCallbackName)
Determines if the object is a quantity known to the KIM API.
int computeCallbackNameID
Integer identifying the specific ComputeCallbackName represented.
KIM_ComputeCallbackName const KIM_COMPUTE_CALLBACK_NAME_ProcessDEDrTerm
The standard ProcessDEDrTerm callback.