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

Deprecate RootFind

Browse source
This commit is contained in:
Ray Speth 2016-11-03 23:17:34 -04:00
parent da87260062
commit fb9a4b1d61
2 changed files with 4 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
include/cantera/numerics/RootFind.h
View file

@ -43,13 +43,8 @@ namespace Cantera
//! Root finder for 1D problems
/*!
* @attention This class currently does not have any test cases or examples. Its
* implementation may be incomplete, and future changes to Cantera may
* unexpectedly cause this class to stop working. If you use this class,
* please consider contributing examples or test cases. In the absence of
* new tests or examples, this class may be deprecated and removed in a
* future version of Cantera. See
* https://github.com/Cantera/cantera/issues/267 for additional information.
* @deprecated Unused. To be removed after Cantera 2.3. See
* boost::math::tools::toms748_solve for an alternative.
*
* The root finder solves a single nonlinear equation described below.
*

2
src/numerics/RootFind.cpp
View file

@ -52,6 +52,8 @@ RootFind::RootFind(ResidEval* resid) :
x_minTried_(1.0E300),
fx_minTried_(0.0)
{
warn_deprecated("Unused. To be removed after Cantera 2.3. See "
"boost::math::tools::toms748_solve for an alternative.");
}
RootFind::RootFind(const RootFind& r) :