Class IterativeAlgorithmController

Class Documentation

class IterativeAlgorithmController

Controller for iterative algorithms.

Public Functions

inline IterativeAlgorithmController(uint_t maxIterations, real_t exitTolerance)

Constructor.

IterativeAlgorithmController(const IterativeAlgorithmController&) = default

Copy constructor.

IterativeAlgorithmController(IterativeAlgorithmController&&) = default

Move copy constructor.

IterativeAlgorithmController &operator=(const IterativeAlgorithmController&) = default

copy assignement

IterativeAlgorithmController &operator=(IterativeAlgorithmController&&) = default

move copy assignement

~IterativeAlgorithmController() = default

Destructor.

bool continue_iterations()

Returns true if the iterations of the algorithm should be continued.

inline bool show_iterations() const

show iterations

inline bool track_residuals() const

track_residuals

Returns:

inline void set_tolerance(real_t tol)

set_tolerance

Parameters:

tol –

inline void set_show_iterations_flag(bool flag)

show iterations

inline void set_track_residuals_flag(bool flag)

set_track_residuals_flag

Parameters:

flag –

inline void set_num_threads(uint_t nthreads)

Set the number of threads.

inline void set_max_itrs(uint_t max_itrs)

set_max_itrs

Parameters:

max_itrs –

inline uint_t get_current_iteration() const

Returns the current iteration index.

inline real_t get_exit_tolerance() const

Returns the exit tolerance for the algorithm.

inline uint_t get_max_iterations() const

Return the maximum number of iterations.

inline uint_t get_num_threads() const

Get the number of threads used.

inline real_t get_residual() const

get_residual

Returns:

IterativeAlgorithmResult get_state() const

Returns the state of the controller.

inline void update_residual(real_t res)

Update the residual.

void reset(const IterativeAlgorithmController &control)

reset

void reset()

reset