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

Class NekPolygon

java.lang.Object

org.eclipse.eavp.viz.modeling.base.BasicMesh

org.eclipse.eavp.viz.modeling.Face

org.eclipse.eavp.viz.modeling.DetailedFace

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

All Implemented Interfaces:

IManagedUpdateable, IManagedUpdateableListener, IVizUpdateableListener, IMesh

public class NekPolygon
extends DetailedFace
implements IVizUpdateableListener

The internal representation for a face with a traversable list of vertices and edges which also maintains information needed for Nek5000.

Author:

Robert Smith

Field Summary

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateableListener

component

Constructor Summary

Constructors

Constructor and Description
NekPolygon() The default constructor
NekPolygon(java.util.List<IController> entities) A constructor for specifying the child entities.

Method Summary

Modifier and Type	Method and Description
void	addEntityToCategory(IController entity, IMeshCategory category) An implementation of addEntity that adds both the Edge and its Vertices.
java.lang.Object	clone()
void	copy(IMesh otherObject) Deep copies the contents of another AbstractMeshComponent into this one.
boolean	equals(java.lang.Object otherObject)
java.util.HashMap<java.lang.Integer,EdgeProperties>	getEdgeProperties() Getter method for the map of edge properties.
BoundaryCondition	getFluidBoundaryCondition(int edgeId) Gets the fluid boundary condition for an edge of the polygon.
BoundaryCondition	getOtherBoundaryCondition(int edgeId, int otherId) Gets a passive scalar boundary condition for an edge of the polygon.
PolygonProperties	getPolygonProperties() Returns the properties for the current polygon.
BoundaryCondition	getThermalBoundaryCondition(int edgeId) Gets the thermal boundary condition for an edge of the polygon.
void	initializeBoundaryConditions(IController edge) Create a set of edge properties for the given edge and place them in the properties, keyed by that edge's id.
void	setController(IController controller) Setter method for the controller.
void	setEdgeProperties(java.util.HashMap<java.lang.Integer,EdgeProperties> edgeProperties) Setter method for the map of edge properties.
void	setFluidBoundaryCondition(int edgeId, BoundaryCondition condition) Sets a fluid boundary condition for an edge of the polygon.
void	setOtherBoundaryCondition(int edgeId, int otherId, BoundaryCondition condition) Sets a passive scalar boundary condition for an edge of the polygon.
void	setPolygonProperties(java.lang.String materialId, int group) Sets the properties for the current polygon.
void	setThermalBoundaryCondition(int edgeId, BoundaryCondition condition) Sets a thermal boundary condition for an edge of the polygon.
void	update(IManagedUpdateable component, SubscriptionType[] type) Receive an update, including the source component and type of event that triggered the update.
void	update(IVizUpdateable component) This operation notifies the listener that an update has occurred in the Component.

Methods inherited from class org.eclipse.eavp.viz.modeling.DetailedFace

removeEntity

Methods inherited from class org.eclipse.eavp.viz.modeling.base.BasicMesh

addEntity, getAllEntities, getController, getEntities, getEntitiesFromCategory, getEntitiesFromCategory, getEntityCategories, getProperties, getProperty, getPropertyMap, getRotation, getScale, getSize, getSkew, getSubscriptions, getTransformation, getTranslation, getType, hashCode, register, setEntities, setProperties, setProperty, setTransformation, setType, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

NekPolygon

public NekPolygon()

The default constructor

NekPolygon

public NekPolygon(java.util.List<IController> entities)

A constructor for specifying the child entities.

Parameters:

entities - The child entities comprising the face

Method Detail

initializeBoundaryConditions

public void initializeBoundaryConditions(IController edge)

Create a set of edge properties for the given edge and place them in the properties, keyed by that edge's id.

Parameters:

edge - The edge for which boundary conditions are being created

getEdgeProperties

public java.util.HashMap<java.lang.Integer,EdgeProperties> getEdgeProperties()

Getter method for the map of edge properties.

Returns:

A map from edge ID numbers to that edge's edge properties.

getFluidBoundaryCondition

public BoundaryCondition getFluidBoundaryCondition(int edgeId)

Gets the fluid boundary condition for an edge of the polygon.

Parameters:

