Mercurial > repos > deepakjadmin > mayatool3_test2

comparison docs/modules/txt/PeriodicTable.txt @ 0:4816e4a8ae95 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4816e4a8ae95
1 NAME
2 PeriodicTable
3
4 SYNOPSIS
5 use PeriodicTable;
6
7 use PeriodicTable qw(:all);
8
9 DESCRIPTION
10 PeriodicTable module provides the following functions:
11
12 GetElementMostAbundantNaturalIsotopeData,
13 GetElementMostAbundantNaturalIsotopeMass,
14 GetElementMostAbundantNaturalIsotopeMassNumber,
15 GetElementNaturalIsotopeAbundance, GetElementNaturalIsotopeCount,
16 GetElementNaturalIsotopeMass, GetElementNaturalIsotopesData,
17 GetElementPropertiesData, GetElementPropertiesNames,
18 GetElementPropertiesNamesAndUnits, GetElementPropertyUnits, GetElements,
19 GetElementsByAmericanStyleGroupLabel,
20 GetElementsByEuropeanStyleGroupLabel, GetElementsByGroupName,
21 GetElementsByGroupNumber, GetElementsByPeriodNumber,
22 GetIUPACGroupNumberFromAmericanStyleGroupLabel,
23 GetIUPACGroupNumberFromEuropeanStyleGroupLabel, IsElement,
24 IsElementNaturalIsotopeMassNumber, IsElementProperty
25
26 METHODS
27 GetElements
28 @ElementSymbols = GetElements();
29 $ElementSymbolsRef = GetElements();
30
31 Returns an array or a reference to an array of known element symbols
32
33 GetElementsByGroupName
34 @ElementSymbols = GetElementsByGroupName($GroupName);
35 $ElementSymbolsRef = GetElementsByGroupName($GroupName);
36
37 Returns an array or a reference to an array of element symbols for a
38 specified *GroupName*. Supported *GroupName* values are: *Alkali
39 metals, Alkaline earth metals, Coinage metals, Pnictogens,
40 Chalcogens, Halogens, Noble gases*; Additionally, usage of
41 *Lanthanides* (Lanthanoids) and *Actinides* (Actinoids) is also
42 supported.
43
44 GetElementsByGroupNumber
45 @ElementSymbols = GetElementsByGroupNumber($GroupNumber);
46 $ElementSymbolsRef = GetElementsByGroupNumber($GroupNumber);
47
48 Returns an array or a reference to an array of element symbols for a
49 specified *GroupNumber*
50
51 GetElementsByAmericanStyleGroupLabel
52 @ElementSymbols = GetElementsByAmericanStyleGroupLabel($GroupLabel);
53 $ElementSymbolsRef = GetElementsByAmericanStyleGroupLabel($GroupLabel);
54
55 Returns an array or a reference to an array of element symbols for a
56 specified American style *GroupLabel*. Valid values for Amercian
57 style group labels: *IA to VIIIA, IB to VIIIB, VIII*.
58
59 GetElementsByEuropeanStyleGroupLabel
60 @ElementSymbols = GetElementsByEuropeanStyleGroupLabel($GroupLabel);
61 $ElementSymbolsRef = GetElementsByEuropeanStyleGroupLabel($GroupLabel);
62
63 Returns an array or a reference to an array of element symbols for a
64 specified European style *GroupLabel*. Valid values for European
65 style group labels: *IA to VIIIA, IB to VIIIB, VIII*.
66
67 GetElementsByPeriodNumber
68 @ElementSymbols = GetElementsByPeriodNumber($PeriodNumber);
69 $ElementSymbolsRef = GetElementsByPeriodNumber($PeriodNumber);
70
71 Returns an array or a reference to an array of element symbols for a
72 specified *PeriodNumber*.
73
74 GetElementMostAbundantNaturalIsotopeData
75 @IsotopeData = GetElementMostAbundantNaturalIsotopeData(
76 $ElementID);
77 $IsotopeDataRef = GetElementMostAbundantNaturalIsotopeData(
78 $ElementID);
79
80 Returns an array or reference to an array containing data for most
81 abundant isotope of an element specfied by element symbol or atomic
82 number. Isotope data arrays contain these values: *AtomicNumber,
83 IsotopeSymbol, MassNumber, RelativeAtomicMass, and
84 NaturalAbundance*.
85
86 GetElementMostAbundantNaturalIsotopeMassNumber
87 $MassNumber = GetElementMostAbundantNaturalIsotopeMassNumber($ElementID);
88
89 Returns mass number of most abundant natural isotope of an element
90 specfied by element symbol or atomic number
91
92 GetElementNaturalIsotopeCount
93 $IsotopeCount = GetElementNaturalIsotopeCount($ElementID);
94
95 Returns natural isotope count for an element specfied by element
96 symbol or atomic number
97
98 GetElementNaturalIsotopesData
99 $DataHashRef = GetElementNaturalIsotopesData($ElementID,
100 [$MassNumber]);
101
102 Reurns a reference to a hash containingall available isotope data
103 for an element specified using element symbol or aromic number; an
104 optional mass number indicates retrieve data for a specific isotope
105
106 GetElementNaturalIsotopeAbundance
107 $Abundance = GetElementNaturalIsotopeAbundance($ElementID,
108 $MassNumber);
109
110 Returns percent abundance of natural isotope for an element with
111 specfic mass number.
112
113 GetElementMostAbundantNaturalIsotopeMass
114 $RelativeAtomicMass = GetElementMostAbundantNaturalIsotopeMass(
115 $ElementID);
116
117 Returns relative atomic mass of most abundant isotope for an element
118 specified using element symbol or aromic number.
119
120 GetElementNaturalIsotopeMass
121 $RelativeAtomicMass = GetElementNaturalIsotopeMass($ElementID,
122 $MassNumber);
123
124 Returns relative atomic mass of an element with specfic mass number.
125
126 GetElementPropertiesData
127 $PropertyDataHashRef = GetElementPropertiesData($ElementID);
128
129 Returns a reference to a hash containing all available properties
130 data for an element specified using element symbol or atomic number.
131
132 GetElementPropertyName
133 $PropertyValue = GetElement<PropertyName>($ElementID);
134
135 Returns value of an element for a element specified using element
136 symbol or atomic number.
137
138 These functions are not defined in this modules; these are
139 implemented on-the-fly using Perl's AUTOLOAD funcionality.
140
141 Here is the list of known element *property names*:
142 AllenElectronegativity, AllredRochowElectronegativity, AtomicNumber,
143 AtomicRadiusCalculated, AtomicRadiusEmpirical, AtomicWeight, Block,
144 BoilingPoint, BondLength, BrinellHardness, BulkModulus,
145 Classification, CoefficientOfLinearExpansion, Color, CommonValences,
146 LowestCommonValence, HighestCommonValence, CommonOxidationNumbers,
147 LowestCommonOxidationNumber, HighestCommonOxidationNumber,
148 CovalentRadiusEmpirical, CriticalTemperature, DensityOfSolid,
149 DiscoveredAt, DiscoveredBy, DiscoveredWhen, ElectricalResistivity,
150 ElectronAffinity, ElementName, ElementSymbol, EnthalpyOfAtmization,
151 EnthalpyOfFusion, EnthalpyOfVaporization, FirstIonizationEnergy,
152 GroundStateConfiguration, GroundStateLevel, GroupName, GroupNumber,
153 NaturalIsotopeData, MeltingPoint, MineralHardness, MolarVolume,
154 MullikenJaffeElectronegativity, OriginOfName,
155 PaulingElectronegativity, PeriodNumber, PoissonsRatio, Reflectivity,
156 RefractiveIndex, RigidityModulus, SandersonElectronegativity,
157 StandardState, SuperconductionTemperature, ThermalConductivity,
158 VanderWaalsRadius, VelocityOfSound, VickersHardness, YoungsModulus.
159
160 GetElementPropertiesNames
161 @PropertyNames = GetElementPropertiesNames([$Mode]);
162 $PropertyNamesRef = GetElementPropertiesNames([$Mode]);
163
164 Returns names of all available element properties. Optional mode
165 parameter controls grouping of property names; Possible values:
166 *ByGroup or Alphabetical*. Default: *ByGroup*.
167
168 GetElementPropertiesNamesAndUnits
169 $NameUnitsHashRef = GetElementPropertiesNamesAndUnits();
170
171 Returns a reference to a hash of property names and units of all
172 available element properties. Names with no units contains empty
173 strings.
174
175 GetElementPropertyUnits
176 $Units = GetElementPropertyUnits($PropertyName);
177
178 Returns units for a specific element property name. An empty string
179 is returned for a property with no units.
180
181 GetIUPACGroupNumberFromAmericanStyleGroupLabel
182 $GroupNumber = GetIUPACGroupNumberFromAmericanStyleGroupLabel(
183 $GroupLabel);
184
185 Returns IUPAC group numbers of a specific American style group
186 label. A comma delimited string is returned for group VIII or VIIIB.
187
188 GetIUPACGroupNumberFromEuropeanStyleGroupLabel
189 $GroupNumber = GetIUPACGroupNumberFromEuropeanStyleGroupLabel(
190 $GroupLabel);
191
192 Returns IUPAC group numbers of a specific European style group
193 label. A comma delimited string is returned for group VIII or VIIIA.
194
195 IsElement
196 $Status = IsElement($ElementID);
197
198 Returns 1 or 0 based on whether it's a known element symbol or
199 atomic number.
200
201 IsElementNaturalIsotopeMassNumber
202 $Status = IsElementNaturalIsotopeMassNumber($ElementID, $MassNumber);
203
204 Returns 1 or 0 based on whether it's a valid mass number for an
205 element symbol or atomic number.
206
207 IsElementProperty
208 $Status = IsElementProperty($PropertyName);
209
210 Returns 1 or 0 based on whether it's a valid property name.
211
212 AUTHOR
213 Manish Sud <msud@san.rr.com>
214
215 SEE ALSO
216 AminoAcids.pm, NucleicAcids.pm
217
218 COPYRIGHT
219 Copyright (C) 2015 Manish Sud. All rights reserved.
220
221 This file is part of MayaChemTools.
222
223 MayaChemTools is free software; you can redistribute it and/or modify it
224 under the terms of the GNU Lesser General Public License as published by
225 the Free Software Foundation; either version 3 of the License, or (at
226 your option) any later version.
227