Class StandardBoundaryCondition

java.lang.Object

net.finmath.finitedifference.boundaries.StandardBoundaryCondition

All Implemented Interfaces:

BoundaryCondition

public final class StandardBoundaryCondition
extends Object
implements BoundaryCondition

Standard immutable implementation of BoundaryCondition.

Author:

Alessandro Gnoatto

Method Summary

Modifier and Type	Method	Description
static StandardBoundaryCondition	dirichlet(double value)	Creates a Dirichlet boundary condition.
BoundaryConditionType	getType()	Returns the type of boundary condition.
double	getValue()	Returns the boundary value.
static StandardBoundaryCondition	none()	Creates a boundary condition representing "do not overwrite the PDE row".

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BoundaryCondition

isDirichlet, isNone

Method Details

dirichlet

public static StandardBoundaryCondition dirichlet(double value)

Creates a Dirichlet boundary condition.

Parameters:

value - The prescribed boundary value.

Returns:

A Dirichlet boundary condition.

none

public static StandardBoundaryCondition none()

Creates a boundary condition representing "do not overwrite the PDE row".

Returns:

A NONE boundary condition.

getType

public BoundaryConditionType getType()

Description copied from interface: BoundaryCondition

Returns the type of boundary condition.

Specified by:

getType in interface BoundaryCondition

Returns:

The boundary condition type.

getValue

public double getValue()

Description copied from interface: BoundaryCondition

Returns the boundary value.

This is used only when the type is BoundaryConditionType.DIRICHLET.

Specified by:

getValue in interface BoundaryCondition

Returns:

The boundary value.