SpECTRE  v2024.03.19
NonlinearSolver::OptionTags::DampingFactor< OptionsGroup > Struct Template Reference

Nonlinear solver steps are damped by this factor. More...

#include <Tags.hpp>

Public Types

using type = double
 
using group = OptionsGroup
 

Static Public Member Functions

static type lower_bound ()
 
static type upper_bound ()
 
static type suggested_value ()
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

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

Nonlinear solver steps are damped by this factor.

Instead of attempting to take full-length steps when correcting the solution in each nonlinear solver step (see NonlinearSolver::Tags::Correction), reduce the step length by this factor. This damping occurs before any globalization steps that may further reduce the step length.

Member Data Documentation

◆ help

template<typename OptionsGroup >
constexpr Options::String NonlinearSolver::OptionTags::DampingFactor< OptionsGroup >::help
staticconstexpr
Initial value:
= {
"Multiply corrections by this factor"}

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