kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
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--2019, 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.git repository.
31 //
32 
33 
34 #ifndef KIM_SPECIES_NAME_HPP_
35 #define KIM_SPECIES_NAME_HPP_
36 
37 #include <string>
38 
39 namespace KIM
40 {
50 {
51  public:
62 
66  SpeciesName();
67 
73  SpeciesName(int const id);
74 
82  SpeciesName(std::string const & str);
83 
92  bool Known() const;
93 
101  bool operator==(SpeciesName const & rhs) const;
102 
110  bool operator!=(SpeciesName const & rhs) const;
111 
122  std::string const & ToString() const;
123 }; // class SpeciesName
124 
127 namespace SPECIES_NAME
128 {
135 extern SpeciesName const electron;
136 
142 extern SpeciesName const H;
143 
149 extern SpeciesName const He;
150 
156 extern SpeciesName const Li;
157 
163 extern SpeciesName const Be;
164 
170 extern SpeciesName const B;
171 
177 extern SpeciesName const C;
178 
184 extern SpeciesName const N;
185 
191 extern SpeciesName const O;
192 
198 extern SpeciesName const F;
199 
205 extern SpeciesName const Ne;
206 
212 extern SpeciesName const Na;
213 
219 extern SpeciesName const Mg;
220 
226 extern SpeciesName const Al;
227 
233 extern SpeciesName const Si;
234 
240 extern SpeciesName const P;
241 
247 extern SpeciesName const S;
248 
254 extern SpeciesName const Cl;
255 
261 extern SpeciesName const Ar;
262 
268 extern SpeciesName const K;
269 
275 extern SpeciesName const Ca;
276 
282 extern SpeciesName const Sc;
283 
289 extern SpeciesName const Ti;
290 
296 extern SpeciesName const V;
297 
303 extern SpeciesName const Cr;
304 
310 extern SpeciesName const Mn;
311 
317 extern SpeciesName const Fe;
318 
324 extern SpeciesName const Co;
325 
331 extern SpeciesName const Ni;
332 
338 extern SpeciesName const Cu;
339 
345 extern SpeciesName const Zn;
346 
352 extern SpeciesName const Ga;
353 
359 extern SpeciesName const Ge;
360 
366 extern SpeciesName const As;
367 
373 extern SpeciesName const Se;
374 
380 extern SpeciesName const Br;
381 
387 extern SpeciesName const Kr;
388 
394 extern SpeciesName const Rb;
395 
401 extern SpeciesName const Sr;
402 
408 extern SpeciesName const Y;
409 
415 extern SpeciesName const Zr;
416 
422 extern SpeciesName const Nb;
423 
429 extern SpeciesName const Mo;
430 
436 extern SpeciesName const Tc;
437 
443 extern SpeciesName const Ru;
444 
450 extern SpeciesName const Rh;
451 
457 extern SpeciesName const Pd;
458 
464 extern SpeciesName const Ag;
465 
471 extern SpeciesName const Cd;
472 
478 extern SpeciesName const In;
479 
485 extern SpeciesName const Sn;
486 
492 extern SpeciesName const Sb;
493 
499 extern SpeciesName const Te;
500 
506 extern SpeciesName const I;
507 
513 extern SpeciesName const Xe;
514 
520 extern SpeciesName const Cs;
521 
527 extern SpeciesName const Ba;
528 
534 extern SpeciesName const La;
535 
541 extern SpeciesName const Ce;
542 
548 extern SpeciesName const Pr;
549 
555 extern SpeciesName const Nd;
556 
562 extern SpeciesName const Pm;
563 
569 extern SpeciesName const Sm;
570 
576 extern SpeciesName const Eu;
577 
583 extern SpeciesName const Gd;
584 
590 extern SpeciesName const Tb;
591 
597 extern SpeciesName const Dy;
598 
604 extern SpeciesName const Ho;
605 
611 extern SpeciesName const Er;
612 
618 extern SpeciesName const Tm;
619 
625 extern SpeciesName const Yb;
626 
632 extern SpeciesName const Lu;
633 
639 extern SpeciesName const Hf;
640 
646 extern SpeciesName const Ta;
647 
653 extern SpeciesName const W;
654 
660 extern SpeciesName const Re;
661 
667 extern SpeciesName const Os;
668 
674 extern SpeciesName const Ir;
675 
681 extern SpeciesName const Pt;
682 
688 extern SpeciesName const Au;
689 
695 extern SpeciesName const Hg;
696 
702 extern SpeciesName const Tl;
703 
709 extern SpeciesName const Pb;
710 
716 extern SpeciesName const Bi;
717 
723 extern SpeciesName const Po;
724 
730 extern SpeciesName const At;
731 
737 extern SpeciesName const Rn;
738 
744 extern SpeciesName const Fr;
745 
751 extern SpeciesName const Ra;
752 
758 extern SpeciesName const Ac;
759 
765 extern SpeciesName const Th;
766 
772 extern SpeciesName const Pa;
773 
779 extern SpeciesName const U;
780 
786 extern SpeciesName const Np;
787 
793 extern SpeciesName const Pu;
794 
800 extern SpeciesName const Am;
801 
807 extern SpeciesName const Cm;
808 
814 extern SpeciesName const Bk;
815 
821 extern SpeciesName const Cf;
822 
828 extern SpeciesName const Es;
829 
835 extern SpeciesName const Fm;
836 
842 extern SpeciesName const Md;
843 
849 extern SpeciesName const No;
850 
856 extern SpeciesName const Lr;
857 
863 extern SpeciesName const Rf;
864 
870 extern SpeciesName const Db;
871 
877 extern SpeciesName const Sg;
878 
884 extern SpeciesName const Bh;
885 
891 extern SpeciesName const Hs;
892 
898 extern SpeciesName const Mt;
899 
905 extern SpeciesName const Ds;
906 
912 extern SpeciesName const Rg;
913 
919 extern SpeciesName const Cn;
920 
926 extern SpeciesName const Nh;
927 
933 extern SpeciesName const Fl;
934 
940 extern SpeciesName const Mc;
941 
947 extern SpeciesName const Lv;
948 
954 extern SpeciesName const Ts;
955 
961 extern SpeciesName const Og;
962 
969 extern SpeciesName const user01;
970 
977 extern SpeciesName const user02;
978 
985 extern SpeciesName const user03;
986 
993 extern SpeciesName const user04;
994 
1001 extern SpeciesName const user05;
1002 
1009 extern SpeciesName const user06;
1010 
1017 extern SpeciesName const user07;
1018 
1025 extern SpeciesName const user08;
1026 
1033 extern SpeciesName const user09;
1034 
1041 extern SpeciesName const user10;
1042 
1049 extern SpeciesName const user11;
1050 
1057 extern SpeciesName const user12;
1058 
1065 extern SpeciesName const user13;
1066 
1073 extern SpeciesName const user14;
1074 
1081 extern SpeciesName const user15;
1082 
1089 extern SpeciesName const user16;
1090 
1097 extern SpeciesName const user17;
1098 
1105 extern SpeciesName const user18;
1106 
1113 extern SpeciesName const user19;
1114 
1121 extern SpeciesName const user20;
1122 
1123 
1133 void GetNumberOfSpeciesNames(int * const numberOfSpeciesNames);
1134 
1149 int GetSpeciesName(int const index, SpeciesName * const speciesName);
1150 
1155 {
1160  bool operator()(SpeciesName const & a, SpeciesName const & b) const
1161  {
1162  return a.speciesNameID < b.speciesNameID;
1163  }
1164 }; // struct Comparator
1165 } // namespace SPECIES_NAME
1166 } // namespace KIM
1167 
1168 #endif // KIM_SPECIES_NAME_HPP_
SpeciesName const Pa
The standard Protactinium species.
SpeciesName const user19
The standard user19 species.
SpeciesName const Ru
The standard Ruthenium species.
SpeciesName const Ra
The standard Radium species.
SpeciesName const Es
The standard Einsteinium species.
SpeciesName const Am
The standard Americium species.
SpeciesName const Al
The standard Aluminum species.
SpeciesName const Ts
The standard Tennessine species.
int GetSpeciesName(int const index, SpeciesName *const speciesName)
Get the identity of each defined standard SpeciesName.
SpeciesName const user12
The standard user12 species.
SpeciesName const Gd
The standard Gadolinium species.
SpeciesName const V
The standard Vanadium species.
SpeciesName const Rb
The standard Rubidium species.
SpeciesName const Au
The standard Gold species.
SpeciesName const Nh
The standard Nihonium species.
SpeciesName const Ar
The standard Argon species.
SpeciesName const Mg
The standard Magnesium species.
SpeciesName const user08
The standard user08 species.
SpeciesName const Ba
The standard Barium species.
SpeciesName const Cm
The standard Curium species.
SpeciesName const Tm
The standard Thulium species.
SpeciesName const Te
The standard Tellurium species.
SpeciesName const Ga
The standard Gallium species.
SpeciesName const Zr
The standard Zirconium species.
SpeciesName const user18
The standard user18 species.
SpeciesName const B
The standard Boron species.
SpeciesName const Sn
The standard Tin species.
SpeciesName const user07
The standard user07 species.
SpeciesName const Nd
The standard Neodymium species.
SpeciesName const La
The standard Lanthanum species.
SpeciesName const Os
The standard Osmium species.
SpeciesName const Li
The standard Lithium species.
SpeciesName const user01
The standard user01 species.
SpeciesName const Na
The standard Sodium species.
SpeciesName const Zn
The standard Zinc species.
SpeciesName const Ge
The standard Germanium species.
SpeciesName const user14
The standard user14 species.
SpeciesName const Po
The standard Polonium species.
SpeciesName const Th
The standard Thorium species.
SpeciesName const electron
The standard electron species.
SpeciesName const Mc
The standard Moscovium species.
SpeciesName const Nb
The standard Niobium species.
SpeciesName const Mt
The standard Meitnerium species.
SpeciesName const user04
The standard user04 species.
SpeciesName const Cl
The standard Chlorine species.
SpeciesName const user02
The standard user02 species.
SpeciesName const Ac
The standard Actinium species.
SpeciesName const Cs
The standard Cesium species.
bool operator()(SpeciesName const &a, SpeciesName const &b) const
Provides an (logically unmeaningful) ordering for SpeciesName objects so that they can be stored in a...
SpeciesName const I
The standard Iodine species.
SpeciesName const Ti
The standard Titanium species.
SpeciesName const Tb
The standard Terbium species.
SpeciesName const Ce
The standard Cerium species.
SpeciesName const Tl
The standard Thallium species.
SpeciesName const Fe
The standard Iron species.
SpeciesName const Bi
The standard Bismuth species.
SpeciesName const Ta
The standard Tantalum species.
bool Known() const
Determines if the object is a quantity known to the KIM API.
SpeciesName const S
The standard Sulfur species.
SpeciesName const In
The standard Indium species.
SpeciesName const Lu
The standard Lutetium species.
SpeciesName const O
The standard Oxygen species.
SpeciesName const Sb
The standard Antimony species.
SpeciesName const Bh
The standard Bohrium species.
SpeciesName const user20
The standard user20 species.
SpeciesName const Mn
The standard Manganese species.
SpeciesName const Kr
The standard Krypton species.
SpeciesName const U
The standard Uranium species.
Structure provided for use with std::map.
SpeciesName const Rh
The standard Rhodium species.
SpeciesName const Xe
The standard Xenon species.
SpeciesName const Hf
The standard Hafnium species.
SpeciesName const Rn
The standard Radon species.
SpeciesName const Ag
The standard Silver species.
int speciesNameID
Integer identifying the specific SpeciesName represented.
void GetNumberOfSpeciesNames(int *const numberOfSpeciesNames)
Get the number of standard SpeciesName&#39;s defined by the KIM API.
SpeciesName const user13
The standard user13 species.
SpeciesName const Db
The standard Dubnium species.
SpeciesName const Sg
The standard Seaborgium species.
SpeciesName const Pt
The standard Platinum species.
SpeciesName const user09
The standard user09 species.
SpeciesName const user15
The standard user15 species.
SpeciesName const Co
The standard Cobalt species.
SpeciesName const Ds
The standard Darmstadtium species.
SpeciesName const Ne
The standard Neon species.
SpeciesName const K
The standard Potassium species.
SpeciesName const Pm
The standard Promethium species.
SpeciesName const H
The standard Hydrogen species.
SpeciesName const Np
The standard Neptunium species.
SpeciesName const Lr
The standard Lawrencium species.
SpeciesName const Cf
The standard Californium species.
SpeciesName const user11
The standard user11 species.
SpeciesName const At
The standard Astatine species.
SpeciesName const F
The standard Fluorine species.
SpeciesName const Cn
The standard Copernicium species.
SpeciesName const user03
The standard user03 species.
SpeciesName const Ir
The standard Iridium species.
SpeciesName const Si
The standard Silicon species.
SpeciesName const Ni
The standard Nickel species.
SpeciesName const Eu
The standard Europium species.
SpeciesName()
Create an uninitialized SpeciesName object.
SpeciesName const Se
The standard Selenium species.
SpeciesName const No
The standard Nobelium species.
SpeciesName const Pb
The standard Lead species.
SpeciesName const user17
The standard user17 species.
SpeciesName const Tc
The standard Technetium species.
std::string const & ToString() const
Converts the object to a string.
SpeciesName const Pd
The standard Palladium species.
SpeciesName const C
The standard Carbon species.
SpeciesName const Sr
The standard Strontium species.
SpeciesName const Yb
The standard Ytterbium species.
SpeciesName const Br
The standard Bromine species.
bool operator==(SpeciesName const &rhs) const
Compares SpeciesName objects for equality.
SpeciesName const Pr
The standard Praseodymium species.
SpeciesName const Lv
The standard Livermorium species.
SpeciesName const Fr
The standard Francium species.
SpeciesName const Bk
The standard Berkelium species.
SpeciesName const Ho
The standard Holmium species.
SpeciesName const Re
The standard Rhenium species.
SpeciesName const N
The standard Nitrogen species.
SpeciesName const Ca
The standard Calcium species.
SpeciesName const Cu
The standard Copper species.
SpeciesName const Dy
The standard Dysprosium species.
SpeciesName const P
The standard Phosphorus species.
SpeciesName const Hg
The standard Mercury species.
SpeciesName const Er
The standard Erbium species.
SpeciesName const Be
The standard Beryllium species.
SpeciesName const Hs
The standard Hassium species.
SpeciesName const Mo
The standard Molybdenum species.
SpeciesName const Fm
The standard Fermium species.
SpeciesName const As
The standard Arsenic species.
SpeciesName const Fl
The standard Flerovium species.
SpeciesName const user06
The standard user06 species.
SpeciesName const W
The standard Tungsten species.
SpeciesName const user05
The standard user05 species.
SpeciesName const Cr
The standard Chromium species.
SpeciesName const user10
The standard user10 species.
SpeciesName const Cd
The standard Cadmium species.
An Extensible Enumeration for the SpeciesName&#39;s supported by the KIM API.
SpeciesName const Rg
The standard Roentgenium species.
SpeciesName const Sm
The standard Samarium species.
SpeciesName const Og
The standard Oganesson species.
SpeciesName const Pu
The standard Plutonium species.
SpeciesName const Y
The standard Yttrium species.
SpeciesName const He
The standard Helium species.
SpeciesName const user16
The standard user16 species.
SpeciesName const Rf
The standard Rutherfordium species.
bool operator!=(SpeciesName const &rhs) const
Compares SpeciesName objects for inequality.
SpeciesName const Sc
The standard Scandium species.
SpeciesName const Md
The standard Mendelevium species.