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

Class EdgeProperties

java.lang.Object

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

public class EdgeProperties
extends java.lang.Object

This class contains properties of an edge. These properties can be maintained by either a Polygon or the Edge itself. All properties are private fields but can be accessed via getters and setters.

Currently, the properties only contain the boundary conditions of edges (faces). The intent is to let the Polygon (element) manage these properties since in Nek the elements have boundary conditions for all their faces. Shared faces can have two fluid, thermal, or nth passive scalar boundary conditions.

Author:

Jordan H. Deyton

Constructor Summary

Constructors

Constructor and Description
EdgeProperties() The default constructor for properties of an Edge.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() This operation returns a clone of the EdgeProperties using a deep copy.
void	copy(EdgeProperties properties) This operation copies the contents of a EdgeProperties into the current object using a deep copy.
boolean	equals(java.lang.Object otherObject) This operation is used to check equality between this EdgeProperties and another.
BoundaryCondition	getFluidBoundaryCondition() Gets the fluid boundary condition for the edge.
BoundaryCondition	getOtherBoundaryCondition(int otherId) Gets a passive scalar boundary condition from the edge.
java.util.ArrayList<BoundaryCondition>	getOtherBoundaryConditions() Gets all passive scalar boundary conditions for the edge.
BoundaryCondition	getThermalBoundaryCondition() Gets the thermal boundary condition for the edge.
int	hashCode() This operation returns the hash value of the EdgeProperties.
boolean	setFluidBoundaryCondition(BoundaryCondition condition) Sets the fluid boundary condition for the edge.
boolean	setOtherBoundaryCondition(int otherId, BoundaryCondition condition) Sets a passive scalar boundary condition for the edge.
boolean	setThermalBoundaryCondition(BoundaryCondition condition) Sets the thermal boundary condition for the edge.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EdgeProperties

public EdgeProperties()

The default constructor for properties of an Edge. This initializes every property it can to non-null values.

Method Detail

setFluidBoundaryCondition

public boolean setFluidBoundaryCondition(BoundaryCondition condition)

Sets the fluid boundary condition for the edge.

Parameters:

condition - The new BoundaryCondition.

Returns:

True if the new condition was successfully set, false otherwise.

getFluidBoundaryCondition

public BoundaryCondition getFluidBoundaryCondition()

Gets the fluid boundary condition for the edge.

Returns:

The edge's BoundaryCondition. This should never be null.

setThermalBoundaryCondition

public boolean setThermalBoundaryCondition(BoundaryCondition condition)

Sets the thermal boundary condition for the edge.

Parameters:

condition - The new BoundaryCondition.

Returns:

True if the new condition was successfully set, false otherwise.

getThermalBoundaryCondition

public BoundaryCondition getThermalBoundaryCondition()

Gets the thermal boundary condition for the edge.

Returns:

The edge's BoundaryCondition. This should never be null.

setOtherBoundaryCondition

public boolean setOtherBoundaryCondition(int otherId,
                                         BoundaryCondition condition)

Sets a passive scalar boundary condition for the edge.

Parameters:

otherId - The ID or index of the set of passive scalar boundary conditions.

condition - The new BoundaryCondition.

Returns:

True if the new condition was successfully set, false otherwise.

getOtherBoundaryCondition

public BoundaryCondition getOtherBoundaryCondition(int otherId)

Gets a passive scalar boundary condition from the edge.

Parameters:

otherId - The ID or index of the set of passive scalar boundary conditions.

Returns:

The edge's BoundaryCondition, or null if the passive scalar index is invalid.

getOtherBoundaryConditions

public java.util.ArrayList<BoundaryCondition> getOtherBoundaryConditions()

Gets all passive scalar boundary conditions for the edge.

Returns:

An ArrayList of all passive scalar boundary conditions for the edge. If no passive scalar boundary conditions exist, this will be an empty list.

hashCode

public int hashCode()

This operation returns the hash value of the EdgeProperties.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash of the Object.

equals

public boolean equals(java.lang.Object otherObject)

This operation is used to check equality between this EdgeProperties and another. It returns true if they are equal and false if they are not.

Overrides:

equals in class java.lang.Object

Parameters:

otherObject - The other Object that should be compared with this one.

Returns:

True if the Objects are equal, false otherwise.

copy

public void copy(EdgeProperties properties)

This operation copies the contents of a EdgeProperties into the current object using a deep copy.

Parameters:

properties - The Object from which the values should be copied.

clone

public java.lang.Object clone()

This operation returns a clone of the EdgeProperties using a deep copy.

Overrides:

clone in class java.lang.Object

Returns:

The new clone.