kynema_sgf::rans_convergence::EnvelopeFit Struct Reference

#include <RANSConvergence.H>

Public Attributes
bool	valid {false}
	True if the fit succeeded and the extrapolation is usable.
amrex::Real	rate {0.0_rt}
	Decay rate \(r\) in 1/s; positive means the envelope is shrinking.
amrex::Real	amplitude {0.0_rt}
	Amplitude \(A\) of the fitted exponential.
amrex::Real	rsq {0.0_rt}
	Coefficient of determination of the fit, computed in log space.
amrex::Real	time_to_threshold {-1.0_rt}
	Estimated seconds from the last sample until the threshold is reached.

Detailed Description

Result of fitting an exponential decay to an envelope history

Holds the outcome of a least-squares fit of \(s(t) = A e^{-rt}\) to a sequence of envelope spreads, along with the extrapolated time at which the fit would reach a requested threshold.

Member Data Documentation

amplitude

amrex::Real kynema_sgf::rans_convergence::EnvelopeFit::amplitude {0.0_rt}

Amplitude \(A\) of the fitted exponential.

rate

amrex::Real kynema_sgf::rans_convergence::EnvelopeFit::rate {0.0_rt}

Decay rate \(r\) in 1/s; positive means the envelope is shrinking.

rsq

amrex::Real kynema_sgf::rans_convergence::EnvelopeFit::rsq {0.0_rt}

Coefficient of determination of the fit, computed in log space.

time_to_threshold

amrex::Real kynema_sgf::rans_convergence::EnvelopeFit::time_to_threshold {-1.0_rt}

Estimated seconds from the last sample until the threshold is reached.

valid

bool kynema_sgf::rans_convergence::EnvelopeFit::valid {false}

True if the fit succeeded and the extrapolation is usable.

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/utilities/output_quantities/RANSConvergence.H