Deprecate some unused/unfinished classes

This commit is contained in:
Ray Speth 2015-05-23 23:37:37 -04:00
parent b5b1e89814
commit eb74329d1b
16 changed files with 22 additions and 2 deletions

View file

@ -208,6 +208,7 @@ typedef double(*VCS_FUNC_PTR)(double xval, double Vtarget,
* return 0;
* }
* @endcode
* @deprecated Unused. To be removed after Cantera 2.2.
*/
int vcsUtil_root1d(double xmin, double xmax, size_t itmax, VCS_FUNC_PTR func,
void* fptrPassthrough,
@ -246,6 +247,7 @@ size_t vcs_optMax(const double* x, const double* xSize, size_t j, size_t n);
* @param length length of the integer vector
*
* @return returns the max integer value in the list
* @deprecated Unused. To be removed after Cantera 2.2.
*/
int vcs_max_int(const int* vector, int length);

View file

@ -27,6 +27,7 @@ namespace Cantera
* phases. We will also assume that there is an electron phase.
*
* @ingroup chemkinetics
* @deprecated Unfinished implementation to be removed after Cantera 2.2.
*/
class ElectrodeKinetics : public InterfaceKinetics
{

View file

@ -30,6 +30,7 @@ namespace Cantera
* within the kinetics object that is used to identify the global reaction. Rates of progress
* are defined in terms of the production rate of the special species.
*
* @deprecated Unfinished implementation to be removed after Cantera 2.2.
*/
class ExtraGlobalRxn
{

View file

@ -24,6 +24,7 @@ class Kinetics;
/*!
* Note that all indexes refer to a specific interfacial or homogeneous kinetics object. It does not
* refer to the Phase list indexes.
* @deprecated Unfinished implementation to be removed after Cantera 2.2.
*/
class RxnMolChange
{

View file

@ -51,6 +51,7 @@ public:
/*!
* Wrapper class for 'beuler' integrator
* We derive the class from the class Integrator
* @deprecated Unused. To be removed after Cantera 2.2.
*/
class BEulerInt : public Integrator
{

View file

@ -121,6 +121,7 @@ namespace Cantera
* @endcode
*
* @ingroup numerics
* @deprecated Unused. To be removed after Cantera 2.2.
*/
class NonlinearSolver
{

View file

@ -134,6 +134,7 @@ namespace Cantera
*----------------------------------------------------------------------------
*
* @ingroup solverGroup
* @deprecated Unused. To be removed after Cantera 2.2.
*/
class solveProb
{

View file

@ -915,6 +915,7 @@ public:
/*!
* The default is THROWON_OVERFLOW_CTRB
* Which throws an error in debug mode, but silently changes the answer in non-debug mode
* @deprecated To be removed after Cantera 2.2.
*/
enum CT_RealNumber_Range_Behavior realNumberRangeBehavior_;

View file

@ -38,6 +38,7 @@ int vcsUtil_root1d(double xmin, double xmax, size_t itmax,
double FuncTargVal, int varID,
double* xbest, int printLvl)
{
warn_deprecated("vcsUtil_root1d", "To be removed after Cantera 2.2.");
static int callNum = 0;
const char* stre = "vcs_root1d ERROR: ";
const char* strw = "vcs_root1d WARNING: ";

View file

@ -62,6 +62,7 @@ size_t vcs_optMax(const double* x, const double* xSize, size_t j, size_t n)
int vcs_max_int(const int* vector, int length)
{
warn_deprecated("vcs_max_int", "Unused. To be removed after Cantera 2.2.");
int retn;
if (vector == NULL || length <= 0) {
return 0;

View file

@ -5,6 +5,7 @@
#include "cantera/kinetics/ElectrodeKinetics.h"
#include "cantera/thermo/SurfPhase.h"
#include "cantera/base/utilities.h"
#include "cantera/base/global.h"
#include <cstdio>
@ -19,7 +20,8 @@ ElectrodeKinetics::ElectrodeKinetics(thermo_t* thermo) :
solnPhaseIndex_(npos),
kElectronIndex_(npos)
{
warn_deprecated("class ElectrodeKinetics",
"To be removed after Cantera 2.2.");
}
//============================================================================================================================
ElectrodeKinetics::~ElectrodeKinetics()

View file

@ -98,6 +98,8 @@ ExtraGlobalRxn::ExtraGlobalRxn(Kinetics* k_ptr) :
m_ok(false),
m_reversible(true)
{
warn_deprecated("class ExtraGlobalRxn",
"Unfinished implementation to be removed after Cantera 2.2.");
m_InterfaceKinetics = dynamic_cast<InterfaceKinetics*>(k_ptr);
if (m_InterfaceKinetics) {
m_ThisIsASurfaceRxn = true;

View file

@ -36,6 +36,7 @@ RxnMolChange::RxnMolChange(Cantera::Kinetics* kinPtr, int irxn) :
m_beta(0.0),
m_egr(0)
{
warn_deprecated("class RxnMolChange", "To be removed after Cantera 2.2.");
int nReac = kinPtr->nReactions();
int iph;
AssertTrace(irxn >= 0);

View file

@ -11,6 +11,7 @@
#include "cantera/numerics/BEulerInt.h"
#include "cantera/numerics/SquareMatrix.h"
#include "cantera/base/global.h"
using namespace std;
@ -66,7 +67,7 @@ BEulerInt::BEulerInt() :
m_numTotalTruncFails(0),
num_failures(0)
{
warn_deprecated("class BEulerInt", "To be removed after Cantera 2.2.");
}
BEulerInt::~BEulerInt()

View file

@ -119,6 +119,7 @@ NonlinearSolver::NonlinearSolver(ResidJacEval* func) :
ResidDecreaseNewtExp_(0.0),
ResidDecreaseNewt_(0.0)
{
warn_deprecated("class NonlinearSolver", "To be removed after Cantera 2.2.");
neq_ = m_func->nEquations();
m_ewt.resize(neq_, rtol_);

View file

@ -12,6 +12,7 @@
#include "cantera/numerics/solveProb.h"
#include "cantera/base/clockWC.h"
#include "cantera/base/stringUtils.h"
#include "cantera/base/global.h"
using namespace std;
namespace Cantera
@ -31,6 +32,7 @@ solveProb::solveProb(ResidEval* resid) :
m_maxstep(1000),
m_ioflag(0)
{
warn_deprecated("class solveProb", "To be removed after Cantera 2.2.");
m_neq = m_residFunc->nEquations();
// Dimension solution vector