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

Deprecate the setParameters and getParameters methods of ThermoPhase

Browse source
This commit is contained in:
Ray Speth 2013-06-24 15:22:08 +00:00
parent f7ed3c17f8
commit 8c95ee035e
23 changed files with 67 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/cantera/thermo/ConstDensityThermo.h
View file

@ -289,8 +289,10 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Use setDensity()
*/
virtual void setParameters(int n, doublereal* const c) {
warn_deprecated("ConstDensityThermo::setParamters");
setDensity(c[0]);
}
@ -301,8 +303,10 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Use density()
*/
virtual void getParameters(int& n, doublereal* const c) const {
warn_deprecated("ConstDensityThermo::getParameters");
double d = density();
c[0] = d;
n = 1;

2
include/cantera/thermo/DebyeHuckel.h
View file

@ -1074,6 +1074,7 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Unimplemented
*/
virtual void setParameters(int n, doublereal* const c);
@ -1084,6 +1085,7 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Unimplemented
*/
virtual void getParameters(int& n, doublereal* const c) const;

2
include/cantera/thermo/FixedChemPotSSTP.h
View file

@ -543,6 +543,7 @@ public:
* @param n number of parameters = 1
* @param c array of \a n coefficients
* c[0] = density of phase [ kg/m3 ]
* @deprecated Use setChemicalPotential()
*/
virtual void setParameters(int n, doublereal* const c);
@ -556,6 +557,7 @@ public:
* For this phase:
* - n = 1
* - c[0] = density of phase [ kg/m3 ]
* @deprecated Use getChemPotentials()
*/
virtual void getParameters(int& n, doublereal* const c) const;

2
include/cantera/thermo/HMWSoln.h
View file

@ -1904,6 +1904,7 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Unimplemented
*/
virtual void setParameters(int n, doublereal* const c);
@ -1914,6 +1915,7 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Unimplemented
*/
virtual void getParameters(int& n, doublereal* const c) const;

3
include/cantera/thermo/IdealMolalSoln.h
View file

@ -609,7 +609,7 @@ public:
* these depends on the subclass.
* @param n number of parameters
* @param c array of <I>n</I> coefficients
*
* @deprecated Unimplemented
*/
virtual void setParameters(int n, doublereal* const c);
@ -619,6 +619,7 @@ public:
*
* @param n number of parameters (output)
* @param c array of <I>n</I> coefficients
* * @deprecated Unimplemented
*/
virtual void getParameters(int& n, doublereal* const c) const;

2
include/cantera/thermo/LatticePhase.h
View file

@ -853,6 +853,7 @@ public:
* @param n number of parameters. Must be one
* @param c array of \a n coefficients
* c[0] = The bulk lattice density (kmol m-3)
* @deprecated Use setMolarDensity()
*/
virtual void setParameters(int n, doublereal* const c);
@ -866,6 +867,7 @@ public:
* For this phase:
* - n = 1
* - c[0] = molar density of phase [ kmol/m^3 ]
* @deprecated Use molarDensity()
*/
virtual void getParameters(int& n, doublereal* const c) const;

2
include/cantera/thermo/MetalSHEelectrons.h
View file

@ -465,6 +465,7 @@ public:
* @param n number of parameters
* @param c array of \a n coefficients
* c[0] = density of phase [ kg/m3 ]
* @deprecated Use setDensity()
*/
virtual void setParameters(int n, doublereal* const c);
@ -478,6 +479,7 @@ public:
* For this phase:
* - n = 1
* - c[0] = density of phase [ kg/m3 ]
* @deprecated Use density()
*/
virtual void getParameters(int& n, doublereal* const c) const;

2
include/cantera/thermo/MineralEQ3.h
View file

@ -397,6 +397,7 @@ public:
* @param n number of parameters
* @param c array of \a n coefficients
* c[0] = density of phase [ kg/m3 ]
* @deprecated Use setDensity()
*/
virtual void setParameters(int n, doublereal* const c);
@ -410,6 +411,7 @@ public:
* For this phase:
* - n = 1
* - c[0] = density of phase [ kg/m3 ]
* @deprecated use density()
*/
virtual void getParameters(int& n, doublereal* const c) const;

11
include/cantera/thermo/SingleSpeciesTP.h
View file

@ -567,11 +567,16 @@ public:
* these depends on the subclass.
* @param n number of parameters
* @param c array of n coefficients
*
* @deprecated Unimplemented
*/
virtual void setParameters(int n, doublereal* const c) {}
virtual void setParameters(int n, doublereal* const c) {
warn_deprecated("SingleSpeciesTP::setParameters");
}
virtual void getParameters(int& n, doublereal* const c) const {}
//! @deprecated Unimplemented
virtual void getParameters(int& n, doublereal* const c) const {
warn_deprecated("SingleSpeciesTP::getParameters");
}
/**
* Set equation of state parameter values from XML

2
include/cantera/thermo/StoichSubstance.h
View file

@ -355,8 +355,10 @@ public:
virtual void initThermo();
//! @deprecated Use setDensity()
virtual void setParameters(int n, double* const c);
//! @deprecated Use density()
virtual void getParameters(int& n, double* const c) const;
virtual void setParametersFromXML(const XML_Node& eosdata);

3
include/cantera/thermo/StoichSubstanceSSTP.h
View file

@ -439,6 +439,7 @@ public:
* @param n number of parameters
* @param c array of \a n coefficients
* c[0] = density of phase [ kg/m3 ]
* @deprecated Use setDensity()
*/
virtual void setParameters(int n, doublereal* const c);
@ -452,6 +453,7 @@ public:
* For this phase:
* - n = 1
* - c[0] = density of phase [ kg/m3 ]
* @deprecated Use density()
*/
virtual void getParameters(int& n, doublereal* const c) const;
@ -530,6 +532,7 @@ public:
virtual void initThermoXML(XML_Node& phaseNode, const std::string& id);
//! @deprecated Use setDensity()
void setParameters(int n, doublereal* const c);
};

