SpECTRE  v2024.04.12
Public Types | Static Public Member Functions | List of all members
NonlinearSolver::Tags::StepLength< OptionsGroup > Struct Template Reference

The length of nonlinear solver steps. More...

#include <Tags.hpp>

Public Types

using type = double
 

Static Public Member Functions

static std::string name ()
 

Detailed Description

template<typename OptionsGroup>
struct NonlinearSolver::Tags::StepLength< OptionsGroup >

The length of nonlinear solver steps.

Instead of taking full-length nonlinear solver steps when correcting the solution as detailed in NonlinearSolver::Tags::Correction, the correction is multiplied by this step length.

The NonlinearSolver::Tags::DampingFactor multiplies the initial length of each step such that the nonlinear solver never takes full-length steps if the damping factor is below one. The step length can be further reduced by the globalization procedure. See NonlinearSolver::NewtonRaphson for details.

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