KIM API V2
KIM_ChargeUnit.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.0 package.
31 //
32 
33 
34 #ifndef KIM_CHARGE_UNIT_HPP_
35 #define KIM_CHARGE_UNIT_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 
43 {
44  public:
46 
47  ChargeUnit();
48  ChargeUnit(int const id);
49  ChargeUnit(std::string const & str);
50  bool operator==(ChargeUnit const & rhs) const;
51  bool operator!=(ChargeUnit const & rhs) const;
52  std::string const & String() const;
53 };
54 
55 namespace CHARGE_UNIT
56 {
57 extern ChargeUnit const unused;
58 extern ChargeUnit const C;
59 extern ChargeUnit const e;
60 extern ChargeUnit const statC;
61 
62 void GetNumberOfChargeUnits(int * const numberOfChargeUnits);
63 int GetChargeUnit(int const index, ChargeUnit * const chargeUnit);
64 
65 struct Comparator
66 {
67  bool operator()(ChargeUnit const & a, ChargeUnit const & b) const
68  {
69  return a.chargeUnitID < b.chargeUnitID;
70  }
71 };
72 } // namespace CHARGE_UNIT
73 } // namespace KIM
74 #endif // KIM_CHARGE_UNIT_HPP_
bool operator==(ChargeUnit const &rhs) const
ChargeUnit const unused
ChargeUnit const e
ChargeUnit const statC
ChargeUnit const C
bool operator!=(ChargeUnit const &rhs) const
bool operator()(ChargeUnit const &a, ChargeUnit const &b) const
std::string const & String() const
void GetNumberOfChargeUnits(int *const numberOfChargeUnits)
int GetChargeUnit(int const index, ChargeUnit *const chargeUnit)