Class NewtonRootFinder

Inheritance Relationships

Base Type

Class Documentation

class NewtonRootFinder : public RootFinder

Root finder based on Newton’s method.

Controlled by two parameters: the max number of iterations and the relative error tolerance.

Usage

    RootFinder
    {
        type       Newton;
        maxIter    value; (default 30)
        eps        value; (default 0.001)
    }

Contributors/Copyright: 2016-2019 Timofey Mukha 2017 Saleh Rezaeiravesh

Source files

Public Functions

inline NewtonRootFinder(const word &rootFinderName, std::function<scalar(scalar)> f, std::function<scalar(scalar)> d, const scalar eps, const label maxIter)
inline NewtonRootFinder(std::function<scalar(scalar)> f, std::function<scalar(scalar)> d, const dictionary &dict)
inline NewtonRootFinder(const dictionary &dict)
NewtonRootFinder(const NewtonRootFinder&) = default
inline virtual autoPtr<RootFinder> clone() const
inline virtual ~NewtonRootFinder()
virtual scalar root(scalar guess) const
inline virtual void write(Ostream &os) const