RootFind.h File Reference

  Header file for implicit nonlinear solver of a one dimensional function

(see Numerical Utilities within Cantera and class RootFind). More...

#include <vector>
#include "ResidEval.h"

Include dependency graph for RootFind.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	RootFind
	Root finder for 1D problems. More...
struct	RootFind::rfTable
	Structure containing the iteration history. More...

Namespaces
namespace	Cantera
	Provides class Nucleus.

Macros
Constant which determines the return integer from the routine
#define	ROOTFIND_SUCCESS   0
	This means that the root solver was a success.
#define	ROOTFIND_SUCCESS_XCONVERGENCEONLY   1
	This return value means that the root finder resolved a solution in the x coordinate However, convergence in F was not achieved.
#define	ROOTFIND_FAILEDCONVERGENCE   -1
	This means that the root solver failed to achieve convergence.
#define	ROOTFIND_BADINPUT   -2
	This means that the input to the root solver was defective.
#define	ROOTFIND_SOLNLOWERTHANXMIN   -3
	This means that the rootfinder believes the solution is lower than xmin.
#define	ROOTFIND_SOLNHIGHERTHANXMAX   -4
	This means that the rootfinder believes the solution is higher than xmax.

Detailed Description

  Header file for implicit nonlinear solver of a one dimensional function

(see Numerical Utilities within Cantera and class RootFind).

Definition in file RootFind.h.