flexiblesusy::Composite_root_finder< N > Class Template Reference

Encapsulates several root finders. More...

#include <composite_root_finder.hpp>

Collaboration diagram for flexiblesusy::Composite_root_finder< N >:

Public Types
using	Fun_t = std::function< Vec_t(const Vec_t &)>
using	Vec_t = Eigen::Matrix< double, N, 1 >

Public Member Functions
Vec_t	get_solution () const
	returns solution
void	reset ()
	clear all internal data
void	set_max_iterations (std::size_t n)
	set maximum number of iterations
void	set_precision (double p)
	set precision goal
void	solve (const Fun_t &, const Vec_t &)
	solves the boundary value problem with initial guess

Private Attributes
std::size_t	max_it {100}
Vec_t	point {Vec_t::Zero()}
double	precision {1e-3}

Detailed Description

template<std::size_t N>
class flexiblesusy::Composite_root_finder< N >

Encapsulates several root finders.

Definition at line 34 of file composite_root_finder.hpp.

Member Typedef Documentation

Fun_t

template<std::size_t N>

using flexiblesusy::Composite_root_finder< N >::Fun_t = std::function<Vec_t(const Vec_t&)>

Definition at line 37 of file composite_root_finder.hpp.

Vec_t

template<std::size_t N>

using flexiblesusy::Composite_root_finder< N >::Vec_t = Eigen::Matrix<double, N, 1>

Definition at line 36 of file composite_root_finder.hpp.

Member Function Documentation

get_solution()

template<std::size_t N>

Vec_t flexiblesusy::Composite_root_finder< N >::get_solution ( ) const

inline

returns solution

Definition at line 40 of file composite_root_finder.hpp.

References flexiblesusy::Composite_root_finder< N >::point.

Referenced by flexiblesusy::Shooting_solver< N >::solve().

reset()

template<std::size_t N>

void flexiblesusy::Composite_root_finder< N >::reset

(

)

clear all internal data

Definition at line 57 of file composite_root_finder.hpp.

set_max_iterations()

template<std::size_t N>

void flexiblesusy::Composite_root_finder< N >::set_max_iterations ( std::size_t  n )

inline

set maximum number of iterations

Definition at line 44 of file composite_root_finder.hpp.

References flexiblesusy::Composite_root_finder< N >::max_it.

Referenced by flexiblesusy::Shooting_solver< N >::solve().

set_precision()

template<std::size_t N>

void flexiblesusy::Composite_root_finder< N >::set_precision ( double  p )

inline

set precision goal

Definition at line 42 of file composite_root_finder.hpp.

References flexiblesusy::Composite_root_finder< N >::precision.

Referenced by flexiblesusy::Shooting_solver< N >::solve().

solve()

template<std::size_t N>

void flexiblesusy::Composite_root_finder< N >::solve	(	const Fun_t &	fun,
		const Vec_t &	v0
	)

solves the boundary value problem with initial guess

Definition at line 63 of file composite_root_finder.hpp.

References flexiblesusy::Root_finder< dimension >::solve().

Referenced by flexiblesusy::Shooting_solver< N >::solve().

Member Data Documentation

max_it

template<std::size_t N>

std::size_t flexiblesusy::Composite_root_finder< N >::max_it {100}

private

Definition at line 53 of file composite_root_finder.hpp.

Referenced by flexiblesusy::Composite_root_finder< N >::set_max_iterations().

point

template<std::size_t N>

Vec_t flexiblesusy::Composite_root_finder< N >::point {Vec_t::Zero()}

private

Definition at line 51 of file composite_root_finder.hpp.

Referenced by flexiblesusy::Composite_root_finder< N >::get_solution().

precision

template<std::size_t N>

double flexiblesusy::Composite_root_finder< N >::precision {1e-3}

private

Definition at line 52 of file composite_root_finder.hpp.

Referenced by flexiblesusy::Composite_root_finder< N >::set_precision().

---

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

• composite_root_finder.hpp