org.eclipse.eavp.viz.service.mesh.datastructures

Enum BoundaryConditionType

java.lang.Object

java.lang.Enum<BoundaryConditionType>

org.eclipse.eavp.viz.service.mesh.datastructures.BoundaryConditionType

All Implemented Interfaces:

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

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

This enumeration provides supported boundary conditions. Currently, these are based on Nek5000 boundary conditions. See http://nek5000.mcs.anl.gov/index.php/Boundary_Definition for more details on the boundary conditions.

Author:

Jordan H. Deyton

Enum Constant Summary

Enum Constants

Enum Constant and Description
AxisymmetricBoundary Axisymmetric boundary.
DirichletTemperatureScalar Dirichlet temperature/scalar.
DirichletVelocity Dirichlet velocity.
Flux Flux.
Insulated Insulated (zero flux) for temperature.
Internal Internal (element connectivity).
MovingBoundary Moving boundary.
None No boundary condition specified.
Outflow Outflow.
OutflowNormal Outflow, Normal (need surface to be normal to x, y, or z).
Periodic Periodic.
Symmetry Symmetry.
UserDirichletTemperature User defined Dirichlet temperature.
UserDirichletVelocity User defined Dirichlet temperature.
UserFlux User defined flux.
Wall Wall (no slip).

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	id This attribute stores a human-readable reason for rejecting an invalid value passed to setValue().
int	numberOfParameters Specifies the number of parameters required for the simulation.

Method Summary

Modifier and Type	Method and Description
static BoundaryConditionType	fromId(java.lang.String id) Gets a BoundaryConditionType from a string ID.
static BoundaryConditionType	valueOf(java.lang.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 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

None

public static final BoundaryConditionType None

No boundary condition specified.

Internal

public static final BoundaryConditionType Internal

Internal (element connectivity). Requires 2 parameters: adjacent element and face.

Periodic

public static final BoundaryConditionType Periodic

Periodic. Requires 2 parameters: periodic element and face.

DirichletTemperatureScalar

public static final BoundaryConditionType DirichletTemperatureScalar

Dirichlet temperature/scalar. Requires 1 parameter: value.

DirichletVelocity

public static final BoundaryConditionType DirichletVelocity

Dirichlet velocity. Requires 3 parameters: u, v, and w.

Outflow

public static final BoundaryConditionType Outflow

Outflow. Requires 0 parameters.

Wall

public static final BoundaryConditionType Wall

Wall (no slip). Requires 0 parameters.

Flux

public static final BoundaryConditionType Flux

Flux. Requires 1 parameter: flux.

Symmetry

public static final BoundaryConditionType Symmetry

Symmetry. Requires 0 parameters.

AxisymmetricBoundary

public static final BoundaryConditionType AxisymmetricBoundary

Axisymmetric boundary. Requires 0 parameters.

MovingBoundary

public static final BoundaryConditionType MovingBoundary

Moving boundary. Requires 0 parameters.

Insulated

public static final BoundaryConditionType Insulated

Insulated (zero flux) for temperature.

OutflowNormal

public static final BoundaryConditionType OutflowNormal

Outflow, Normal (need surface to be normal to x, y, or z). Requires 0 parameters.

UserDirichletVelocity

public static final BoundaryConditionType UserDirichletVelocity

User defined Dirichlet temperature. Assigned a value in USERBC.

UserDirichletTemperature

public static final BoundaryConditionType UserDirichletTemperature

User defined Dirichlet temperature. Assigned a value in USERBC.

UserFlux

public static final BoundaryConditionType UserFlux

User defined flux. Assigned a value in USERBC.

Field Detail

id

public java.lang.String id

This attribute stores a human-readable reason for rejecting an invalid value passed to setValue(). It may be retrieved by calling getErrorMessage().

numberOfParameters

public int numberOfParameters

Specifies the number of parameters required for the simulation. This number should vary between 0 and 5, inclusive, since there are only 5 values read in for each boundary condition.

Method Detail

values

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

Returns:

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

valueOf

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

fromId

public static BoundaryConditionType fromId(java.lang.String id)

Gets a BoundaryConditionType from a string ID.

Parameters:

id - The ID of the boundary condition. This is usually a one or two character string.

Returns:

The BoundaryConditionType corresponding to the string ID, or null if the ID is invalid.