SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::solver::Newton Struct Reference

Accuracy and work limits for finding one equilibrium star. More...

#include <options.hpp>

Collaboration diagram for serif::solver::Newton:
[legend]

Public Member Functions

void validate () const
 Check tolerances and budgets before evaluating any candidate.
 
double convergence_threshold (double initial_norm) const
 Freeze the convergence threshold from this solve's initial residual.
 

Public Attributes

double relative_tolerance {1.0e-8}
 
double absolute_tolerance {0.0}
 
int maximum_iterations {50}
 
linear::Control linear_solve {.relative_tolerance = 0.03, .maximum_iterations = 200}
 

Detailed Description

Accuracy and work limits for finding one equilibrium star.

Member Function Documentation

◆ convergence_threshold()

double serif::solver::Newton::convergence_threshold ( double initial_norm) const
nodiscard

Freeze the convergence threshold from this solve's initial residual.

◆ validate()

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

Check tolerances and budgets before evaluating any candidate.

Member Data Documentation

◆ absolute_tolerance

double serif::solver::Newton::absolute_tolerance {0.0}

◆ linear_solve

linear::Control serif::solver::Newton::linear_solve {.relative_tolerance = 0.03, .maximum_iterations = 200}

◆ maximum_iterations

int serif::solver::Newton::maximum_iterations {50}

◆ relative_tolerance

double serif::solver::Newton::relative_tolerance {1.0e-8}

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