doxygen/modules/BrentsMethod_8h_source.html

//* This file is part of the MOOSE framework

//* https://mooseframework.inl.gov

//*

//* All rights reserved, see COPYRIGHT for full restrictions

//* https://github.com/idaholab/moose/blob/master/COPYRIGHT

//*

//* Licensed under LGPL 2.1, please see LICENSE for details

//* https://www.gnu.org/licenses/lgpl-2.1.html


#pragma once


// MOOSE includes

#include "Moose.h"

#include "MooseTypes.h"


// C++ includes

#include <functional>


namespace BrentsMethod

{

void bracket(std::function<Real(Real)> const & f, Real & x1, Real & x2);


Real root(std::function<Real(Real)> const & f, Real x1, Real x2, Real tol = 1.0e-12);

}


f
Real f(Real x)
Test function for Brents method.
Definition BrentsMethodTest.C:21

tol
const double tol
Definition EquilibriumConstantFitTest.C:16

MooseTypes.h

Moose.h

BrentsMethod
Brent's method is used to find the root of a function f(x), i.e., find x such that f(x) = 0.
Definition BrentsMethod.h:27

BrentsMethod::root
Real root(std::function< Real(Real)> const &f, Real x1, Real x2, Real tol=1.0e-12)
Finds the root of a function using Brent's method.
Definition BrentsMethod.C:66

BrentsMethod::bracket
void bracket(std::function< Real(Real)> const &f, Real &x1, Real &x2)
Function to bracket a root of a given function.
Definition BrentsMethod.C:17