jabble
Enum BoundaryCondition

java.lang.Object
  java.lang.Enum<BoundaryCondition>
      jabble.BoundaryCondition

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BoundaryCondition>

public enum BoundaryCondition
extends java.lang.Enum<BoundaryCondition>

A boundary condition, such as periodic, Cauchy, ...

Enum Constant Summary

CAUCHY
Cauchy boundary condition.

CUSTOM
Default boundary condition - the framework will pass the boundary to the Evolver to implement its own boundary condition.

DIRICHLET
Dirichelet boundary condition.

FIXED
The boundary will be left at the same value as the initial condition.

NEUMANN
Neumann boundary condition, solves the equation D[field, x] = 0 at the boundary;.

OUTGOINGWAVE
Outgoing wave boundary condition, solves the equation D[field, t] = D[field, x] at the boundary.

PERIODIC
Periodic boundary: the grid becomes circular, by returning to the beginning when it reaches the end.

RADIATION
Radiation boundary condition.

ROBIN
Robin boundary condition.

Method Summary

static BoundaryCondition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BoundaryCondition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CUSTOM

public static final BoundaryCondition CUSTOM

Default boundary condition - the framework will pass the boundary to the Evolver to implement its own boundary condition.

FIXED

public static final BoundaryCondition FIXED

The boundary will be left at the same value as the initial condition.

DIRICHLET

public static final BoundaryCondition DIRICHLET

Dirichelet boundary condition.

PERIODIC

public static final BoundaryCondition PERIODIC

Periodic boundary: the grid becomes circular, by returning to the beginning when it reaches the end.

OUTGOINGWAVE

public static final BoundaryCondition OUTGOINGWAVE

Outgoing wave boundary condition, solves the equation D[field, t] = D[field, x] at the boundary.

RADIATION

public static final BoundaryCondition RADIATION

Radiation boundary condition.

NEUMANN

public static final BoundaryCondition NEUMANN

Neumann boundary condition, solves the equation D[field, x] = 0 at the boundary;.

CAUCHY

public static final BoundaryCondition CAUCHY

Cauchy boundary condition.

ROBIN

public static final BoundaryCondition ROBIN

Robin boundary condition.

Method Detail

values

public static BoundaryCondition[] 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 (BoundaryCondition c : BoundaryCondition.values())
    System.out.println(c);

Returns:

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

valueOf

public static BoundaryCondition 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