Skip to main content

AMGConfig

kryst::preconditioner::amg

Struct AMGConfig 

Source 
pub struct AMGConfig {
Show 99 fields
    pub max_levels: usize,
    pub strong_threshold: f64,
    pub coarse_threshold: usize,
    pub max_coarse_size: usize,
    pub min_coarse_size: usize,
    pub truncation_factor: f64,
    pub max_elements_per_row: usize,
    pub interpolation_truncation: f64,
    pub rap_truncation_abs: f64,
    pub rap_max_elements_per_row: usize,
    pub keep_transpose: bool,
    pub keep_pivot_in_rap: bool,
    pub require_spd: bool,
    pub spd_diag_floor: f64,
    pub forbid_non_galerkin_in_spd: bool,
    pub grid_relax_type: [RelaxType; 4],
    pub num_grid_sweeps: [usize; 4],
    pub pre_sweeps: usize,
    pub post_sweeps: usize,
    pub coarsen_type: CoarsenType,
    pub interp_type: InterpType,
    pub relax_type: RelaxType,
    pub logging_level: usize,
    pub print_level: usize,
    pub tolerance: f64,
    pub max_iterations: usize,
    pub min_iterations: usize,
    pub ieee_checks: bool,
    pub optimize_workspace: bool,
    pub jacobi_omega: f64,
    pub adaptive_interp: bool,
    pub adaptive_samples: usize,
    pub adaptive_smooth_steps: usize,
    pub adaptive_smooth_omega: f64,
    pub adaptive_lambda: f64,
    pub adaptive_enforce_sum1: bool,
    pub adaptive_weight_mode: AdaptiveWeight,
    pub chebyshev_recompute_esteig: bool,
    pub chebyshev_safety: f64,
    pub chebyshev_lower_ratio: f64,
    pub chebyshev_power_steps: usize,
    pub chebyshev_degree: usize,
    pub use_level_scheduling: bool,
    pub drop_tol: f64,
    pub stats_eps: f64,
    pub verify_p_rank: bool,
    pub rank_sketch_cols: usize,
    pub rank_cond_threshold: f64,
    pub rank_min_col_norm: f64,
    pub verify_galerkin: bool,
    pub galerkin_samples: usize,
    pub galerkin_rel_tol: f64,
    pub on_rank_failure: RankFallback,
    pub fsai_dist: usize,
    pub fsai_use_strength: bool,
    pub fsai_max_per_row: usize,
    pub fsai_lambda: f64,
    pub fsai_adaptive_passes: usize,
    pub fsai_drop_tol: f64,
    pub fsai_damping: f64,
    pub normalize_strength: bool,
    pub coarse_solve: CoarseSolve,
    pub ilu_drop_tol: f64,
    pub ilu_fill_per_row: usize,
    pub max_operator_complexity: Option<f64>,
    pub agg_num_levels: usize,
    pub aggressive_mis_k: usize,
    pub max_strong_per_row: Option<usize>,
    pub cycle_type: CycleType,
    pub kcycle: Option<KCycle>,
    pub fmg_nu_pre: usize,
    pub fmg_nu_post: usize,
    pub fmg_gamma: usize,
    pub fmg_levels_use: Option<usize>,
    pub non_galerkin: NonGalerkin,
    pub nodal: NodalMode,
    pub block_size: usize,
    pub num_functions: usize,
    pub near_nullspace: Option<NearNullspace>,
    pub filter_trial_vectors: Option<Vec<Vec<f64>>>,
    pub filter_omega: f64,
    pub filter_after_non_galerkin: bool,
    pub post_interp: PostInterpType,
    pub flexible_level: Option<usize>,
    pub flexible_iters: usize,
    pub flexible_rtol: f64,
    pub flexible_pc_sweeps: usize,
    pub mixed_precision: Option<MixedPrecision>,
    pub mixed_storage: MixedStorage,
    pub conditioning: ConditioningOptions,
    pub dist_coarse_strategy: DistCoarseStrategy,
    pub dist_coarse_repartition: DistCoarseRepartition,
    pub dist_coarse_solver_route: DistCoarseSolverRoute,
    pub dist_apply_instrumentation: bool,
    pub dist_coarse_ghost_scale: f64,
    pub require_native_complex_hierarchy: bool,
    pub level_relax_overrides: BTreeMap<usize, RelaxType>,
    pub level_sweep_overrides: BTreeMap<usize, (usize, usize)>,
    pub level_coarse_overrides: BTreeMap<usize, CoarseSolve>,

}
Available on crate feature backend-faer only.

Fields§

