DiFfRG::AbstractRootFinder< dim > Class Template Reference

#include <root_finding.hh>

Public Member Functions
	AbstractRootFinder (const FUN &f, const double abs_tol=1e-4, const int max_iter=1000)
void	set_abs_tol (const double abs_tol)
void	set_max_iter (const uint max_iter)
uint	get_iter () const
std::array< double, dim >	search ()

Protected Types
using	FUN = std::function<bool(const std::array<double, dim> &)>

Protected Member Functions
virtual std::array< double, dim >	search_impl ()=0

Protected Attributes
FUN	f
double	abs_tol
uint	max_iter
uint	iter

Member Typedef Documentation

FUN

template<int dim>

using DiFfRG::AbstractRootFinder< dim >::FUN = std::function<bool(const std::array<double, dim> &)>

protected

Constructor & Destructor Documentation

AbstractRootFinder()

template<int dim>

DiFfRG::AbstractRootFinder< dim >::AbstractRootFinder ( const FUN & f, const double abs_tol = 1e-4, const int max_iter = 1000 )

inline

Member Function Documentation

get_iter()

template<int dim>

uint DiFfRG::AbstractRootFinder< dim >::get_iter ( ) const

inline

search()

template<int dim>

std::array< double, dim > DiFfRG::AbstractRootFinder< dim >::search ( )

inline

search_impl()

template<int dim>

virtual std::array< double, dim > DiFfRG::AbstractRootFinder< dim >::search_impl ( )

protectedpure virtual

set_abs_tol()

template<int dim>

void DiFfRG::AbstractRootFinder< dim >::set_abs_tol ( const double abs_tol )

inline

set_max_iter()

template<int dim>

void DiFfRG::AbstractRootFinder< dim >::set_max_iter ( const uint max_iter )

inline

Member Data Documentation

abs_tol

template<int dim>

double DiFfRG::AbstractRootFinder< dim >::abs_tol

protected

f

template<int dim>

FUN DiFfRG::AbstractRootFinder< dim >::f

protected

iter

template<int dim>

uint DiFfRG::AbstractRootFinder< dim >::iter

protected

max_iter

template<int dim>

uint DiFfRG::AbstractRootFinder< dim >::max_iter

protected

---

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

• /home/runner/work/DiFfRG/DiFfRG/DiFfRG/include/DiFfRG/common/root_finding.hh