Class BisectionRootFinder

Defined in File BisectionRootFinder.H

Inheritance Relationships

Base Type

public RootFinder (Class RootFinder)

Class Documentation

class BisectionRootFinder : public RootFinder 

Root finder based on the bisection method.

Controlled by the maximum number of iterations. The bisection method is meant to be used with equations where the Jacobian is not well defined. The root must be bracketed by the supplied lower and upper bounds. The convergence tolerance is fixed internally as a binary digit target for the root estimate.

Usage

    RootFinder
    {
        type       Bisection;
        maxIter    value; (default 30)
    }

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

Source files

Public Functions

BisectionRootFinder(const word &rootFinderName, std::function<scalar(scalar)>, std::function<scalar(scalar)>, const label maxIter): Construct given a function and its derivative.

BisectionRootFinder(std::function<scalar(scalar)>, std::function<scalar(scalar)>, const dictionary &dict): Construct given a function, its derivative and dictionary.

BisectionRootFinder(const dictionary &dict): Construct given dictionary.

BisectionRootFinder(const BisectionRootFinder&) = default

inline virtual autoPtr<RootFinder> clone() const: Clone the object.

inline virtual ~BisectionRootFinder()

virtual std::pair<scalar, label> root(scalar guess, scalar lowerBound, scalar upperBound) const: Compute and return root.

inline virtual void write(Ostream &os) const: Write parameters to stream.