Struct RestartGmresOptions 

pub struct RestartGmresOptions {
    pub max_outer_iters: usize,
    pub rtol: f64,
    pub inner_max_iter: usize,
    pub inner_max_restarts: usize,
    pub min_reduction: Option<f64>,
    pub inner_rtol: Option<f64>,
    pub verbose: bool,
}

Options for restarted GMRES with truncation.

This is used by restart_gmres_with_truncation which wraps the standard GMRES with an outer loop that recomputes the true residual at each restart.

Fields

max_outer_iters: usize

Maximum number of outer restart iterations. Default: 20

rtol: f64

Convergence tolerance for relative residual norm (based on true residual). The solver stops when ||b - A*x|| / ||b|| < rtol. Default: 1e-10

inner_max_iter: usize

Maximum iterations per inner GMRES cycle. Default: 10

inner_max_restarts: usize

Number of restarts within each inner GMRES (usually 0). Default: 0

min_reduction: Option<f64>

Stagnation detection threshold. If the residual reduction ratio exceeds this value (i.e., residual doesn’t decrease enough), the solver considers it stagnated. For example, 0.99 means stagnation is detected when residual decreases by less than 1%. Default: None (no stagnation detection)

inner_rtol: Option<f64>

Inner GMRES relative tolerance. If None, uses 0.1 (solve inner problem loosely). Default: None

verbose: bool

Whether to print convergence information. Default: false

Implementations

impl RestartGmresOptions

pub fn new() -> Self

Create new options with default values.

pub fn with_max_outer_iters(self, max_outer_iters: usize) -> Self

Set maximum number of outer iterations.

pub fn with_rtol(self, rtol: f64) -> Self

Set convergence tolerance.

pub fn with_inner_max_iter(self, inner_max_iter: usize) -> Self

Set maximum iterations per inner GMRES cycle.

pub fn with_inner_max_restarts(self, inner_max_restarts: usize) -> Self

Set number of restarts within each inner GMRES.

pub fn with_min_reduction(self, min_reduction: f64) -> Self

Set stagnation detection threshold.

pub fn with_inner_rtol(self, inner_rtol: f64) -> Self

Set inner GMRES relative tolerance.

pub fn with_verbose(self, verbose: bool) -> Self

Enable verbose output.

Trait Implementations

impl Clone for RestartGmresOptions

fn clone(&self) -> RestartGmresOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestartGmresOptions

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

Formats the value using the given formatter.

impl Default for RestartGmresOptions

fn default() -> Self

Returns the “default value” for a type.