research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix element function exception documentation

Browse source 
For several elements-related functions, the documentation listed
incorrect or incomplete exceptions that could be thrown from that
function.
This commit is contained in:
Bryan W. Weber 2019-07-24 15:52:08 -04:00 • committed by Ray Speth
parent a7363e4b54
commit b5a7575bc0
2 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
include/cantera/thermo/Elements.h
View file

@ -5,7 +5,7 @@
*/ */
// This file is part of Cantera. See License.txt in the top-level directory or // This file is part of Cantera. See License.txt in the top-level directory or
// at http://www.cantera.org/license.txt for license and copyright information. // at https://cantera.org/license.txt for license and copyright information.
#ifndef CT_ELEMENTS_H #ifndef CT_ELEMENTS_H
#define CT_ELEMENTS_H #define CT_ELEMENTS_H
@ -93,7 +93,8 @@ namespace Cantera
* *
* @param ename String, name or symbol of the element * @param ename String, name or symbol of the element
* @return The atomic weight of the element * @return The atomic weight of the element
* @exception CanteraError If a match is not found, throws a CanteraError * @exception CanteraError if a match for ename is not found or the
* element has no stable isotopes, and therefore no standard atomic weight
*/ */
double getElementWeight(const std::string& ename); double getElementWeight(const std::string& ename);
@ -106,7 +107,10 @@ double getElementWeight(const std::string& ename);
* *
* @param atomicNumber Integer, atomic number of the element * @param atomicNumber Integer, atomic number of the element
* @return The atomic weight of the element * @return The atomic weight of the element
* @exception CanteraError If a match is not found, throws a CanteraError * @exception IndexError if the passed atomic number less than 1 or
* larger than the number of elements defined
* @exception CanteraError if the element has no stable isotopes, and
* therefore no standard atomic weight
*/ */
double getElementWeight(int atomicNumber); double getElementWeight(int atomicNumber);
@ -117,7 +121,7 @@ double getElementWeight(int atomicNumber);
* *
* @param ename String, name of the element * @param ename String, name of the element
* @return The symbol of the element in a string * @return The symbol of the element in a string
* @exception CanteraError If a match is not found, throws a CanteraError * @exception CanteraError if a match for ename is not found
*/ */
std::string getElementSymbol(const std::string& ename); std::string getElementSymbol(const std::string& ename);
@ -130,7 +134,8 @@ std::string getElementSymbol(const std::string& ename);
* *
* @param atomicNumber Integer, atomic number of the element * @param atomicNumber Integer, atomic number of the element
* @return The symbol of the element in a string * @return The symbol of the element in a string
* @exception CanteraError If a match is not found, throws a CanteraError * @exception IndexError if the passed atomic number less than 1 or
* larger than the number of elements defined
*/ */
std::string getElementSymbol(int atomicNumber); std::string getElementSymbol(int atomicNumber);
@ -141,7 +146,7 @@ std::string getElementSymbol(int atomicNumber);
* *
* @param ename String, symbol for the element * @param ename String, symbol for the element
* @return The name of the element, in a string * @return The name of the element, in a string
* @exception CanteraError If a match is not found, throws a CanteraError * @exception CanteraError if a match for ename is not found
*/ */
std::string getElementName(const std::string& ename); std::string getElementName(const std::string& ename);
@ -154,7 +159,8 @@ std::string getElementName(const std::string& ename);
* *
* @param atomicNumber Integer, atomic number of the element * @param atomicNumber Integer, atomic number of the element
* @return The name of the element, in a string * @return The name of the element, in a string
* @exception CanteraError If a match is not found, throws a CanteraError * @exception CanteraError IndexError if the passed atomic number less than 1 or
* larger than the number of elements defined
*/ */
std::string getElementName(int atomicNumber); std::string getElementName(int atomicNumber);
@ -165,7 +171,7 @@ std::string getElementName(int atomicNumber);
* *
* @param ename String, name or symbol of the element * @param ename String, name or symbol of the element
* @return The integer atomic number of the element * @return The integer atomic number of the element
* @exception CanteraError If a match is not found, throws a CanteraError * @exception CanteraError if a match for ename is not found
*/ */
int getAtomicNumber(const std::string& ename); int getAtomicNumber(const std::string& ename);

5
src/thermo/Elements.cpp
View file

@ -229,7 +229,7 @@ double getElementWeight(const std::string& ename)
return elementWeight; return elementWeight;
} else if (elementWeight < 0.0) { } else if (elementWeight < 0.0) {
throw CanteraError("getElementWeight", throw CanteraError("getElementWeight",
"element has no stable isotopes: " + ename); "element '{}' has no stable isotopes", ename);
} }
for (int i = 0; i < numIsotopes; i++) { for (int i = 0; i < numIsotopes; i++) {
if (symbol == isotopeWeightTable[i].symbol) { if (symbol == isotopeWeightTable[i].symbol) {
@ -249,9 +249,8 @@ double getElementWeight(int atomicNumber)
} }
double elementWeight = atomicWeightTable[atomicNumber - 1].atomicWeight; double elementWeight = atomicWeightTable[atomicNumber - 1].atomicWeight;
if (elementWeight < 0.0) { if (elementWeight < 0.0) {
string ename = getElementName(atomicNumber);
throw CanteraError("getElementWeight", throw CanteraError("getElementWeight",
"element has no stable isotopes: " + ename); "element '{}' has no stable isotopes", getElementName(atomicNumber));
} }
return elementWeight; return elementWeight;
} }