Module simpa.acc

Package simpa.acc.api

Enum Class SolverPreset

java.lang.Object

java.lang.Enum<SolverPreset>

simpa.acc.api.SolverPreset

All Implemented Interfaces:

Serializable, Comparable<SolverPreset>, Constable

public enum SolverPreset
extends Enum<SolverPreset>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCKJACOBI	Using block-Jacobi preconditioner, the blocks are solved first with a dense direct solver
DIRECT	Direct solver with no preconditioner
JACOBI	Using Jacobi preconditioner, simple but not recomended, does not converge well for large systems
SLICE	Using a special 'slice'preconditioner, the slices are solved independently first by a dense solver.

Method Summary

Modifier and Type	Method	Description
SolverOptions.Preconditioner	preconditioner()
SolverOptions.SolverType	solverType()
static SolverPreset	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SolverPreset[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DIRECT

public static final SolverPreset DIRECT

Direct solver with no preconditioner

JACOBI

public static final SolverPreset JACOBI

Using Jacobi preconditioner, simple but not recomended, does not converge well for large systems

BLOCKJACOBI

public static final SolverPreset BLOCKJACOBI

Using block-Jacobi preconditioner, the blocks are solved first with a dense direct solver

SLICE

public static final SolverPreset SLICE

Using a special 'slice'preconditioner, the slices are solved independently first by a dense solver. Designed for tube like geometries

Method Details

values

public static SolverPreset[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SolverPreset valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

solverType

public SolverOptions.SolverType solverType()

preconditioner

public SolverOptions.Preconditioner preconditioner()