Enum BoundaryConditionType

java.lang.Object

java.lang.Enum<BoundaryConditionType>

net.finmath.finitedifference.boundaries.BoundaryConditionType

All Implemented Interfaces:

Serializable, Comparable<BoundaryConditionType>, java.lang.constant.Constable

public enum BoundaryConditionType
extends Enum<BoundaryConditionType>

Type of boundary condition used by finite-difference solvers.

Minimal initial set:

• DIRICHLET: overwrite the corresponding PDE row with a fixed value,
• NONE: do not enforce a boundary row; leave the PDE operator intact.

Additional types such as NEUMANN or ROBIN may be added later.

Author:

Alessandro Gnoatto

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIRICHLET	The dirichlet.
NONE	The none.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DIRICHLET

public static final BoundaryConditionType DIRICHLET

The dirichlet.

NONE

public static final BoundaryConditionType NONE

The none.

Method Details

values

public static BoundaryConditionType[] values()

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

Returns:

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

valueOf

public static BoundaryConditionType valueOf(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:

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

NullPointerException - if the argument is null