edgeId - The ID of the edge that has a BoundaryCondition.

Returns:

The edge's BoundaryCondition for this polygon, or null if the edge ID is invalid.

getOtherBoundaryCondition

public BoundaryCondition getOtherBoundaryCondition(int edgeId,
                                                   int otherId)

Gets a passive scalar boundary condition for an edge of the polygon.

Parameters:

edgeId - The ID of the edge that has a BoundaryCondition.

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

Returns:

The edge's BoundaryCondition for this polygon, or null if the edge ID is invalid.

getPolygonProperties

public PolygonProperties getPolygonProperties()

Returns the properties for the current polygon.

Returns:

The properties for the current polygon.

getThermalBoundaryCondition

public BoundaryCondition getThermalBoundaryCondition(int edgeId)

Gets the thermal boundary condition for an edge of the polygon.

Parameters:

edgeId - The ID of the edge that has a BoundaryCondition.

Returns:

The edge's BoundaryCondition for this polygon, or null if the edge ID is invalid.

setEdgeProperties

public void setEdgeProperties(java.util.HashMap<java.lang.Integer,EdgeProperties> edgeProperties)

Setter method for the map of edge properties.

Parameters:

edgeProperties - A map from edge ID numbers to that edge's edge properties.

setFluidBoundaryCondition

public void setFluidBoundaryCondition(int edgeId,
                                      BoundaryCondition condition)

Sets a fluid boundary condition for an edge of the polygon.

Parameters:

edgeId - The ID of the edge that will have the new BoundaryCondition.

condition - The new BoundaryCondition.

setOtherBoundaryCondition

public void setOtherBoundaryCondition(int edgeId,
                                      int otherId,
                                      BoundaryCondition condition)

Sets a passive scalar boundary condition for an edge of the polygon.

Parameters:

edgeId - The ID of the edge that will have the new BoundaryCondition.

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

condition - The new BoundaryCondition.

setPolygonProperties

public void setPolygonProperties(java.lang.String materialId,
                                 int group)

Sets the properties for the current polygon.

Parameters:

materialId - The material ID of the current polygon.

group - The group number of the current polygon.

setThermalBoundaryCondition

public void setThermalBoundaryCondition(int edgeId,
                                        BoundaryCondition condition)

Sets a thermal boundary condition for an edge of the polygon.

Parameters:

edgeId - The ID of the edge that will have the new BoundaryCondition.

condition - The new BoundaryCondition.

addEntityToCategory

public void addEntityToCategory(IController entity,
                                IMeshCategory category)

Description copied from class: DetailedFace

An implementation of addEntity that adds both the Edge and its Vertices.

Specified by:

addEntityToCategory in interface IMesh

Overrides:

addEntityToCategory in class DetailedFace

Parameters:

entity - The new child entity to be added

category - The new entity's category

setController

public void setController(IController controller)

Description copied from interface: IMesh

Setter method for the controller.

Specified by:

setController in interface IMesh

Overrides:

setController in class BasicMesh

Parameters:

controller - The IController which manages this component

update

public void update(IManagedUpdateable component,
                   SubscriptionType[] type)

Description copied from interface: IManagedUpdateableListener

Receive an update, including the source component and type of event that triggered the update.

Specified by:

update in interface IManagedUpdateableListener

Overrides:

update in class BasicMesh

Parameters:

component - The updateable component the update is coming from

type - The event type that of the update

clone

public java.lang.Object clone()

Overrides:

clone in class DetailedFace

copy

public void copy(IMesh otherObject)

Description copied from interface: IMesh

Deep copies the contents of another AbstractMeshComponent into this one. This does not copy the reference to any parent IController, as an IController should have exactly one AbstractMesh as a model.

Specified by:

copy in interface IMesh

Overrides:

copy in class DetailedFace

Parameters:

otherObject - The object which will be copied into this.

equals

public boolean equals(java.lang.Object otherObject)

Overrides:

equals in class BasicMesh

update

public void update(IVizUpdateable component)

Description copied from interface: IVizUpdateableListener

This operation notifies the listener that an update has occurred in the Component.

Specified by:

update in interface IVizUpdateableListener

Parameters:

component - The component that was updated in some way.