OGS
NumLib::StepResult Struct Reference

Detailed Description

Result returned by a step strategy's applyStep().

Definition at line 30 of file NewtonStepStrategy.h.

#include <NewtonStepStrategy.h>

Public Attributes

bool success
double step_length
bool x_new_is_set

Member Data Documentation

◆ step_length

double NumLib::StepResult::step_length

Effective step length taken. 1.0 = full Newton step. Informational — used for logging and trust region radius updates.

Definition at line 40 of file NewtonStepStrategy.h.

◆ success

bool NumLib::StepResult::success

False if the strategy could not produce a usable step at all (e.g. line search failed all backtracks, trust region radius collapsed to zero). Newton::solve() should treat this like a linear solver failure and break.

Definition at line 36 of file NewtonStepStrategy.h.

◆ x_new_is_set

bool NumLib::StepResult::x_new_is_set

True if the strategy has already updated x_new internally and Newton::solve() should NOT apply minus_delta_x again. For FixedDamping this is true; for trust region variants that compute their own direction this is also true.

Definition at line 46 of file NewtonStepStrategy.h.

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