continuation_option(3rheolef)

πŸ“¦
version 7.2 Β· 4 versions
, in debian trixie, ubuntu noble, ubuntu questing

✨ continuation_option β€” bestie, it's giving SOLVER OPTIONS ✨

okay so real quick, the vibe: this is continuation_option(3rheolef) πŸ’– like, that's the whole title, we're not doing a boring header line, we're doing personality.


🌸 NAME 🌸

continuation_option β€” the continuation solver options, from rheolef-7.2 πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

So basically this class is the little messenger bag πŸ’… that carries options over to the continuation(3) algorithm. That's it. That's the job. She delivers the options, she slays, she goes home. ✨


πŸ’– OPTIONS πŸ’–

  • tol
  • max_iter

These two cuties get handed straight off to the damped_newton(3) algorithm while the continuation(3) algorithm is doing its thing. 🫢

  • ini_delta_parameter
  • max_delta_parameter
  • max_delta_parameter
not me listing max_delta_parameter twice 😭 but fr fr, that's exactly how the page says it, so we're keeping it, no cap.

These ones are the mission control for how continuation(3) moves along the branch of solution πŸ‘‘. And when you're using the Keller continuation, these options are the ones controlling the arc-length parameter. iconic behaviour honestly.

  • n_adapt

When this one is non-zero, it lets you switch on the optional mesh adaptation feature (peep adapt(3)) that's embedded right there inside the continuation algorithm. βœ¨πŸ›


🌈 TODO 🌈

Complete the documentation of all the others options. πŸ’€ yeah. the rest of them are still a mystery bestie. we're working on it.


πŸŽ€ 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(3)) β€” like, she's literally the daughter of adapt_option, family business fr fr πŸ’…:

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;
};

πŸ‘‘ AUTHOR πŸ‘‘

Pierre Saramito <Pierre.Saramito@imag.fr> 🫢


Copyright (C) 2000-2018 Pierre Saramito <Pierre.Saramito@imag.fr>

GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.

This is free software: you are free to change and redistribute it.

There is NO WARRANTY, to the extent permitted by law.


okay that's the whole page bestie, we ate and left no crumbs πŸ“βœ¨ β€” this was rheolef, Version 7.2, and the page was continuation_option(3rheolef), mwah πŸ’…πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from