kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ComputeArgumentName.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_ARGUMENT_NAME_H_
37 #define KIM_COMPUTE_ARGUMENT_NAME_H_
38 
39 /* Forward declarations */
40 #ifndef KIM_DATA_TYPE_DEFINED_
41 #define KIM_DATA_TYPE_DEFINED_
42 
47 typedef struct KIM_DataType KIM_DataType;
48 #endif
49 
50 
60 {
71 };
72 #ifndef KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
73 #define KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
74 
80 #endif
81 
92 KIM_ComputeArgumentName_FromString(char const * const str);
93 
103  KIM_ComputeArgumentName const computeArgumentName);
104 
114  KIM_ComputeArgumentName const rhs);
115 
125  KIM_ComputeArgumentName const rhs);
126 
136  KIM_ComputeArgumentName const computeArgumentName);
137 
147 extern KIM_ComputeArgumentName const
149 
159 extern KIM_ComputeArgumentName const
161 
171 extern KIM_ComputeArgumentName const
173 
183 
193 
203 
213 extern KIM_ComputeArgumentName const
215 
225 
235 extern KIM_ComputeArgumentName const
237 
248  int * const numberOfComputeArgumentNames);
249 
259  int const index, KIM_ComputeArgumentName * const computeArgumentName);
260 
270  KIM_ComputeArgumentName const computeArgumentName,
271  KIM_DataType * const dataType);
272 
273 #endif /* KIM_COMPUTE_ARGUMENT_NAME_H_ */
int KIM_ComputeArgumentName_Equal(KIM_ComputeArgumentName const lhs, KIM_ComputeArgumentName const rhs)
Compares ComputeArgumentName objects for equality.
void KIM_COMPUTE_ARGUMENT_NAME_GetNumberOfComputeArgumentNames(int *const numberOfComputeArgumentNames)
Get the number of standard ComputeArgumentName's defined by the KIM API.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_coordinates
The standard coordinates argument.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleEnergy
The standard partialParticleEnergy argument.
KIM_ComputeArgumentName KIM_ComputeArgumentName_FromString(char const *const str)
Create a ComputeArgumentName object corresponding to the provided string. If the string does not matc...
An Extensible Enumeration for the ComputeArgumentName's supported by the KIM API. ...
int KIM_ComputeArgumentName_NotEqual(KIM_ComputeArgumentName const lhs, KIM_ComputeArgumentName const rhs)
Compares ComputeArgumentName objects for inequality.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialForces
The standard partialForces argument.
int computeArgumentNameID
Integer identifying the specific ComputeArgumentName represented.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleSpeciesCodes
The standard particleSpeciesCodes argument.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialVirial
The standard partialVirial argument.
int KIM_ComputeArgumentName_Known(KIM_ComputeArgumentName const computeArgumentName)
Determines if the object is a quantity known to the KIM API.
An Extensible Enumeration for the DataType's supported by the KIM API.
Definition: KIM_DataType.h:46
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_numberOfParticles
The standard numberOfParticles argument.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialParticleVirial
The standard partialParticleVirial argument.
int KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentName(int const index, KIM_ComputeArgumentName *const computeArgumentName)
Get the identity of each defined standard ComputeArgumentName.
int KIM_COMPUTE_ARGUMENT_NAME_GetComputeArgumentDataType(KIM_ComputeArgumentName const computeArgumentName, KIM_DataType *const dataType)
Get the DataType of each defined standard ComputeArgumentName.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_partialEnergy
The standard partialEnergy argument.
char const * KIM_ComputeArgumentName_ToString(KIM_ComputeArgumentName const computeArgumentName)
Converts the object to a string.
KIM_ComputeArgumentName const KIM_COMPUTE_ARGUMENT_NAME_particleContributing
The standard particleContributing argument.