OOF2: The Manual

CG (CGSolver)
Prev  6.4.2. Subclasses  Next

Name

CG (CGSolver) — Conjugate Gradient method for solving symmetric matrices.

Synopsis

CGSolver(max_iterations,tolerance,preconditioner)

Details

  • Base class: LinearSolverPtr

  • Parameters:

    max_iterations
    maximum number of iterations to perform Type: Integer.
    tolerance
    largest acceptable relative error Type: A real number.
    preconditioner
    Black magic for making the matrix more easily solvable Type: An object of the Preconditioner class.

Description

The CGSolver solver implements the preconditioned Conjugate Gradient method for solving linear matrix equations. The matrix must be symmetric.

CG is an iterative method, meaning that it creates an approximate solution and improves it on each iteration. The iteration will cease when the relative error of the solution is less than the given tolerance. The solver will stop and report an error if the tolerance isn't satisfied within max_iterations iterations.

The preconditioner parameter specifies which Preconditioner to use, if any. Preconditioners speed the convergence of iterative methods by replacing the original matrix by something closer to the identity matrix.

Prev  Up  Next
Bunge2RGB (Bunge2RGB)  Home  All Elements (CheckAllElements)

/* OOF home */ /* OOF2 home */ /* Send mail to the OOF Team */