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

Separate the convergence norm from the line-search merit for custom metrics. More...

#include <options.hpp>

Public Member Functions

bool valid () const noexcept
 A metric must give finite, nonnegative values to drive solver decisions.
 

Public Attributes

double residual_norm {0.0}
 
double merit {0.0}
 

Detailed Description

Separate the convergence norm from the line-search merit for custom metrics.

Member Function Documentation

◆ valid()

bool serif::solver::MetricEvaluation::valid ( ) const
inlinenodiscardnoexcept

A metric must give finite, nonnegative values to drive solver decisions.

Member Data Documentation

◆ merit

double serif::solver::MetricEvaluation::merit {0.0}

◆ residual_norm

double serif::solver::MetricEvaluation::residual_norm {0.0}

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