Preconditioner

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## no.uib.cipr.matrix.sparse
Interface Preconditioner

All Known Implementing Classes:
  AMG, BlockDiagonalPreconditioner, DiagonalPreconditioner, ICC, ILU, ILUT, SSOR, TwoLevelPreconditioner

    public interface Preconditioner

Preconditioner interface. Before a preconditioner is used, `setMatrix` must be called

Method Summary
`Vector` | `apply(Vector b, Vector x)` Solves the approximate problem with the given right hand side.
`void` | `setMatrix(Matrix A)` Sets the operator matrix for the preconditioner.
`Vector` | `transApply(Vector b, Vector x)` Solves the approximate transpose problem with the given right hand side.

Method Detail

### apply

    Vector apply(Vector b,
                 Vector x)

  Solves the approximate problem with the given right hand side. Result is stored in given solution vector

  Parameters:
    `b` - Right hand side of problem
    `x` - Result is stored here
  Returns:
    x

### transApply

    Vector transApply(Vector b,
                      Vector x)

  Solves the approximate transpose problem with the given right hand side. Result is stored in given solution vector

  Parameters:
    `b` - Right hand side of problem
    `x` - Result is stored here
  Returns:
    x

### setMatrix

    void setMatrix(Matrix A)

  Sets the operator matrix for the preconditioner. This method must be called before a preconditioner is used by an iterative solver

  Parameters:
    `A` - Matrix to setup the preconditioner for. Not modified

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD