comparison mayachemtools/docs/modules/html/PeriodicTable.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:73ae111cf86f
1 <html>
2 <head>
3 <title>MayaChemTools:Documentation:PeriodicTable.pm</title>
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
6 </head>
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
8 <br/>
9 <center>
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
11 </center>
12 <br/>
13 <div class="DocNav">
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./PDBFileUtil.html" title="PDBFileUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./PseudoHeap.html" title="PseudoHeap.html">Next</a></td><td width="34%" align="middle"><strong>PeriodicTable.pm</strong></td><td width="33%" align="right"><a href="././code/PeriodicTable.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/PeriodicTable.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/PeriodicTable.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/PeriodicTable.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/PeriodicTable.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
16 </table>
17 </div>
18 <p>
19 </p>
20 <h2>NAME</h2>
21 <p>PeriodicTable</p>
22 <p>
23 </p>
24 <h2>SYNOPSIS</h2>
25 <p>use PeriodicTable;</p>
26 <p>use PeriodicTable qw(:all);</p>
27 <p>
28 </p>
29 <h2>DESCRIPTION</h2>
30 <p><strong>PeriodicTable</strong> module provides the following functions:</p>
31 <p> <a href="#getelementmostabundantnaturalisotopedata">GetElementMostAbundantNaturalIsotopeData</a>
32 , <a href="#getelementmostabundantnaturalisotopemass">GetElementMostAbundantNaturalIsotopeMass</a>
33 , <a href="#getelementmostabundantnaturalisotopemassnumber">GetElementMostAbundantNaturalIsotopeMassNumber</a>, <a href="#getelementnaturalisotopeabundance">GetElementNaturalIsotopeAbundance</a>
34 , <a href="#getelementnaturalisotopecount">GetElementNaturalIsotopeCount</a>, <a href="#getelementnaturalisotopemass">GetElementNaturalIsotopeMass</a>
35 , <a href="#getelementnaturalisotopesdata">GetElementNaturalIsotopesData</a>, <a href="#getelementpropertiesdata">GetElementPropertiesData</a>
36 , <a href="#getelementpropertiesnames">GetElementPropertiesNames</a>, <a href="#getelementpropertiesnamesandunits">GetElementPropertiesNamesAndUnits</a>
37 , <a href="#getelementpropertyunits">GetElementPropertyUnits</a>, <a href="#getelements">GetElements</a>, <a href="#getelementsbyamericanstylegrouplabel">GetElementsByAmericanStyleGroupLabel</a>
38 , <a href="#getelementsbyeuropeanstylegrouplabel">GetElementsByEuropeanStyleGroupLabel</a>, <a href="#getelementsbygroupname">GetElementsByGroupName</a>
39 , <a href="#getelementsbygroupnumber">GetElementsByGroupNumber</a>, <a href="#getelementsbyperiodnumber">GetElementsByPeriodNumber</a>
40 , <a href="#getiupacgroupnumberfromamericanstylegrouplabel">GetIUPACGroupNumberFromAmericanStyleGroupLabel</a>
41 , <a href="#getiupacgroupnumberfromeuropeanstylegrouplabel">GetIUPACGroupNumberFromEuropeanStyleGroupLabel</a>, <a href="#iselement">IsElement</a>
42 , <a href="#iselementnaturalisotopemassnumber">IsElementNaturalIsotopeMassNumber</a>, <a href="#iselementproperty">IsElementProperty</a>
43 </p><p>
44 </p>
45 <h2>METHODS</h2>
46 <dl>
47 <dt><strong><a name="getelements" class="item"><strong>GetElements</strong></a></strong></dt>
48 <dd>
49 <div class="OptionsBox">
50 @ElementSymbols = GetElements();
51 <br/> $ElementSymbolsRef = GetElements();</div>
52 <p>Returns an array or a reference to an array of known element symbols</p>
53 </dd>
54 <dt><strong><a name="getelementsbygroupname" class="item"><strong>GetElementsByGroupName</strong></a></strong></dt>
55 <dd>
56 <div class="OptionsBox">
57 @ElementSymbols = GetElementsByGroupName($GroupName);
58 <br/> $ElementSymbolsRef = GetElementsByGroupName($GroupName);</div>
59 <p>Returns an array or a reference to an array of element symbols for a specified <em>GroupName</em>.
60 Supported <em>GroupName</em> values are: <em>Alkali metals, Alkaline earth metals, Coinage metals, Pnictogens,
61 Chalcogens, Halogens, Noble gases</em>; Additionally, usage of <em>Lanthanides</em> (Lanthanoids)
62 and <em>Actinides</em> (Actinoids) is also supported.</p>
63 </dd>
64 <dt><strong><a name="getelementsbygroupnumber" class="item"><strong>GetElementsByGroupNumber</strong></a></strong></dt>
65 <dd>
66 <div class="OptionsBox">
67 @ElementSymbols = GetElementsByGroupNumber($GroupNumber);
68 <br/> $ElementSymbolsRef = GetElementsByGroupNumber($GroupNumber);</div>
69 <p>Returns an array or a reference to an array of element symbols for a specified <em>GroupNumber</em></p>
70 </dd>
71 <dt><strong><a name="getelementsbyamericanstylegrouplabel" class="item"><strong>GetElementsByAmericanStyleGroupLabel</strong></a></strong></dt>
72 <dd>
73 <div class="OptionsBox">
74 @ElementSymbols = GetElementsByAmericanStyleGroupLabel($GroupLabel);
75 <br/> $ElementSymbolsRef = GetElementsByAmericanStyleGroupLabel($GroupLabel);</div>
76 <p>Returns an array or a reference to an array of element symbols for a specified American
77 style <em>GroupLabel</em>. Valid values for Amercian style group labels: <em>IA to VIIIA, IB to VIIIB, VIII</em>.</p>
78 </dd>
79 <dt><strong><a name="getelementsbyeuropeanstylegrouplabel" class="item"><strong>GetElementsByEuropeanStyleGroupLabel</strong></a></strong></dt>
80 <dd>
81 <div class="OptionsBox">
82 @ElementSymbols = GetElementsByEuropeanStyleGroupLabel($GroupLabel);
83 <br/> $ElementSymbolsRef = GetElementsByEuropeanStyleGroupLabel($GroupLabel);</div>
84 <p>Returns an array or a reference to an array of element symbols for a specified European
85 style <em>GroupLabel</em>. Valid values for European style group labels: <em>IA to VIIIA, IB to VIIIB, VIII</em>.</p>
86 </dd>
87 <dt><strong><a name="getelementsbyperiodnumber" class="item"><strong>GetElementsByPeriodNumber</strong></a></strong></dt>
88 <dd>
89 <div class="OptionsBox">
90 @ElementSymbols = GetElementsByPeriodNumber($PeriodNumber);
91 <br/> $ElementSymbolsRef = GetElementsByPeriodNumber($PeriodNumber);</div>
92 <p>Returns an array or a reference to an array of element symbols for a specified <em>PeriodNumber</em>.</p>
93 </dd>
94 <dt><strong><a name="getelementmostabundantnaturalisotopedata" class="item"><strong>GetElementMostAbundantNaturalIsotopeData</strong></a></strong></dt>
95 <dd>
96 <div class="OptionsBox">
97 @IsotopeData = GetElementMostAbundantNaturalIsotopeData(
98 $ElementID);
99 <br/> $IsotopeDataRef = GetElementMostAbundantNaturalIsotopeData(
100 $ElementID);</div>
101 <p>Returns an array or reference to an array containing data for most abundant isotope of
102 an element specfied by element symbol or atomic number. Isotope data arrays contain these
103 values: <em>AtomicNumber, IsotopeSymbol, MassNumber, RelativeAtomicMass, and NaturalAbundance</em>.</p>
104 </dd>
105 <dt><strong><a name="getelementmostabundantnaturalisotopemassnumber" class="item"><strong>GetElementMostAbundantNaturalIsotopeMassNumber</strong></a></strong></dt>
106 <dd>
107 <div class="OptionsBox">
108 $MassNumber = GetElementMostAbundantNaturalIsotopeMassNumber($ElementID);</div>
109 <p>Returns mass number of most abundant natural isotope of an element specfied by element
110 symbol or atomic number</p>
111 </dd>
112 <dt><strong><a name="getelementnaturalisotopecount" class="item"><strong>GetElementNaturalIsotopeCount</strong></a></strong></dt>
113 <dd>
114 <div class="OptionsBox">
115 $IsotopeCount = GetElementNaturalIsotopeCount($ElementID);</div>
116 <p>Returns natural isotope count for an element specfied by element symbol or
117 atomic number</p>
118 </dd>
119 <dt><strong><a name="getelementnaturalisotopesdata" class="item"><strong>GetElementNaturalIsotopesData</strong></a></strong></dt>
120 <dd>
121 <div class="OptionsBox">
122 $DataHashRef = GetElementNaturalIsotopesData($ElementID,
123 [$MassNumber]);</div>
124 <p>Reurns a reference to a hash containingall available isotope data for an element specified
125 using element symbol or aromic number; an optional mass number indicates retrieve data
126 for a specific isotope</p>
127 </dd>
128 <dt><strong><a name="getelementnaturalisotopeabundance" class="item"><strong>GetElementNaturalIsotopeAbundance</strong></a></strong></dt>
129 <dd>
130 <div class="OptionsBox">
131 $Abundance = GetElementNaturalIsotopeAbundance($ElementID,
132 $MassNumber);</div>
133 <p>Returns percent abundance of natural isotope for an element with specfic mass
134 number.</p>
135 </dd>
136 <dt><strong><a name="getelementmostabundantnaturalisotopemass" class="item"><strong>GetElementMostAbundantNaturalIsotopeMass</strong></a></strong></dt>
137 <dd>
138 <div class="OptionsBox">
139 $RelativeAtomicMass = GetElementMostAbundantNaturalIsotopeMass(
140 $ElementID);</div>
141 <p>Returns relative atomic mass of most abundant isotope for an element specified using
142 element symbol or aromic number.</p>
143 </dd>
144 <dt><strong><a name="getelementnaturalisotopemass" class="item"><strong>GetElementNaturalIsotopeMass</strong></a></strong></dt>
145 <dd>
146 <div class="OptionsBox">
147 $RelativeAtomicMass = GetElementNaturalIsotopeMass($ElementID,
148 $MassNumber);</div>
149 <p>Returns relative atomic mass of an element with specfic mass number.</p>
150 </dd>
151 <dt><strong><a name="getelementpropertiesdata" class="item"><strong>GetElementPropertiesData</strong></a></strong></dt>
152 <dd>
153 <div class="OptionsBox">
154 $PropertyDataHashRef = GetElementPropertiesData($ElementID);</div>
155 <p>Returns a reference to a hash containing all available properties data for an element
156 specified using element symbol or atomic number.</p>
157 </dd>
158 <dt><strong><a name="getelementpropertyname" class="item"><strong>GetElementPropertyName</strong></a></strong></dt>
159 <dd>
160 <div class="OptionsBox">
161 $PropertyValue = GetElement&lt;PropertyName&gt;($ElementID);</div>
162 <p>Returns value of an element for a element specified using element symbol or atomic number.</p>
163 <p>These functions are not defined in this modules; these are implemented on-the-fly using
164 Perl's AUTOLOAD funcionality.</p>
165 <p>Here is the list of known element <em>property names</em>: AllenElectronegativity,
166 AllredRochowElectronegativity, AtomicNumber, AtomicRadiusCalculated,
167 AtomicRadiusEmpirical, AtomicWeight, Block, BoilingPoint, BondLength,
168 BrinellHardness, BulkModulus, Classification, CoefficientOfLinearExpansion, Color,
169 CommonValences, LowestCommonValence, HighestCommonValence,
170 CommonOxidationNumbers, LowestCommonOxidationNumber, HighestCommonOxidationNumber,
171 CovalentRadiusEmpirical, CriticalTemperature, DensityOfSolid, DiscoveredAt, DiscoveredBy,
172 DiscoveredWhen, ElectricalResistivity, ElectronAffinity, ElementName, ElementSymbol, EnthalpyOfAtmization,
173 EnthalpyOfFusion, EnthalpyOfVaporization, FirstIonizationEnergy, GroundStateConfiguration, GroundStateLevel,
174 GroupName, GroupNumber, NaturalIsotopeData, MeltingPoint, MineralHardness, MolarVolume,
175 MullikenJaffeElectronegativity, OriginOfName, PaulingElectronegativity, PeriodNumber, PoissonsRatio,
176 Reflectivity, RefractiveIndex, RigidityModulus, SandersonElectronegativity, StandardState,
177 SuperconductionTemperature, ThermalConductivity, VanderWaalsRadius, VelocityOfSound, VickersHardness,
178 YoungsModulus.</p>
179 </dd>
180 <dt><strong><a name="getelementpropertiesnames" class="item"><strong>GetElementPropertiesNames</strong></a></strong></dt>
181 <dd>
182 <div class="OptionsBox">
183 @PropertyNames = GetElementPropertiesNames([$Mode]);
184 <br/> $PropertyNamesRef = GetElementPropertiesNames([$Mode]);</div>
185 <p>Returns names of all available element properties. Optional mode parameter controls
186 grouping of property names; Possible values: <em>ByGroup or Alphabetical</em>. Default:
187 <em>ByGroup</em>.</p>
188 </dd>
189 <dt><strong><a name="getelementpropertiesnamesandunits" class="item"><strong>GetElementPropertiesNamesAndUnits</strong></a></strong></dt>
190 <dd>
191 <div class="OptionsBox">
192 $NameUnitsHashRef = GetElementPropertiesNamesAndUnits();</div>
193 <p>Returns a reference to a hash of property names and units of all available element
194 properties. Names with no units contains empty strings.</p>
195 </dd>
196 <dt><strong><a name="getelementpropertyunits" class="item"><strong>GetElementPropertyUnits</strong></a></strong></dt>
197 <dd>
198 <div class="OptionsBox">
199 $Units = GetElementPropertyUnits($PropertyName);</div>
200 <p>Returns units for a specific element property name. An empty string is returned for
201 a property with no units.</p>
202 </dd>
203 <dt><strong><a name="getiupacgroupnumberfromamericanstylegrouplabel" class="item"><strong>GetIUPACGroupNumberFromAmericanStyleGroupLabel</strong></a></strong></dt>
204 <dd>
205 <div class="OptionsBox">
206 $GroupNumber = GetIUPACGroupNumberFromAmericanStyleGroupLabel(
207 $GroupLabel);</div>
208 <p>Returns IUPAC group numbers of a specific American style group label. A comma delimited
209 string is returned for group VIII or VIIIB.</p>
210 </dd>
211 <dt><strong><a name="getiupacgroupnumberfromeuropeanstylegrouplabel" class="item"><strong>GetIUPACGroupNumberFromEuropeanStyleGroupLabel</strong></a></strong></dt>
212 <dd>
213 <div class="OptionsBox">
214 $GroupNumber = GetIUPACGroupNumberFromEuropeanStyleGroupLabel(
215 $GroupLabel);</div>
216 <p>Returns IUPAC group numbers of a specific European style group label. A comma delimited
217 string is returned for group VIII or VIIIA.</p>
218 </dd>
219 <dt><strong><a name="iselement" class="item"><strong>IsElement</strong></a></strong></dt>
220 <dd>
221 <div class="OptionsBox">
222 $Status = IsElement($ElementID);</div>
223 <p>Returns 1 or 0 based on whether it's a known element symbol or atomic number.</p>
224 </dd>
225 <dt><strong><a name="iselementnaturalisotopemassnumber" class="item"><strong>IsElementNaturalIsotopeMassNumber</strong></a></strong></dt>
226 <dd>
227 <div class="OptionsBox">
228 $Status = IsElementNaturalIsotopeMassNumber($ElementID, $MassNumber);</div>
229 <p>Returns 1 or 0 based on whether it's a valid mass number for an element symbol
230 or atomic number.</p>
231 </dd>
232 <dt><strong><a name="iselementproperty" class="item"><strong>IsElementProperty</strong></a></strong></dt>
233 <dd>
234 <div class="OptionsBox">
235 $Status = IsElementProperty($PropertyName);</div>
236 <p>Returns 1 or 0 based on whether it's a valid property name.</p>
237 </dd>
238 </dl>
239 <p>
240 </p>
241 <h2>AUTHOR</h2>
242 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
243 <p>
244 </p>
245 <h2>SEE ALSO</h2>
246 <p><a href="./AminoAcids.html">AminoAcids.pm</a>,&nbsp<a href="./NucleicAcids.html">NucleicAcids.pm</a>
247 </p>
248 <p>
249 </p>
250 <h2>COPYRIGHT</h2>
251 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
252 <p>This file is part of MayaChemTools.</p>
253 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
254 the terms of the GNU Lesser General Public License as published by the Free
255 Software Foundation; either version 3 of the License, or (at your option)
256 any later version.</p>
257 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
258 <table width="100%" border=0 cellpadding=0 cellspacing=2>
259 <tr align="left" valign="top"><td width="33%" align="left"><a href="./PDBFileUtil.html" title="PDBFileUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./PseudoHeap.html" title="PseudoHeap.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>PeriodicTable.pm</strong></td></tr>
260 </table>
261 </div>
262 <br />
263 <center>
264 <img src="../../images/h2o2.png">
265 </center>
266 </body>
267 </html>