maspack.solvers

Enum DirectSolver.IterativeMethod

java.lang.Object

java.lang.Enum<DirectSolver.IterativeMethod>

maspack.solvers.DirectSolver.IterativeMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DirectSolver.IterativeMethod>

Enclosing interface:

DirectSolver

public static enum DirectSolver.IterativeMethod
extends java.lang.Enum<DirectSolver.IterativeMethod>

Describes the methods available for DirectSolver.iterativeSolve(double[], double[], double[]), each of which uses the most recent factorization as a preconditioner.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CGS Sonneveld's Conjugate Gradients Squared, with right preconditioning.
GMRES Restarted GMRES with right preconditioning.

Method Summary

Modifier and Type	Method and Description
static DirectSolver.IterativeMethod	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DirectSolver.IterativeMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GMRES

public static final DirectSolver.IterativeMethod GMRES

Restarted GMRES with right preconditioning. Uses one preconditioner solve per iteration and minimizes the residual. This is the default.

CGS

public static final DirectSolver.IterativeMethod CGS

Sonneveld's Conjugate Gradients Squared, with right preconditioning. Uses two preconditioner solves per iteration.

Method Detail

values

public static DirectSolver.IterativeMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DirectSolver.IterativeMethod c : DirectSolver.IterativeMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DirectSolver.IterativeMethod valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null