NonlinearSolver::OptionTags::MaxGlobalizationSteps< OptionsGroup > Struct Template Reference

The maximum number of allowed globalization steps. More...

#include <Tags.hpp>

Public Types
using	type = size_t
using	group = OptionsGroup

Static Public Member Functions
static type	suggested_value ()

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<typename OptionsGroup>
struct NonlinearSolver::OptionTags::MaxGlobalizationSteps< OptionsGroup >

The maximum number of allowed globalization steps.

Nonlinear solves of well-posed problems should never hit this limit because the step size shrinks and eventually triggers the sufficient-decrease condition (see NonlinearSolver::OptionTags::SufficientDecrease). So the suggested value just provides a safety-net to prevent the globalization from running forever when the problem is ill-posed.

Member Data Documentation

help

template<typename OptionsGroup >

constexpr Options::String NonlinearSolver::OptionTags::MaxGlobalizationSteps< OptionsGroup >::help

staticconstexpr

Initial value:

= {
      "Maximum number of globalization steps"}

---

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

• src/ParallelAlgorithms/NonlinearSolver/Tags.hpp