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

Marked some unused functions as deprecated

Browse source
This commit is contained in:
Ray Speth 2012-03-01 00:44:31 +00:00
parent 8161a9aa5a
commit 6a9f3ea892
9 changed files with 36 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/doxygen/Doxyfile
View file

@ -1332,7 +1332,8 @@ PREDEFINED = WITH_HTML_LOGS \
WITH_PURE_FLUIDS \
THREAD_SAFE_CANTERA \
WITH_LATTICE_SOLID \
HAVE_CONFIG_H
HAVE_CONFIG_H \
DEPRECATED(x)=x
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.

18
include/cantera/base/ctml.h
View file

@ -62,11 +62,10 @@ extern std::string INT_Format;
* @param titleString String name of the title attribute
* @param value Value - single bool
*
* @todo I don't think this is used. Figure out what is used for writing bools,
* and codify that.
* @deprecated never used
*/
void addBool(Cantera::XML_Node& node, const std::string& titleString,
const bool value);
DEPRECATED(void addBool(Cantera::XML_Node& node, const std::string& titleString,
const bool value));
//! This function adds a child node with the name, "integer", with a value
//! consisting of a single integer
@ -213,15 +212,16 @@ void addFloat(Cantera::XML_Node& node, const std::string& titleString,
* special double, Cantera::Undef, which means to ignore the
* entry.
*
* @todo I don't think this is used. Figure out what is used for writing integers,
* and codify that. unitsString shouldn't be here, since it's an int.
* typeString should be codified as to its usage.
* @todo unitsString shouldn't be here, since it's an int. typeString should
* be codified as to its usage.
*
* @deprecated Not currently used.
*/
void addIntegerArray(Cantera::XML_Node& node, const std::string& titleString,
DEPRECATED(void addIntegerArray(Cantera::XML_Node& node, const std::string& titleString,
const size_t n, const int* const values,
const std::string unitsString="", const std::string typeString="",
const doublereal minval=Cantera::Undef,
const doublereal maxval=Cantera::Undef);
const doublereal maxval=Cantera::Undef));
//! This function adds a child node with the name, "floatArray", with a value
//! consisting of a comma separated list of floats

8
include/cantera/base/xml.h
View file

@ -60,9 +60,9 @@ public:
* @return Returns a string stripped of leading and trailing white
* space.
*
* @todo why is this a class method?
* @deprecated Use stripws (in stringUtils.h)
*/
std::string strip(const std::string& aline) const;
DEPRECATED(std::string strip(const std::string& aline) const);
//! Looks for a substring within 'aline' enclosed in double
//! quotes, and returns this substring (without the quotes) if
@ -71,9 +71,9 @@ public:
*
* @param aline This is the input string to be searched
*
* @todo why is this a class method?
* @deprecated why is this a class method?
*/
std::string inquotes(const std::string& aline) const;
DEPRECATED(std::string inquotes(const std::string& aline) const);
//! Searches a string for the first occurrence of a valid
//! quoted string.

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

@ -159,9 +159,9 @@ public:
*
* @return Returns the pointer to the newly malloced
* species property manager for the reference state
* @todo is this used?
* @deprecated Essentially never used
*/
SpeciesThermo* newSpeciesThermoOpt(std::vector<XML_Node*> & spDataNodeList) const;
DEPRECATED(SpeciesThermo* newSpeciesThermoOpt(std::vector<XML_Node*> & spDataNodeList) const);
//! Install a species thermodynamic property parameterization
//! for the reference state for one species into a species thermo manager.

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

@ -50,9 +50,9 @@ public:
* @param func String function id
* @param thermotype Integer specifying the thermo parameterization
*
* @todo is this used
* deprecated This class is unused
*/
UnknownVPSSMgr(std::string func, int thermotype) {
DEPRECATED(UnknownVPSSMgr(std::string func, int thermotype)) {
CanteraError(func, std::string("\n ### ERROR ### \n") +
"Unknown species thermo parameterization ("
+ int2str(thermotype) + ")\n\n");

7
include/cantera/thermo/speciesThermoTypes.h
View file

@ -82,9 +82,9 @@ struct UnknownThermoParam {
/*!
* @param thermotype Integer specifying the thermo parameterization
*
* @todo Is this used?
* @deprecated This class is unused?
*/
UnknownThermoParam(int thermotype) {
DEPRECATED(UnknownThermoParam(int thermotype)) {
writelog(std::string("\n ### ERROR ### \n") +
"Unknown species thermo parameterization ("
+ int2str(thermotype) + ")\n\n");
@ -95,9 +95,10 @@ struct UnknownThermoParam {
//! holds parameterization-dependent index information
/*!
* These are all integers.
* @todo Is this used?
* @deprecated This struct is unused.
*/
struct ThermoIndexData {
DEPRECATED(ThermoIndexData()) {}
//! param
int param;
//! number of coefficients

16
include/cantera/transport/MultiTransport.h
View file

@ -21,6 +21,7 @@ namespace Cantera
//====================================================================================================================
//! Transport solve options
//! @deprecated GMRES option is unimplemented.
enum TRANSOLVE_TYPE {
//! Solve the dense matrix via a gmres iteration
TRANSOLVE_GMRES = 1,
@ -59,8 +60,9 @@ public:
*
* @param b
* @param prod
* @deprecated GMRES method is not implemented
*/
virtual void mult(const doublereal* b, doublereal* prod) const;
DEPRECATED(virtual void mult(const doublereal* b, doublereal* prod) const);
};
@ -197,15 +199,17 @@ public:
//! Set the solution method for inverting the L matrix
/*!
* @param method enum TRANSOLVE_TYPE Either use direct or TRANSOLVE_GMRES
* @deprecated GMRES option is unimplemented.
*/
virtual void setSolutionMethod(TRANSOLVE_TYPE method);
DEPRECATED(virtual void setSolutionMethod(TRANSOLVE_TYPE method));
//! Set the options for the GMRES solution
/*!
* @param m set the mgmres param
* @param eps Set the eps parameter
* @deprecated GMRES option is unimplemented.
*/
virtual void setOptions_GMRES(int m, doublereal eps);
DEPRECATED(virtual void setOptions_GMRES(int m, doublereal eps));
/**
* @internal
@ -326,9 +330,9 @@ private:
vector_fp m_a;
vector_fp m_b;
bool m_gmres;
int m_mgmres;
doublereal m_eps_gmres;
bool m_gmres; //!< @deprecated
int m_mgmres; //!< @deprecated
doublereal m_eps_gmres; //!< @deprecated
// work space
vector_fp m_spwork, m_spwork1, m_spwork2, m_spwork3;

9
src/base/ctml.cpp
View file

@ -263,9 +263,8 @@ void addIntegerArray(Cantera::XML_Node& node, const std::string& title, const si
* @param typeString String type. This is an optional parameter. The default
* is to have an empty string.
*
* @todo I don't think this is used. Figure out what is used for writing floats,
* and codify that. minval and maxval should be codified.
* typeString should be codified as to its usage.
* @todo minval and maxval should be codified. typeString should be codified
* as to its usage.
*/
void addFloat(Cantera::XML_Node& node, const std::string& title,
const doublereal val, const std::string units,
@ -341,9 +340,7 @@ void addFloat(Cantera::XML_Node& node, const std::string& title,
* special double, Cantera::Undef, which means to ignore the
* entry.
*
* @todo I don't think this is used. Figure out what is used for writing integers,
* and codify that. unitsString shouldn't be here, since it's an int.
* typeString should be codified as to its usage.
* @todo typeString should be codified as to its usage.
*/
void addFloatArray(Cantera::XML_Node& node, const std::string& title, const size_t n,
const doublereal* const vals, const std::string units,

1
src/equil/ChemEquil.cpp
View file

@ -215,7 +215,6 @@ void ChemEquil::setToEquilState(thermo_t& s,
/**
* update internally stored state information.
* @todo argument not used.
*/
void ChemEquil::update(const thermo_t& s)
{