SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
serif::solver::Backtracking Struct Reference

Shorten a Newton step until the complete residual merit decreases sufficiently. More...

#include <options.hpp>

Public Member Functions

void validate () const
 Require a decreasing, finite sequence of positive trial lengths.
 

Public Attributes

double initial_step {1.0}
 
double contraction {0.5}
 
double fraction_to_boundary {0.9}
 
double sufficient_decrease {1.0e-4}
 
double minimum_step {1.0e-8}
 
int maximum_trials {20}
 
bool geometry_preflight {true}
 

Detailed Description

Shorten a Newton step until the complete residual merit decreases sufficiently.

Member Function Documentation

◆ validate()

void serif::solver::Backtracking::validate ( ) const

Require a decreasing, finite sequence of positive trial lengths.

Member Data Documentation

◆ contraction

double serif::solver::Backtracking::contraction {0.5}

◆ fraction_to_boundary

double serif::solver::Backtracking::fraction_to_boundary {0.9}

◆ geometry_preflight

bool serif::solver::Backtracking::geometry_preflight {true}

◆ initial_step

double serif::solver::Backtracking::initial_step {1.0}

◆ maximum_trials

int serif::solver::Backtracking::maximum_trials {20}

◆ minimum_step

double serif::solver::Backtracking::minimum_step {1.0e-8}

◆ sufficient_decrease

double serif::solver::Backtracking::sufficient_decrease {1.0e-4}
The documentation for this struct was generated from the following files: