KIM API V2
KIM_SpeciesName.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_SPECIES_NAME_HPP_
35 #define KIM_SPECIES_NAME_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
41 
43 {
44  public:
46 
47  SpeciesName();
48  SpeciesName(int const id);
49  SpeciesName(std::string const & str);
50  bool operator==(SpeciesName const & rhs) const;
51  bool operator!=(SpeciesName const & rhs) const;
52  std::string const & String() const;
53 };
54 
55 namespace SPECIES_NAME
56 {
57 extern SpeciesName const electron;
58 extern SpeciesName const H;
59 extern SpeciesName const He;
60 extern SpeciesName const Li;
61 extern SpeciesName const Be;
62 extern SpeciesName const B;
63 extern SpeciesName const C;
64 extern SpeciesName const N;
65 extern SpeciesName const O;
66 extern SpeciesName const F;
67 extern SpeciesName const Ne;
68 extern SpeciesName const Na;
69 extern SpeciesName const Mg;
70 extern SpeciesName const Al;
71 extern SpeciesName const Si;
72 extern SpeciesName const P;
73 extern SpeciesName const S;
74 extern SpeciesName const Cl;
75 extern SpeciesName const Ar;
76 extern SpeciesName const K;
77 extern SpeciesName const Ca;
78 extern SpeciesName const Sc;
79 extern SpeciesName const Ti;
80 extern SpeciesName const V;
81 extern SpeciesName const Cr;
82 extern SpeciesName const Mn;
83 extern SpeciesName const Fe;
84 extern SpeciesName const Co;
85 extern SpeciesName const Ni;
86 extern SpeciesName const Cu;
87 extern SpeciesName const Zn;
88 extern SpeciesName const Ga;
89 extern SpeciesName const Ge;
90 extern SpeciesName const As;
91 extern SpeciesName const Se;
92 extern SpeciesName const Br;
93 extern SpeciesName const Kr;
94 extern SpeciesName const Rb;
95 extern SpeciesName const Sr;
96 extern SpeciesName const Y;
97 extern SpeciesName const Zr;
98 extern SpeciesName const Nb;
99 extern SpeciesName const Mo;
100 extern SpeciesName const Tc;
101 extern SpeciesName const Ru;
102 extern SpeciesName const Rh;
103 extern SpeciesName const Pd;
104 extern SpeciesName const Ag;
105 extern SpeciesName const Cd;
106 extern SpeciesName const In;
107 extern SpeciesName const Sn;
108 extern SpeciesName const Sb;
109 extern SpeciesName const Te;
110 extern SpeciesName const I;
111 extern SpeciesName const Xe;
112 extern SpeciesName const Cs;
113 extern SpeciesName const Ba;
114 extern SpeciesName const La;
115 extern SpeciesName const Ce;
116 extern SpeciesName const Pr;
117 extern SpeciesName const Nd;
118 extern SpeciesName const Pm;
119 extern SpeciesName const Sm;
120 extern SpeciesName const Eu;
121 extern SpeciesName const Gd;
122 extern SpeciesName const Tb;
123 extern SpeciesName const Dy;
124 extern SpeciesName const Ho;
125 extern SpeciesName const Er;
126 extern SpeciesName const Tm;
127 extern SpeciesName const Yb;
128 extern SpeciesName const Lu;
129 extern SpeciesName const Hf;
130 extern SpeciesName const Ta;
131 extern SpeciesName const W;
132 extern SpeciesName const Re;
133 extern SpeciesName const Os;
134 extern SpeciesName const Ir;
135 extern SpeciesName const Pt;
136 extern SpeciesName const Au;
137 extern SpeciesName const Hg;
138 extern SpeciesName const Tl;
139 extern SpeciesName const Pb;
140 extern SpeciesName const Bi;
141 extern SpeciesName const Po;
142 extern SpeciesName const At;
143 extern SpeciesName const Rn;
144 extern SpeciesName const Fr;
145 extern SpeciesName const Ra;
146 extern SpeciesName const Ac;
147 extern SpeciesName const Th;
148 extern SpeciesName const Pa;
149 extern SpeciesName const U;
150 extern SpeciesName const Np;
151 extern SpeciesName const Pu;
152 extern SpeciesName const Am;
153 extern SpeciesName const Cm;
154 extern SpeciesName const Bk;
155 extern SpeciesName const Cf;
156 extern SpeciesName const Es;
157 extern SpeciesName const Fm;
158 extern SpeciesName const Md;
159 extern SpeciesName const No;
160 extern SpeciesName const Lr;
161 extern SpeciesName const Rf;
162 extern SpeciesName const Db;
163 extern SpeciesName const Sg;
164 extern SpeciesName const Bh;
165 extern SpeciesName const Hs;
166 extern SpeciesName const Mt;
167 extern SpeciesName const Ds;
168 extern SpeciesName const Rg;
169 extern SpeciesName const Cn;
170 extern SpeciesName const Uut;
171 extern SpeciesName const Fl;
172 extern SpeciesName const Uup;
173 extern SpeciesName const Lv;
174 extern SpeciesName const Uus;
175 extern SpeciesName const Uuo;
176 extern SpeciesName const user01;
177 extern SpeciesName const user02;
178 extern SpeciesName const user03;
179 extern SpeciesName const user04;
180 extern SpeciesName const user05;
181 extern SpeciesName const user06;
182 extern SpeciesName const user07;
183 extern SpeciesName const user08;
184 extern SpeciesName const user09;
185 extern SpeciesName const user10;
186 extern SpeciesName const user11;
187 extern SpeciesName const user12;
188 extern SpeciesName const user13;
189 extern SpeciesName const user14;
190 extern SpeciesName const user15;
191 extern SpeciesName const user16;
192 extern SpeciesName const user17;
193 extern SpeciesName const user18;
194 extern SpeciesName const user19;
195 extern SpeciesName const user20;
196 
197 void GetNumberOfSpeciesNames(int * const numberOfSpeciesNames);
198 int GetSpeciesName(int const index, SpeciesName * const speciesName);
199 
201 {
202  bool operator()(SpeciesName const & a, SpeciesName const & b) const
203  {
204  return a.speciesNameID < b.speciesNameID;
205  }
206 };
207 } // namespace SPECIES_NAME
208 } // namespace KIM
209 #endif // KIM_SPECIES_NAME_HPP_
SpeciesName const Pa
SpeciesName const user19
SpeciesName const Ru
SpeciesName const Ra
SpeciesName const Es
SpeciesName const Am
SpeciesName const Al
int GetSpeciesName(int const index, SpeciesName *const speciesName)
SpeciesName const user12
SpeciesName const Gd
SpeciesName const V
SpeciesName const Rb
SpeciesName const Au
SpeciesName const Ar
SpeciesName const Mg
SpeciesName const user08
SpeciesName const Ba
SpeciesName const Cm
SpeciesName const Tm
SpeciesName const Te
SpeciesName const Ga
SpeciesName const Zr
SpeciesName const user18
SpeciesName const B
SpeciesName const Sn
std::string const & String() const
SpeciesName const user07
SpeciesName const Nd
SpeciesName const La
SpeciesName const Os
SpeciesName const Li
SpeciesName const user01
SpeciesName const Na
SpeciesName const Zn
SpeciesName const Ge
SpeciesName const user14
SpeciesName const Po
SpeciesName const Th
SpeciesName const electron
SpeciesName const Nb
SpeciesName const Mt
SpeciesName const user04
SpeciesName const Cl
SpeciesName const user02
SpeciesName const Ac
SpeciesName const Cs
bool operator()(SpeciesName const &a, SpeciesName const &b) const
SpeciesName const I
SpeciesName const Ti
SpeciesName const Tb
SpeciesName const Ce
SpeciesName const Tl
SpeciesName const Fe
SpeciesName const Bi
SpeciesName const Ta
SpeciesName const S
SpeciesName const In
SpeciesName const Lu
SpeciesName const O
SpeciesName const Sb
SpeciesName const Bh
SpeciesName const user20
SpeciesName const Mn
SpeciesName const Kr
SpeciesName const U
SpeciesName const Rh
SpeciesName const Xe
SpeciesName const Hf
SpeciesName const Rn
SpeciesName const Ag
void GetNumberOfSpeciesNames(int *const numberOfSpeciesNames)
SpeciesName const user13
SpeciesName const Db
SpeciesName const Uuo
SpeciesName const Sg
SpeciesName const Pt
SpeciesName const user09
SpeciesName const user15
SpeciesName const Co
SpeciesName const Ds
SpeciesName const Ne
SpeciesName const K
SpeciesName const Pm
SpeciesName const H
SpeciesName const Np
SpeciesName const Lr
SpeciesName const Cf
SpeciesName const user11
SpeciesName const At
SpeciesName const F
SpeciesName const Cn
SpeciesName const user03
SpeciesName const Ir
SpeciesName const Si
SpeciesName const Ni
SpeciesName const Eu
SpeciesName const Se
SpeciesName const No
SpeciesName const Pb
SpeciesName const user17
SpeciesName const Tc
SpeciesName const Pd
SpeciesName const C
SpeciesName const Sr
SpeciesName const Uut
SpeciesName const Yb
SpeciesName const Br
bool operator==(SpeciesName const &rhs) const
SpeciesName const Pr
SpeciesName const Lv
SpeciesName const Fr
SpeciesName const Bk
SpeciesName const Ho
SpeciesName const Re
SpeciesName const N
SpeciesName const Ca
SpeciesName const Cu
SpeciesName const Dy
SpeciesName const P
SpeciesName const Hg
SpeciesName const Er
SpeciesName const Be
SpeciesName const Hs
SpeciesName const Uus
SpeciesName const Mo
SpeciesName const Fm
SpeciesName const As
SpeciesName const Fl
SpeciesName const user06
SpeciesName const W
SpeciesName const user05
SpeciesName const Cr
SpeciesName const user10
SpeciesName const Cd
SpeciesName const Rg
SpeciesName const Sm
SpeciesName const Pu
SpeciesName const Uup
SpeciesName const Y
SpeciesName const He
SpeciesName const user16
SpeciesName const Rf
bool operator!=(SpeciesName const &rhs) const
SpeciesName const Sc
SpeciesName const Md