KIM API V2
KIM_ArgumentName.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--2018, 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-v2.0.0-alpha.0 package. */
33 /* */
34 
35 
36 #ifndef KIM_ARGUMENT_NAME_H_
37 #define KIM_ARGUMENT_NAME_H_
38 
39 /* Forward declarations */
40 #ifndef KIM_DATA_TYPE_DEFINED_
41 #define KIM_DATA_TYPE_DEFINED_
42 typedef struct KIM_DataType KIM_DataType;
43 #endif
44 
46 {
48 };
49 #ifndef KIM_ARGUMENT_NAME_DEFINED_
50 #define KIM_ARGUMENT_NAME_DEFINED_
52 #endif
53 
54 KIM_ArgumentName KIM_ArgumentNameFromString(char const * const str);
55 
57  KIM_ArgumentName const right);
59  KIM_ArgumentName const right);
60 char const * const KIM_ArgumentNameString(KIM_ArgumentName const argumentName);
61 
71 
72 void KIM_ARGUMENT_NAME_GetNumberOfArguments(int * const numberOfArguments);
74  int const index, KIM_ArgumentName * const argumentName);
75 
77  KIM_ArgumentName const argumentName,
78  KIM_DataType * const dataType);
79 
80 #endif /* KIM_ARGUMENT_NAME_H_ */
int KIM_ArgumentNameNotEqual(KIM_ArgumentName const left, KIM_ArgumentName const right)
KIM_ArgumentName const KIM_ARGUMENT_NAME_particleContributing
KIM_ArgumentName const KIM_ARGUMENT_NAME_numberOfParticles
char const *const KIM_ArgumentNameString(KIM_ArgumentName const argumentName)
void KIM_ARGUMENT_NAME_GetNumberOfArguments(int *const numberOfArguments)
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialParticleVirial
int KIM_ARGUMENT_NAME_GetArgumentDataType(KIM_ArgumentName const argumentName, KIM_DataType *const dataType)
int KIM_ARGUMENT_NAME_GetArgumentName(int const index, KIM_ArgumentName *const argumentName)
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialParticleEnergy
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialForces
int KIM_ArgumentNameEqual(KIM_ArgumentName const left, KIM_ArgumentName const right)
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialVirial
KIM_ArgumentName const KIM_ARGUMENT_NAME_coordinates
KIM_ArgumentName const KIM_ARGUMENT_NAME_particleSpeciesCodes
KIM_ArgumentName KIM_ArgumentNameFromString(char const *const str)
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialEnergy