Celeritas  0.5.0-86+4a8eea4
Public Member Functions | List of all members
celeritas::IllinoisRootFinder< F > Class Template Reference

Perform Regula Falsi (see RegulaFalsi for more details) iterations given a root function func and tolerance tol using the Illinois method. More...

#include <IllinoisRootFinder.hh>

Public Member Functions

CELER_FUNCTION IllinoisRootFinder (F &&func, real_type tol)
 Construct from function.
 
CELER_FUNCTION real_type operator() (real_type left, real_type right)
 Solve for a root between the two points. More...
 

Detailed Description

template<class F>
class celeritas::IllinoisRootFinder< F >

Perform Regula Falsi (see RegulaFalsi for more details) iterations given a root function func and tolerance tol using the Illinois method.

Illinois method modifies the standard approach by comparing the sign of func(root) approximation in the current iteration with the previous approximation. If both iterations are on the same side then the func at the bound on the other side is halved.

Member Function Documentation

◆ operator()()

template<class F >
CELER_FUNCTION real_type celeritas::IllinoisRootFinder< F >::operator() ( real_type  left,
real_type  right 
)
inline

Solve for a root between the two points.

Enum defining side of aproximated root to true root


The documentation for this class was generated from the following file: