AMGPreconditioner

Struct AMGPreconditioner 

Source
pub struct AMGPreconditioner<T>
where T: Float + Debug + Copy + 'static,
{ /* private fields */ }
Expand description

AMG preconditioner implementation

Implementations§

Source§

impl<T> AMGPreconditioner<T>
where T: Float + Debug + Copy + 'static,

Source

pub fn new(matrix: &CsrArray<T>, options: AMGOptions) -> SparseResult<Self>

Create a new AMG preconditioner from a sparse matrix

§Arguments
  • matrix - The coefficient matrix
  • options - AMG options
§Returns

A new AMG preconditioner

§Example
use scirs2_sparse::csr_array::CsrArray;
use scirs2_sparse::linalg::{AMGPreconditioner, AMGOptions};

// Create a simple matrix
let rows = vec![0, 0, 1, 1, 2, 2];
let cols = vec![0, 1, 0, 1, 1, 2];
let data = vec![2.0, -1.0, -1.0, 2.0, -1.0, 2.0];
let matrix = CsrArray::from_triplets(&rows, &cols, &data, (3, 3), false).unwrap();

// Create AMG preconditioner
let amg = AMGPreconditioner::new(&matrix, AMGOptions::default()).unwrap();
Source

pub fn apply(&self, b: &ArrayView1<'_, T>) -> SparseResult<Array1<T>>

Apply the AMG preconditioner

Solves the system M * x = b approximately, where M is the preconditioner

§Arguments
  • b - Right-hand side vector
§Returns

Approximate solution x

Source

pub fn num_levels(&self) -> usize

Get the number of levels in the hierarchy

Source

pub fn level_size(&self, level: usize) -> Option<(usize, usize)>

Get the size of the matrix at a given level

Trait Implementations§

Source§

impl<T> Debug for AMGPreconditioner<T>
where T: Float + Debug + Copy + 'static + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for AMGPreconditioner<T>

§

impl<T> RefUnwindSafe for AMGPreconditioner<T>
where T: RefUnwindSafe,

§

impl<T> Send for AMGPreconditioner<T>
where T: Send,

§

impl<T> Sync for AMGPreconditioner<T>
where T: Sync,

§

impl<T> Unpin for AMGPreconditioner<T>

§

impl<T> UnwindSafe for AMGPreconditioner<T>
where T: RefUnwindSafe,

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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<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