KIM API V2
KIM_ComputeArgumentName.hpp
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 Development
5 // 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 LICENSE.CDDL.
13 // If applicable, add the following below this CDDL HEADER, with the fields
14 // enclosed by brackets "[]" replaced with your own identifying information:
15 //
16 // Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
17 //
18 // CDDL HEADER END
19 //
20 
21 //
22 // Copyright (c) 2016--2018, Regents of the University of Minnesota.
23 // All rights reserved.
24 //
25 // Contributors:
26 // Ryan S. Elliott
27 //
28 
29 //
30 // Release: This file is part of the kim-api-v2.0.0-beta.1 package.
31 //
32 
33 
34 #ifndef KIM_COMPUTE_ARGUMENT_NAME_HPP_
35 #define KIM_COMPUTE_ARGUMENT_NAME_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 // Forward declaration
42 class DataType;
43 
45 {
46  public:
48 
50  ComputeArgumentName(int const id);
51  ComputeArgumentName(std::string const & str);
52  bool operator==(ComputeArgumentName const & rhs) const;
53  bool operator!=(ComputeArgumentName const & rhs) const;
54  std::string const & String() const;
55 };
56 
57 namespace COMPUTE_ARGUMENT_NAME
58 {
62 extern ComputeArgumentName const coordinates;
68 
69 void GetNumberOfComputeArgumentNames(int * const numberOfComputeArgumentNames);
70 int GetComputeArgumentName(int const index,
71  ComputeArgumentName * const computeArgumentName);
72 
73 int GetComputeArgumentDataType(ComputeArgumentName const computeArgumentName,
74  DataType * const dataType);
75 
76 struct Comparator
77 {
79  ComputeArgumentName const & b) const
80  {
82  }
83 };
84 } // namespace COMPUTE_ARGUMENT_NAME
85 } // namespace KIM
86 #endif // KIM_COMPUTE_ARGUMENT_NAME_HPP_
ComputeArgumentName const partialParticleEnergy
bool operator==(ComputeArgumentName const &rhs) const
ComputeArgumentName const coordinates
ComputeArgumentName const partialVirial
std::string const & String() const
void GetNumberOfComputeArgumentNames(int *const numberOfComputeArgumentNames)
ComputeArgumentName const particleContributing
ComputeArgumentName const partialEnergy
bool operator!=(ComputeArgumentName const &rhs) const
ComputeArgumentName const partialParticleVirial
ComputeArgumentName const partialForces
bool operator()(ComputeArgumentName const &a, ComputeArgumentName const &b) const
ComputeArgumentName const particleSpeciesCodes
ComputeArgumentName const numberOfParticles
int GetComputeArgumentDataType(ComputeArgumentName const computeArgumentName, DataType *const dataType)
int GetComputeArgumentName(int const index, ComputeArgumentName *const computeArgumentName)