§max_levels: usize§strong_threshold: f64§coarse_threshold: usize§max_coarse_size: usize§min_coarse_size: usize§truncation_factor: f64§max_elements_per_row: usize§interpolation_truncation: f64§rap_truncation_abs: f64§rap_max_elements_per_row: usize§keep_transpose: bool§keep_pivot_in_rap: bool§require_spd: bool§spd_diag_floor: f64§forbid_non_galerkin_in_spd: bool§grid_relax_type: [RelaxType; 4]§num_grid_sweeps: [usize; 4]§pre_sweeps: usize§post_sweeps: usize§coarsen_type: CoarsenType§interp_type: InterpType§relax_type: RelaxType§logging_level: usize§print_level: usize§tolerance: f64§max_iterations: usize§min_iterations: usize§ieee_checks: bool§optimize_workspace: bool§jacobi_omega: f64§adaptive_interp: bool§adaptive_samples: usize§adaptive_smooth_steps: usize§adaptive_smooth_omega: f64§adaptive_lambda: f64§adaptive_enforce_sum1: bool§adaptive_weight_mode: AdaptiveWeight§chebyshev_recompute_esteig: bool§chebyshev_safety: f64§chebyshev_lower_ratio: f64§chebyshev_power_steps: usize§chebyshev_degree: usize§use_level_scheduling: bool§drop_tol: f64§stats_eps: f64§verify_p_rank: bool§rank_sketch_cols: usize§rank_cond_threshold: f64§rank_min_col_norm: f64§verify_galerkin: bool§galerkin_samples: usize§galerkin_rel_tol: f64§on_rank_failure: RankFallback§fsai_dist: usize§fsai_use_strength: bool§fsai_max_per_row: usize§fsai_lambda: f64§fsai_adaptive_passes: usize§fsai_drop_tol: f64§fsai_damping: f64§normalize_strength: bool§coarse_solve: CoarseSolve§ilu_drop_tol: f64§ilu_fill_per_row: usize§max_operator_complexity: Option<f64>§agg_num_levels: usize§aggressive_mis_k: usize§max_strong_per_row: Option<usize>§cycle_type: CycleType§kcycle: Option<KCycle>§fmg_nu_pre: usize§fmg_nu_post: usize§fmg_gamma: usize§fmg_levels_use: Option<usize>§non_galerkin: NonGalerkin§nodal: NodalMode§block_size: usize§num_functions: usize§near_nullspace: Option<NearNullspace>§filter_trial_vectors: Option<Vec<Vec<f64>>>§filter_omega: f64§filter_after_non_galerkin: bool§post_interp: PostInterpType§flexible_level: Option<usize>§flexible_iters: usize§flexible_rtol: f64§flexible_pc_sweeps: usize§mixed_precision: Option<MixedPrecision>§mixed_storage: MixedStorage§conditioning: ConditioningOptions§dist_coarse_strategy: DistCoarseStrategy§dist_coarse_repartition: DistCoarseRepartition§dist_coarse_solver_route: DistCoarseSolverRoute§dist_apply_instrumentation: bool§dist_coarse_ghost_scale: f64§require_native_complex_hierarchy: bool

In complex builds, reject genuinely complex non-diagonal operators until AMG carries complex values through the full hierarchy.

§level_relax_overrides: BTreeMap<usize, RelaxType>§level_sweep_overrides: BTreeMap<usize, (usize, usize)>§level_coarse_overrides: BTreeMap<usize, CoarseSolve>

Implementations§

Trait Implementations§

Source§

impl Clone for AMGConfig

Source§

fn clone(&self) -> AMGConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AMGConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AMGConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src
where Scheme: ApproxScheme,

Source§

type Err = NoError

The error type produced by a failed conversion.
Source§

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.
Source§

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src
where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

Source§

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.
Source§

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, Dst> ConvAsUtil<Dst> for T

Source§

fn approx(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Approximate the subject with the default scheme.
Source§

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject with a specific scheme.
Source§

impl<T> ConvUtil for T

Source§

fn approx_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst>,

Approximate the subject to a given type with the default scheme.
Source§

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
where Self: Sized + ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.
Source§

fn into_as<Dst>(self) -> Dst
where Self: Sized + Into<Dst>,

Convert the subject to a given type.
Source§

fn try_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + TryInto<Dst>,

Attempt to convert the subject to a given type.
Source§

fn value_as<Dst>(self) -> Result<Dst, Self::Err>
where Self: Sized + ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.
Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ShellContext for T
where T: Send + Sync + Any,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<Src> TryFrom<Src> for Src

Source§

type Err = NoError

The error type produced by a failed conversion.
Source§

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<Src, Dst> TryInto<Dst> for Src
where Dst: TryFrom<Src>,

Source§

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.
Source§

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<Src> ValueFrom<Src> for Src

Source§

type Err = NoError

The error type produced by a failed conversion.
Source§

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.
Source§

impl<Src, Dst> ValueInto<Dst> for Src
where Dst: ValueFrom<Src>,

Source§

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.
Source§

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.