kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_SpeciesName.h
Go to the documentation of this file.
1/* */
2/* KIM-API: An API for interatomic models */
3/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4/* All rights reserved. */
5/* */
6/* Contributors: */
7/* Ryan S. Elliott */
8/* */
9/* SPDX-License-Identifier: LGPL-2.1-or-later */
10/* */
11/* This library is free software; you can redistribute it and/or */
12/* modify it under the terms of the GNU Lesser General Public */
13/* License as published by the Free Software Foundation; either */
14/* version 2.1 of the License, or (at your option) any later version. */
15/* */
16/* This library is distributed in the hope that it will be useful, */
17/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19/* Lesser General Public License for more details. */
20/* */
21/* You should have received a copy of the GNU Lesser General Public License */
22/* along with this library; if not, write to the Free Software Foundation, */
23/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24/* */
25
26/* */
27/* Release: This file is part of the kim-api-2.3.0 package. */
28/* */
29
30
31#ifndef KIM_SPECIES_NAME_H_
32#define KIM_SPECIES_NAME_H_
33
42{
52};
53
54#ifndef KIM_SPECIES_NAME_DEFINED_
55#define KIM_SPECIES_NAME_DEFINED_
62#endif
63
73
82
91
100 KIM_SpeciesName const rhs);
101
109char const * KIM_SpeciesName_ToString(KIM_SpeciesName const speciesName);
110
120
129
174
183
192
201
210
219
228
237
246
255
264
273
282
291
300
309
318
327
336
345
354
363
372
381
390
399
408
417
426
435
444
453
462
471
480
489
498
507
516
525
534
543
552
561
570
579
588
597
606
615
624
633
642
651
660
669
678
687
696
705
714
723
732
741
750
759
768
777
786
795
804
813
822
831
840
849
858
867
876
885
894
903
912
921
930
939
948
957
966
975
984
993
1002
1011
1020
1029
1038
1047
1056
1065
1074
1083
1092
1101
1110
1119
1128
1137
1146
1155
1164
1173
1182
1192
1202
1212
1222
1232
1242
1252
1262
1272
1282
1292
1302
1312
1322
1332
1342
1352
1362
1372
1382
1391void KIM_SPECIES_NAME_GetNumberOfSpeciesNames(int * const numberOfSpeciesNames);
1392
1402 KIM_SpeciesName * const speciesName);
1403
1404#endif /* KIM_SPECIES_NAME_H_ */
KIM_SpeciesName const KIM_SPECIES_NAME_Tc
The standard Technetium species.
KIM_SpeciesName const KIM_SPECIES_NAME_O
The standard Oxygen species.
KIM_SpeciesName const KIM_SPECIES_NAME_As
The standard Arsenic species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ir
The standard Iridium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user16
The standard user16 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ts
The standard Tennessine species.
KIM_SpeciesName const KIM_SPECIES_NAME_He
The standard Helium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pm
The standard Promethium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Zn
The standard Zinc species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ga
The standard Gallium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Y
The standard Yttrium species.
int KIM_SpeciesName_Equal(KIM_SpeciesName const lhs, KIM_SpeciesName const rhs)
Compares SpeciesName objects for equality.
KIM_SpeciesName const KIM_SPECIES_NAME_Cs
The standard Cesium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sb
The standard Antimony species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ra
The standard Radium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user03
The standard user03 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Np
The standard Neptunium species.
char const * KIM_SpeciesName_ToString(KIM_SpeciesName const speciesName)
Converts the object to a string.
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_Pd
The standard Palladium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Lr
The standard Lawrencium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Co
The standard Cobalt species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pt
The standard Platinum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Si
The standard Silicon species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ca
The standard Calcium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Al
The standard Aluminum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Br
The standard Bromine species.
KIM_SpeciesName const KIM_SPECIES_NAME_user13
The standard user13 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ds
The standard Darmstadtium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rf
The standard Rutherfordium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Db
The standard Dubnium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Am
The standard Americium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ta
The standard Tantalum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cd
The standard Cadmium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user06
The standard user06 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Te
The standard Tellurium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Th
The standard Thorium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cu
The standard Copper species.
KIM_SpeciesName const KIM_SPECIES_NAME_Re
The standard Rhenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Hf
The standard Hafnium 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_Md
The standard Mendelevium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Yb
The standard Ytterbium species.
KIM_SpeciesName const KIM_SPECIES_NAME_F
The standard Fluorine species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ba
The standard Barium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ne
The standard Neon species.
KIM_SpeciesName const KIM_SPECIES_NAME_user05
The standard user05 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Lu
The standard Lutetium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ti
The standard Titanium 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_Sn
The standard Tin species.
KIM_SpeciesName const KIM_SPECIES_NAME_U
The standard Uranium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mg
The standard Magnesium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Bi
The standard Bismuth species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sc
The standard Scandium 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_user01
The standard user01 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ag
The standard Silver species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rn
The standard Radon 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_S
The standard Sulfur species.
KIM_SpeciesName const KIM_SPECIES_NAME_C
The standard Carbon species.
KIM_SpeciesName const KIM_SPECIES_NAME_user18
The standard user18 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Na
The standard Sodium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ge
The standard Germanium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ru
The standard Ruthenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Eu
The standard Europium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user14
The standard user14 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Er
The standard Erbium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Po
The standard Polonium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ho
The standard Holmium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Hg
The standard Mercury species.
KIM_SpeciesName const KIM_SPECIES_NAME_electron
The standard electron species.
KIM_SpeciesName const KIM_SPECIES_NAME_Au
The standard Gold species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rg
The standard Roentgenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Dy
The standard Dysprosium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fl
The standard Flerovium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Zr
The standard Zirconium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user04
The standard user04 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Lv
The standard Livermorium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cn
The standard Copernicium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fr
The standard Francium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pa
The standard Protactinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user12
The standard user12 species.
KIM_SpeciesName const KIM_SPECIES_NAME_V
The standard Vanadium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user09
The standard user09 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Tl
The standard Thallium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Kr
The standard Krypton species.
KIM_SpeciesName const KIM_SPECIES_NAME_Nb
The standard Niobium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Es
The standard Einsteinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Gd
The standard Gadolinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user17
The standard user17 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cf
The standard Californium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Og
The standard Oganesson species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fm
The standard Fermium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Nd
The standard Neodymium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user20
The standard user20 species.
KIM_SpeciesName const KIM_SPECIES_NAME_user11
The standard user11 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Xe
The standard Xenon species.
KIM_SpeciesName const KIM_SPECIES_NAME_B
The standard Boron species.
KIM_SpeciesName const KIM_SPECIES_NAME_Li
The standard Lithium 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_Cm
The standard Curium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sr
The standard Strontium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ni
The standard Nickel species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mn
The standard Manganese species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sm
The standard Samarium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Tb
The standard Terbium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Be
The standard Beryllium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mo
The standard Molybdenum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Cl
The standard Chlorine species.
KIM_SpeciesName const KIM_SPECIES_NAME_user15
The standard user15 species.
KIM_SpeciesName const KIM_SPECIES_NAME_W
The standard Tungsten species.
KIM_SpeciesName const KIM_SPECIES_NAME_P
The standard Phosphorus species.
KIM_SpeciesName const KIM_SPECIES_NAME_K
The standard Potassium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user07
The standard user07 species.
KIM_SpeciesName const KIM_SPECIES_NAME_Sg
The standard Seaborgium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Bh
The standard Bohrium species.
KIM_SpeciesName const KIM_SPECIES_NAME_H
The standard Hydrogen species.
KIM_SpeciesName const KIM_SPECIES_NAME_La
The standard Lanthanum species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pr
The standard Praseodymium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ce
The standard Cerium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pb
The standard Lead species.
int KIM_SpeciesName_NotEqual(KIM_SpeciesName const lhs, KIM_SpeciesName const rhs)
Compares SpeciesName objects for inequality.
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_Ac
The standard Actinium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mc
The standard Moscovium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Pu
The standard Plutonium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user19
The standard user19 species.
KIM_SpeciesName const KIM_SPECIES_NAME_No
The standard Nobelium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Fe
The standard Iron species.
KIM_SpeciesName const KIM_SPECIES_NAME_user02
The standard user02 species.
KIM_SpeciesName const KIM_SPECIES_NAME_In
The standard Indium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Se
The standard Selenium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rb
The standard Rubidium species.
KIM_SpeciesName const KIM_SPECIES_NAME_Ar
The standard Argon species.
KIM_SpeciesName const KIM_SPECIES_NAME_Mt
The standard Meitnerium species.
KIM_SpeciesName const KIM_SPECIES_NAME_At
The standard Astatine species.
KIM_SpeciesName const KIM_SPECIES_NAME_Rh
The standard Rhodium species.
KIM_SpeciesName const KIM_SPECIES_NAME_user08
The standard user08 species.
KIM_SpeciesName const KIM_SPECIES_NAME_user10
The standard user10 species.
KIM_SpeciesName const KIM_SPECIES_NAME_N
The standard Nitrogen species.
KIM_SpeciesName const KIM_SPECIES_NAME_I
The standard Iodine species.
An Extensible Enumeration for the SpeciesName's supported by the KIM API.
int speciesNameID
Integer identifying the specific SpeciesName represented.