1
include/cantera/thermo/SurfPhase.h
View file

@ -345,6 +345,7 @@ public:
* @param n number of parameters. Must be one
* @param c array of \a n coefficients
* c[0] = The site density (kmol m-2)
* @deprecated use setSiteDensity()
*/
virtual void setParameters(int n, doublereal* const c);

10
include/cantera/thermo/ThermoPhase.h
View file

@ -1452,8 +1452,11 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Use methods specific to the derived class
*/
virtual void setParameters(int n, doublereal* const c) {}
virtual void setParameters(int n, doublereal* const c) {
warn_deprecated("ThermoPhase::setParameters");
}
//! Get the equation of state parameters in a vector
@ -1463,8 +1466,11 @@ public:
*
* @param n number of parameters
* @param c array of \a n coefficients
* @deprecated Use methods specific to the derived class
*/
virtual void getParameters(int& n, doublereal* const c) const {}
virtual void getParameters(int& n, doublereal* const c) const {
warn_deprecated("ThermoPhase::getParameters");
}
//! Set equation of state parameter values from XML entries.

2
src/thermo/DebyeHuckel.cpp
View file

@ -1126,10 +1126,12 @@ initThermoXML(XML_Node& phaseNode, const std::string& id_)
void DebyeHuckel::setParameters(int n, doublereal* const c)
{
warn_deprecated("DebyeHuckel::setParameters");
}
void DebyeHuckel::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("DebyeHuckel::getParameters");
}
void DebyeHuckel::setParametersFromXML(const XML_Node& eosdata)

2
src/thermo/FixedChemPotSSTP.cpp
View file

@ -328,11 +328,13 @@ void FixedChemPotSSTP::initThermoXML(XML_Node& phaseNode, const std::string& id_
void FixedChemPotSSTP::setParameters(int n, doublereal* const c)
{
warn_deprecated("FixedChemPotSSTP::setParameters");
chemPot_ = c[0];
}
void FixedChemPotSSTP::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("FixedChemPotSSTP::getParameters");
n = 1;
c[0] = chemPot_;
}

2
src/thermo/HMWSoln.cpp
View file

@ -1008,10 +1008,12 @@ void HMWSoln::getPartialMolarCp(doublereal* cpbar) const
void HMWSoln::setParameters(int n, doublereal* const c)
{
warn_deprecated("HMWSoln::setParameters");
}
void HMWSoln::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("HMWSoln::getParameters");
}
void HMWSoln::setParametersFromXML(const XML_Node& eosdata)

2
src/thermo/IdealMolalSoln.cpp
View file

