plask::optical::effective::RootBrent Class Reference

#include <solvers/optical/effective/brent.hpp>

Inheritance diagram for plask::optical::effective::RootBrent:

Collaboration diagram for plask::optical::effective::RootBrent:

Public Member Functions
	RootBrent (Solver &solver, const function_type &val_fun, DataLog< dcomplex, dcomplex > &log_value, const Params &pars)
dcomplex	find (dcomplex start) const override
	Search for a single mode starting from the given point: point.
Public Member Functions inherited from plask::optical::effective::RootDigger
	RootDigger (Solver &solver, const function_type &val_fun, DataLog< dcomplex, dcomplex > &log_value, const Params &pars)
virtual	~RootDigger ()

Protected Member Functions
double	axisBrent (dcomplex start, double &fx, bool real) const
Protected Member Functions inherited from plask::optical::effective::RootDigger
dcomplex	valFunction (dcomplex x) const

Additional Inherited Members
Public Types inherited from plask::optical::effective::RootDigger
enum	Method { ROOT_MULLER , ROOT_BROYDEN , ROOT_BRENT }
	Root finding method. More...
typedef std::function< dcomplex(dcomplex)>	function_type
Static Public Member Functions inherited from plask::optical::effective::RootDigger
static std::unique_ptr< RootDigger >	get (Solver *solver, const function_type &func, DataLog< dcomplex, dcomplex > &detlog, const Params &params)
	Get root digger for given function and params.
static void	readRootDiggerConfig (XMLReader &reader, Params &params)
	Read configuration from xml.
Public Attributes inherited from plask::optical::effective::RootDigger
Params	params
Protected Attributes inherited from plask::optical::effective::RootDigger
Solver &	solver
function_type	val_function
DataLog< dcomplex, dcomplex > &	log_value

Detailed Description

Definition at line 21 of file brent.hpp.

Constructor & Destructor Documentation

RootBrent()

plask::optical::effective::RootBrent::RootBrent ( Solver &  solver, const function_type &  val_fun, DataLog< dcomplex, dcomplex > &  log_value, const Params &  pars  )

inline

Definition at line 37 of file brent.hpp.

Member Function Documentation

axisBrent()

double plask::optical::effective::RootBrent::axisBrent ( dcomplex  start, double &  fx, bool  real  ) const

protected

Definition at line 21 of file brent.cpp.

find()

dcomplex plask::optical::effective::RootBrent::find ( dcomplex  start ) const

overridevirtual

Search for a single mode starting from the given point: point.

Implements plask::optical::effective::RootDigger.

Definition at line 172 of file brent.cpp.

---

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

• solvers/optical/effective/brent.hpp
• solvers/optical/effective/brent.cpp