Struct SolveStats 

pub struct SolveStats<R> {

    pub iterations: usize,
    pub final_residual: R,
    pub final_recurrence_residual: Option<R>,
    pub final_true_residual: Option<R>,
    pub last_preconditioned_residual: Option<R>,
    pub reason: ConvergedReason,
    pub counters: SolverCounters,
    pub gcr_counters: Option<GcrCounters>,
    pub fgmres_counters: Option<FgmresCounters>,
    pub reduction_model: Option<ReductionModel>,
    pub complex_drift_events: usize,
    pub complex_drift_counts: [usize; 6],
    pub complex_drift_max_rel: R,
    pub metrics: SolveMetrics,
    pub nested_pc_failure: Option<NestedPcFailure>,
    pub reason_counters: ReasonDiagnosticsCounters,
    pub gmres_classical_retry: bool,
    pub acceptance_status: AcceptanceStatus,
    pub breakdown_reason: Option<ConvergedReason>,
    pub residual_override_note: Option<String>,
    pub orthogonalization_passes: usize,
    pub orthogonalization_rank_loss: bool,
    pub max_orthogonality_loss_estimate: R,
    pub effective_variant: Option<String>,
    pub effective_restart: Option<usize>,
    pub effective_residual_check_policy: Option<String>,
}

Statistics from a solve operation.

Fields

iterations: usize

Number of iterations performed

final_residual: R

Canonical final residual norm for reporting.

Solvers should prefer storing the explicit true residual norm when it is computed; otherwise this may be a recurrence/estimated residual.

final_recurrence_residual: Option<R>

Optional final residual from the Krylov recurrence/estimator.

final_true_residual: Option<R>

Optional final explicit true residual ||b - A x||_2.

last_preconditioned_residual: Option<R>

Optional latest preconditioned residual norm.

reason: ConvergedReason

Reason for stopping.

This includes mapped preconditioner lifecycle failures (for example DivergedPcSetupFailed/DivergedPcFailed) when setup/apply errors are propagated through KspContext into SolveStats.

counters: SolverCounters

Additional counters collected during the solve.

gcr_counters: Option<GcrCounters>

Optional GCR-specific counters.

fgmres_counters: Option<FgmresCounters>

Optional FGMRES-specific counters.

reduction_model: Option<ReductionModel>

Reduction accounting model for the selected solver variant.

complex_drift_events: usize

Total number of complex drift events observed during reductions.

complex_drift_counts: [usize; 6]

Per-kind complex drift counts captured by the solver.

complex_drift_max_rel: R

Maximum relative imaginary magnitude observed.

metrics: SolveMetrics

Optional solver timing and reduction metrics.

nested_pc_failure: Option<NestedPcFailure>

Structured details for nested preconditioner failures, when available.

Outer solves use this to preserve the inner component/reason/iteration context when KSP-as-PC or other nested preconditioners fail.

reason_counters: ReasonDiagnosticsCounters

Stable per-category reason counters for diagnostics automation.

gmres_classical_retry: bool

True when GMRES internally retried by resetting x and falling back to a classical GMRES pass.

acceptance_status: AcceptanceStatus

Contract acceptance status from true residual + stop reason classification.

breakdown_reason: Option<ConvergedReason>

Breakdown/divergence reason captured before any residual-based override.

residual_override_note: Option<String>

Optional note describing residual-based acceptance override decisions.

orthogonalization_passes: usize

Count of orthogonalization passes executed (including reorthogonalization).

orthogonalization_rank_loss: bool

Whether an orthogonalization rank-loss failure was observed.

max_orthogonality_loss_estimate: R

Max estimate of orthogonality loss observed during the solve.

effective_variant: Option<String>

Effective solver variant selected at runtime (if policy hooks mutated it).

effective_restart: Option<usize>

Effective restart value selected at runtime.

effective_residual_check_policy: Option<String>

Effective residual-check policy selected at runtime.

Implementations

impl<R: Default> SolveStats<R>

pub fn new( iterations: usize, final_residual: R, reason: ConvergedReason, ) -> Self

Construct a new statistics record with zeroed counters.

pub fn with_counters(self, counters: SolverCounters) -> Self

Attach solver counters to an existing statistics record.

pub fn with_reduction_model(self, model: ReductionModel) -> Self

pub fn with_gcr_counters(self, counters: GcrCounters) -> Self

Attach GCR-specific counters.

pub fn with_fgmres_counters(self, counters: FgmresCounters) -> Self

Attach FGMRES-specific counters.

pub fn with_nested_pc_failure(self, failure: NestedPcFailure) -> Self

Attach nested preconditioner failure metadata.

pub fn with_gmres_classical_retry(self, used: bool) -> Self

Mark whether GMRES performed an internal retry to classical GMRES.

pub fn finalize_reason_counters(self) -> Self

Finalize stable reason diagnostics for this stats record.

pub fn reduction_phase_diagnostics(&self) -> Option<ReductionPhaseDiagnostics>

Per-phase reduction diagnostics inferred from solver counters/model.

pub fn with_orthogonalization_diagnostics( self, passes: usize, rank_loss: bool, max_loss_estimate: R, ) -> Self

Attach orthogonalization diagnostics.

pub fn with_effective_runtime_policy( self, variant: impl Into<String>, restart: usize, residual_check_policy: impl Into<String>, ) -> Self

Attach runtime-effective policy knobs selected by the solver.

Trait Implementations

impl<R: Clone> Clone for SolveStats<R>

fn clone(&self) -> SolveStats<R>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug> Debug for SolveStats<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.