kryst 4.0.5

Krylov subspace and preconditioned iterative solvers for dense and sparse linear systems, with shared and distributed memory parallelism.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

use crate::algebra::bridge::BridgeScratch;
use crate::algebra::prelude::*;
use crate::ops::klinop::KLinOp;
use crate::solver::common::ReductCtx;
use crate::utils::convergence::ConvergedReason;

#[inline]
pub fn true_residual_norm<A: KLinOp<Scalar = S> + ?Sized>(
    a: &A,
    b: &[S],
    x: &[S],
    red: &ReductCtx,
    tmp: &mut [S],
    scratch: &mut BridgeScratch,
) -> R {
    a.matvec_s(x, tmp, scratch);
    for i in 0..tmp.len() {
        tmp[i] = b[i] - tmp[i];
    }
    red.norm2(tmp)
}

#[inline]
pub fn true_residual_converged_reason(
    true_residual: R,
    bnorm: R,
    atol: R,
    rtol: R,
) -> Option<ConvergedReason> {
    let thr = atol.max(rtol * bnorm);
    if true_residual <= thr {
        return Some(if true_residual <= atol {
            ConvergedReason::ConvergedAtol
        } else {
            ConvergedReason::ConvergedRtol
        });
    }
    None
}

#[inline]
pub fn reconcile_reason_with_true_residual(
    nominal_reason: ConvergedReason,
    true_residual: R,
    bnorm: R,
    atol: R,
    rtol: R,
) -> ConvergedReason {
    let true_reason = true_residual_converged_reason(true_residual, bnorm, atol, rtol);
    if let Some(reason) = true_reason {
        return reason;
    }
    if nominal_reason.is_converged() {
        return ConvergedReason::DivergedMaxIts;
    }
    nominal_reason
}