@ -673,10 +673,12 @@ void IdealMolalSoln::initThermoXML(XML_Node& phaseNode, const std::string& id_)
void IdealMolalSoln::setParameters(int n, doublereal* const c)
{
warn_deprecated("IdealMolalSoln::setParameters");
}
void IdealMolalSoln::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("IdealMolalSoln::getParameters");
}
void IdealMolalSoln::setParametersFromXML(const XML_Node& eosdata)

2
src/thermo/LatticePhase.cpp
View file

@ -402,12 +402,14 @@ void LatticePhase::_updateThermo() const
void LatticePhase::setParameters(int n, doublereal* const c)
{
warn_deprecated("LatticePhase::setParameters");
m_site_density = c[0];
setMolarDensity(m_site_density);
}
void LatticePhase::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("LatticePhase::getParameters");
double d = molarDensity();
c[0] = d;
n = 1;

2
src/thermo/MetalSHEelectrons.cpp
View file

@ -303,12 +303,14 @@ XML_Node* MetalSHEelectrons::makeDefaultXMLTree()
void MetalSHEelectrons::setParameters(int n, doublereal* const c)
{
warn_deprecated("MetalSHEelectrons::setParameters");
doublereal rho = c[0];
setDensity(rho);
}
void MetalSHEelectrons::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("MetalSHEelectrons::getParameters");
doublereal rho = density();
n = 1;
c[0] = rho;

2
src/thermo/MineralEQ3.cpp
View file

@ -234,12 +234,14 @@ void MineralEQ3::initThermo()
void MineralEQ3::setParameters(int n, doublereal* const c)
{
warn_deprecated("MineralEQ3::setParameters");
doublereal rho = c[0];
setDensity(rho);
}
void MineralEQ3::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("MineralEQ3::getParameters");
doublereal rho = density();
n = 1;
c[0] = rho;

2
src/thermo/StoichSubstance.cpp
View file

@ -246,12 +246,14 @@ void StoichSubstance::getCp_R_ref(doublereal* cprt) const
void StoichSubstance::setParameters(int n, double* const c)
{
warn_deprecated("StoichSubstance::setParameters");
double rho = c[0];
setDensity(rho);
}
void StoichSubstance::getParameters(int& n, double* const c) const
{
warn_deprecated("StoichSubstance::getParameters");
double rho = density();
c[0] = rho;
}

3
src/thermo/StoichSubstanceSSTP.cpp
View file

@ -255,12 +255,14 @@ void StoichSubstanceSSTP::initThermoXML(XML_Node& phaseNode, const std::string&
void StoichSubstanceSSTP::setParameters(int n, doublereal* const c)
{
warn_deprecated("StoichSubstanceSSTP::setParameters");
doublereal rho = c[0];
setDensity(rho);
}
void StoichSubstanceSSTP::getParameters(int& n, doublereal* const c) const
{
warn_deprecated("StoichSubstanceSSTP::getParameters");
doublereal rho = density();
n = 1;
c[0] = rho;
@ -362,6 +364,7 @@ void electrodeElectron::initThermoXML(XML_Node& phaseNode, const std::string& id
void electrodeElectron::setParameters(int n, doublereal* const c)
{
warn_deprecated("electrodeElectron::setParameters");
doublereal rho = 10.0;
setDensity(rho);
}

16
src/thermo/SurfPhase.cpp
View file

@ -185,16 +185,12 @@ doublereal SurfPhase::logStandardConc(size_t k) const
void SurfPhase::setParameters(int n, doublereal* const c)
{
warn_deprecated("SurfPhase::setParameters");
if (n != 1) {
throw CanteraError("SurfPhase::setParameters",
"Bad value for number of parameter");
}
m_n0 = c[0];
if (m_n0 <= 0.0) {
throw CanteraError("SurfPhase::setParameters",
"Bad value for parameter");
}
m_logn0 = log(m_n0);
setSiteDensity(c[0]);
}
void SurfPhase::getGibbs_RT(doublereal* grt) const
@ -276,8 +272,12 @@ void SurfPhase::initThermo()
void SurfPhase::setSiteDensity(doublereal n0)
{
doublereal x = n0;
setParameters(1, &x);
if (n0 <= 0.0) {
throw CanteraError("SurfPhase::setSiteDensity",
"Bad value for parameter");
}
m_n0 = n0;
m_logn0 = log(m_n0);
}
void SurfPhase::setCoverages(const doublereal* theta)