`continuation_option`

continuation solver options

# Description

This class is used to send options to the `continuation` algorithm.

# Options

`tol`
`max_iter`

> These options are transmitted to the `damped_newton` algorithm during the `continuation` algorithm.

`ini_delta_parameter`
`max_delta_parameter`
`max_delta_parameter`

> These options control the `continuation` evolution along the branch of solution. When using the Keller continuation, these options control the arc-length parameter.

`n_adapt`

> When non-zero, it allows one to activate the optional mesh adaptation feature (see `adapt`) embedded in the continuation algorithm.

# TODO

Complete the documentation of all the others options.

# Implementation

This documentation has been generated from file main/lib/continuation_option.h

The `continuation_option` class is simply derivated from the `adapt_option` one (see `adapt`):

struct continuation_option : adapt_option {
Float ini_direction;
Float kappa;
Float tol;
size_t max_iter;
size_t newton_max_iter;
Float min_delta_parameter;
Float max_delta_parameter;
Float ini_delta_parameter;
Float theta_decr;
Float theta_incr;
Float theta_variation;
size_t min_delta_parameter_successive_count_max;
Float tol_cos_angle;
bool do_prediction;
bool do_check_going_back;
size_t n_adapt;
continuation_option(const adapt_option& aopt = adapt_option());
void check() const;
};
rheolef::continuation_option::theta_decr
Float theta_decr
Definition: continuation_option.h:86
rheolef::continuation_option::ini_delta_parameter
Float ini_delta_parameter
Definition: continuation_option.h:85
rheolef::continuation_option::newton_max_iter
size_t newton_max_iter
Definition: continuation_option.h:82
rheolef::continuation_option::kappa
Float kappa
Definition: continuation_option.h:79
rheolef::continuation_option::theta_incr
Float theta_incr
Definition: continuation_option.h:87
rheolef::continuation_option::tol
Float tol
Definition: continuation_option.h:80
rheolef::continuation_option::ini_direction
Float ini_direction
Definition: continuation_option.h:78
rheolef::continuation_option::min_delta_parameter_successive_count_max
size_t min_delta_parameter_successive_count_max
Definition: continuation_option.h:89
rheolef::continuation_option::theta_variation
Float theta_variation
Definition: continuation_option.h:88
rheolef::adapt_option::adapt_option
adapt_option()
Definition: adapt.h:168
rheolef::continuation_option::check
void check() const
Definition: continuation_option.h:124
rheolef::continuation_option::min_delta_parameter
Float min_delta_parameter
Definition: continuation_option.h:83
rheolef::continuation_option::max_iter
size_t max_iter
Definition: continuation_option.h:81
rheolef::continuation_option::continuation_option
continuation_option(const adapt_option &aopt=adapt_option())
Definition: continuation_option.h:103
Float
see the Float page for the full documentation
rheolef::continuation_option::n_adapt
size_t n_adapt
Definition: continuation_option.h:93
rheolef::continuation_option::do_prediction
bool do_prediction
Definition: continuation_option.h:91
rheolef::continuation_option::tol_cos_angle
Float tol_cos_angle
Definition: continuation_option.h:90
rheolef::continuation_option::max_delta_parameter
Float max_delta_parameter
Definition: continuation_option.h:84
rheolef::continuation_option::do_check_going_back
bool do_check_going_back
Definition: continuation_option.h:92