Skip to main content

PcConfig

kryst::context::pc_context

Enum PcConfig 

Source 
pub enum PcConfig {

Show 22 variants    None,
    Jacobi,
    BlockJacobi {
        block: usize,
    },
    Ilu0 {
        conditioning: ConditioningOptions,
    },
    Iluk {
        level: usize,
        conditioning: ConditioningOptions,
    },
    Ilut {
        drop_tol: R,
        max_fill: usize,
        reordering: Option<String>,
        conditioning: ConditioningOptions,
    },
    Ilutp {
        drop_tol: R,
        max_fill: usize,
        perm_tol: R,
        reordering: Option<String>,
        conditioning: ConditioningOptions,
    },
    Milu0 {
        conditioning: ConditioningOptions,
    },
    Sor {
        omega: R,
        sweeps: usize,
        mat_side: MatSorType,
    },
    Chebyshev {
        degree: usize,
        eig_lo: R,
        eig_hi: R,
    },
    Asm {
        overlap: usize,
        subdomain_hint: Option<usize>,
        block_solver: Option<String>,
        mode: Option<String>,
        weighting: Option<String>,
        inner_pc: AsmInnerPc,
    },
    Amg {
        config: AMGConfig,
        conditioning: ConditioningOptions,
    },
    ApproxInv {
        kind: ApproxInvKind,
        levels: usize,
        max_per_col: usize,
        drop_tol: R,
        reg: R,
        max_cond: R,
        parallel: bool,
    },
    FieldSplit {
        block_sizes: Vec<usize>,
        child_pc_type: Option<String>,
        options: PcOptions,
    },
    Shell {
        name: Option<String>,
        apply_transpose: Option<String>,
        apply_conjugate_transpose: Option<String>,
        apply_symmetric: Option<String>,
        apply_symmetric_left: Option<String>,
        apply_symmetric_right: Option<String>,
        setup: Option<String>,
        destroy: Option<String>,
        context: Option<String>,
    },
    Ksp {
        ksp_options: KspOptions,
        pc_options: PcOptions,
    },
    Mg {
        levels: usize,
        cycle_type: Option<String>,
        smoother: Option<String>,
        smoother_steps: Option<usize>,
        coarsen_type: Option<String>,
        interpolation_type: Option<String>,
        restriction_type: Option<String>,
        coarse_pc_type: Option<String>,
        coarse_ksp_type: Option<String>,
        coarse_ksp_maxits: Option<usize>,
        coarse_ksp_rtol: Option<R>,
        level_policies: Vec<MgLevelPolicy>,
    },
    Bddc {
        coarse_ksp_type: Option<String>,
        coarse_pc_type: Option<String>,
        use_vertices: bool,
        constraint_selection: BddcConstraintSelection,
        scaling: BddcScaling,
    },
    Gamg {
        config: GamgConfig,
        conditioning: ConditioningOptions,
    },
    Lu,
    Qr,
    SuperLuDist,

}
Expand description

Typed configuration parsed from options.

Variants§

§

None

§

Jacobi

§

BlockJacobi

Fields

§block: usize
§

Ilu0

Fields

§conditioning: ConditioningOptions
§

Iluk

Fields

§level: usize
§conditioning: ConditioningOptions
§

Ilut

Fields

§drop_tol: R
§max_fill: usize
§reordering: Option<String>
§conditioning: ConditioningOptions
§

Ilutp

Fields

§drop_tol: R
§max_fill: usize
§perm_tol: R
§reordering: Option<String>
§conditioning: ConditioningOptions
§

Milu0

Fields

§conditioning: ConditioningOptions
§

Sor

Fields

§omega: R
§sweeps: usize
§mat_side: MatSorType
§

Chebyshev

Fields

§degree: usize
§eig_lo: R
§eig_hi: R
§

Asm

Fields

§overlap: usize
§subdomain_hint: Option<usize>
§block_solver: Option<String>
§mode: Option<String>
§weighting: Option<String>
§inner_pc: AsmInnerPc
§

Amg

Fields

§config: AMGConfig
§conditioning: ConditioningOptions
§

ApproxInv

Fields

§kind: ApproxInvKind
§levels: usize
§max_per_col: usize
§drop_tol: R
§reg: R
§max_cond: R
§parallel: bool
§

FieldSplit

Fields

§block_sizes: Vec<usize>
§child_pc_type: Option<String>
§options: PcOptions
§

Shell

Fields

§name: Option<String>
§apply_transpose: Option<String>
§apply_conjugate_transpose: Option<String>
§apply_symmetric: Option<String>
§apply_symmetric_left: Option<String>
§apply_symmetric_right: Option<String>
§setup: Option<String>
§destroy: Option<String>
§context: Option<String>
§

Ksp

Fields

§ksp_options: KspOptions
§pc_options: PcOptions
§

Mg

Fields

§levels: usize
§cycle_type: Option<String>
§smoother: Option<String>
§smoother_steps: Option<usize>
§coarsen_type: Option<String>
§interpolation_type: Option<String>
§restriction_type: Option<String>
§coarse_pc_type: Option<String>
§coarse_ksp_type: Option<String>
§coarse_ksp_maxits: Option<usize>
§coarse_ksp_rtol: Option<R>
§level_policies: Vec<MgLevelPolicy>
§

Bddc

Fields

§coarse_ksp_type: Option<String>
§coarse_pc_type: Option<String>
§use_vertices: bool
§constraint_selection: BddcConstraintSelection
§scaling: BddcScaling
§

Gamg

Fields

§config: GamgConfig
§conditioning: ConditioningOptions
§

Lu

§

Qr

§

SuperLuDist

Available on crate feature superlu_dist only.

Implementations§

Trait Implementations§

Source§

impl Clone for PcConfig

Source§

fn clone(&self) -> PcConfig

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 PcConfig

Source§

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

Formats the value using the given formatter. 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.