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.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--2019, 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.git repository. */
33 /* */
34 
35 
36 #ifndef KIM_SPECIES_NAME_H_
37 #define KIM_SPECIES_NAME_H_
38 
47 {
57 };
58 
59 #ifndef KIM_SPECIES_NAME_DEFINED_
60 #define KIM_SPECIES_NAME_DEFINED_
61 
67 #endif
68 
77 KIM_SpeciesName KIM_SpeciesName_FromString(char const * const str);
78 
86 int KIM_SpeciesName_Known(KIM_SpeciesName const speciesName);
87 
95 int KIM_SpeciesName_Equal(KIM_SpeciesName const lhs, KIM_SpeciesName const rhs);
96 
105  KIM_SpeciesName const rhs);
106 
114 char const * KIM_SpeciesName_ToString(KIM_SpeciesName const speciesName);
115 
125 
134 
179 
188 
197 
206 
215 
224 
233 
242 
251 
260 
269 
278 
287 
296 
305 
314 
323 
332 
341 
350 
359 
368 
377 
386 
395 
404 
413 
422 
431 
440 
449 
458 
467 
476 
485 
494 
503 
512 
521 
530 
539 
548 
557 
566 
575 
584 
593 
602 
611 
620 
629 
638 
647 
656 
665 
674 
683 
692 
701 
710 
719 
728 
737 
746 
755 
764 
773 
782 
791 
800 
809 
818 
827 
836 
845 
854 
863 
872 
881 
890 
899 
908 
917 
926 
935 
944 
953 
962 
971 
980 
989 
998 
1007 
1016 
1025 
1034 
1043 
1052 
1061 
1070 
1079 
1088 
1097 
1106 
1115 
1124 
1133 
1142 
1151 
1160 
1169 
1178 
1187 
1197 
1207 
1217 
1227 
1237 
1247 
1257 
1267 
1277 
1287 
1297 
1307 
1317 
1327 
1337 
1347 
1357 
1367 
1377 
1387 
1396 void KIM_SPECIES_NAME_GetNumberOfSpeciesNames(int * const numberOfSpeciesNames);
1397 
1406 int KIM_SPECIES_NAME_GetSpeciesName(int const index,
1407  KIM_SpeciesName * const speciesName);
1408 
1409 #endif /* KIM_SPECIES_NAME_H_ */
KIM_SpeciesName const KIM_SPECIES_NAME_Ne
The standard Neon species.
KIM_SpeciesName const KIM_SPECIES_NAME_Y
The standard Yttrium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rn
The standard Radon species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rf
The standard Rutherfordium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Tc
The standard Technetium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Og
The standard Oganesson species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sn
The standard Tin species.
KIM_SpeciesName const KIM_SPECIES_NAME_He
The standard Helium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fr
The standard Francium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sc
The standard Scandium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user12
The standard user12 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Db
The standard Dubnium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ta
The standard Tantalum species.
KIM_SpeciesName const KIM_SPECIES_NAME_user08
The standard user08 species.
KIM_SpeciesName const KIM_SPECIES_NAME_K
The standard Potassium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user19
The standard user19 species.
KIM_SpeciesName const KIM_SPECIES_NAME_user18
The standard user18 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Xe
The standard Xenon species.
KIM_SpeciesName const KIM_SPECIES_NAME_Al
The standard Aluminum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mo
The standard Molybdenum species.
KIM_SpeciesName const KIM_SPECIES_NAME_user02
The standard user02 species.
KIM_SpeciesName const KIM_SPECIES_NAME_user17
The standard user17 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ac
The standard Actinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Nd
The standard Neodymium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Th
The standard Thorium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cl
The standard Chlorine species.
int KIM_SpeciesName_NotEqual(KIM_SpeciesName const lhs, KIM_SpeciesName const rhs)
Compares SpeciesName objects for inequality.
KIM_SpeciesName const KIM_SPECIES_NAME_Mg
The standard Magnesium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ga
The standard Gallium species.
KIM_SpeciesName const KIM_SPECIES_NAME_I
The standard Iodine species.
KIM_SpeciesName const KIM_SPECIES_NAME_electron
The standard electron species.
KIM_SpeciesName const KIM_SPECIES_NAME_La
The standard Lanthanum species.
char const * KIM_SpeciesName_ToString(KIM_SpeciesName const speciesName)
Converts the object to a string.
KIM_SpeciesName const KIM_SPECIES_NAME_Po
The standard Polonium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mn
The standard Manganese species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mt
The standard Meitnerium species.
KIM_SpeciesName KIM_SpeciesName_FromString(char const *const str)
Create a SpeciesName object corresponding to the provided string. If the string does not match one of...
KIM_SpeciesName const KIM_SPECIES_NAME_P
The standard Phosphorus species.
KIM_SpeciesName const KIM_SPECIES_NAME_Si
The standard Silicon species.
int KIM_SPECIES_NAME_GetSpeciesName(int const index, KIM_SpeciesName *const speciesName)
Get the identity of each defined standard SpeciesName.
KIM_SpeciesName const KIM_SPECIES_NAME_Au
The standard Gold species.
KIM_SpeciesName const KIM_SPECIES_NAME_Bi
The standard Bismuth species.
KIM_SpeciesName const KIM_SPECIES_NAME_S
The standard Sulfur species.
KIM_SpeciesName const KIM_SPECIES_NAME_Co
The standard Cobalt species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sg
The standard Seaborgium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Tm
The standard Thulium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Os
The standard Osmium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ts
The standard Tennessine species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fe
The standard Iron species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ar
The standard Argon species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fl
The standard Flerovium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Yb
The standard Ytterbium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Na
The standard Sodium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user14
The standard user14 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ce
The standard Cerium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cd
The standard Cadmium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Tb
The standard Terbium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sr
The standard Strontium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cf
The standard Californium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fm
The standard Fermium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ca
The standard Calcium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Es
The standard Einsteinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user01
The standard user01 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ba
The standard Barium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user03
The standard user03 species.
KIM_SpeciesName const KIM_SPECIES_NAME_B
The standard Boron species.
KIM_SpeciesName const KIM_SPECIES_NAME_Gd
The standard Gadolinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rh
The standard Rhodium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ru
The standard Ruthenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pa
The standard Protactinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Re
The standard Rhenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mc
The standard Moscovium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Lv
The standard Livermorium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Dy
The standard Dysprosium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Hg
The standard Mercury species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pm
The standard Promethium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Be
The standard Beryllium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Er
The standard Erbium species.
KIM_SpeciesName const KIM_SPECIES_NAME_At
The standard Astatine species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cu
The standard Copper species.
KIM_SpeciesName const KIM_SPECIES_NAME_user06
The standard user06 species.
KIM_SpeciesName const KIM_SPECIES_NAME_user13
The standard user13 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Zr
The standard Zirconium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pb
The standard Lead species.
KIM_SpeciesName const KIM_SPECIES_NAME_H
The standard Hydrogen species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pu
The standard Plutonium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Hf
The standard Hafnium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pd
The standard Palladium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Am
The standard Americium species.
KIM_SpeciesName const KIM_SPECIES_NAME_W
The standard Tungsten species.
KIM_SpeciesName const KIM_SPECIES_NAME_user16
The standard user16 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Md
The standard Mendelevium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Nb
The standard Niobium species.
KIM_SpeciesName const KIM_SPECIES_NAME_As
The standard Arsenic species.
KIM_SpeciesName const KIM_SPECIES_NAME_user11
The standard user11 species.
KIM_SpeciesName const KIM_SPECIES_NAME_user04
The standard user04 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ni
The standard Nickel species.
KIM_SpeciesName const KIM_SPECIES_NAME_V
The standard Vanadium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cs
The standard Cesium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Kr
The standard Krypton species.
KIM_SpeciesName const KIM_SPECIES_NAME_N
The standard Nitrogen species.
KIM_SpeciesName const KIM_SPECIES_NAME_Tl
The standard Thallium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user09
The standard user09 species.
int KIM_SpeciesName_Equal(KIM_SpeciesName const lhs, KIM_SpeciesName const rhs)
Compares SpeciesName objects for equality.
KIM_SpeciesName const KIM_SPECIES_NAME_Lr
The standard Lawrencium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Zn
The standard Zinc species.
KIM_SpeciesName const KIM_SPECIES_NAME_O
The standard Oxygen species.
KIM_SpeciesName const KIM_SPECIES_NAME_Br
The standard Bromine species.
KIM_SpeciesName const KIM_SPECIES_NAME_Np
The standard Neptunium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pr
The standard Praseodymium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ds
The standard Darmstadtium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user07
The standard user07 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Li
The standard Lithium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user20
The standard user20 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ti
The standard Titanium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Lu
The standard Lutetium species.
void KIM_SPECIES_NAME_GetNumberOfSpeciesNames(int *const numberOfSpeciesNames)
Get the number of standard SpeciesName's defined by the KIM API.
KIM_SpeciesName const KIM_SPECIES_NAME_Rg
The standard Roentgenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cn
The standard Copernicium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user05
The standard user05 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ra
The standard Radium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user15
The standard user15 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ag
The standard Silver species.
KIM_SpeciesName const KIM_SPECIES_NAME_Se
The standard Selenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Bh
The standard Bohrium species.
int KIM_SpeciesName_Known(KIM_SpeciesName const speciesName)
Determines if the object is a quantity known to the KIM API.
KIM_SpeciesName const KIM_SPECIES_NAME_No
The standard Nobelium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Bk
The standard Berkelium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Hs
The standard Hassium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cm
The standard Curium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ho
The standard Holmium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Te
The standard Tellurium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cr
The standard Chromium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Nh
The standard Nihonium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ir
The standard Iridium species.
KIM_SpeciesName const KIM_SPECIES_NAME_U
The standard Uranium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pt
The standard Platinum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rb
The standard Rubidium species.
KIM_SpeciesName const KIM_SPECIES_NAME_C
The standard Carbon species.
int speciesNameID
Integer identifying the specific SpeciesName represented.
KIM_SpeciesName const KIM_SPECIES_NAME_Eu
The standard Europium species.
KIM_SpeciesName const KIM_SPECIES_NAME_In
The standard Indium species.
An Extensible Enumeration for the SpeciesName's supported by the KIM API.
KIM_SpeciesName const KIM_SPECIES_NAME_user10
The standard user10 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ge
The standard Germanium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sm
The standard Samarium species.
KIM_SpeciesName const KIM_SPECIES_NAME_F
The standard Fluorine species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sb
The standard Antimony species.