Package uk.ac.rdg.resc.edal.grid

Class HorizontalMesh

java.lang.Object

uk.ac.rdg.resc.edal.grid.HorizontalMesh

All Implemented Interfaces:

Serializable, DiscreteDomain<HorizontalPosition,HorizontalCell>, DiscreteHorizontalDomain<HorizontalCell>, Domain<HorizontalPosition>, HorizontalDomain

public class HorizontalMesh
extends Object
implements DiscreteHorizontalDomain<HorizontalCell>, Serializable

An unstructured mesh in the horizontal plane.

Author:

Guy Griffiths

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	contains(HorizontalPosition position)
boolean	equals(Object obj)
int	findIndexOf(HorizontalPosition position)	Finds the index of the closest mesh vertex to the supplied position
static HorizontalMesh	fromBounds(List<HorizontalPosition> positions, List<Polygon> boundaries)
static HorizontalMesh	fromConnections(List<HorizontalPosition> positions, List<int[]> connections, int connectionsStartFrom)	Create a new HorizontalMesh
BoundingBox	getBoundingBox()	Returns the bounding box of the domain in the domain's own coordinate reference system.
org.opengis.referencing.crs.CoordinateReferenceSystem	getCoordinateReferenceSystem()	Returns the co-ordinate reference system of this domain
Array<HorizontalCell>	getDomainObjects()	Returns an Array of domain objects that comprise this domain.
org.opengis.metadata.extent.GeographicBoundingBox	getGeographicBoundingBox()	Returns the bounding box of the domain in WGS84 latitude-longitude coordinates.
int	hashCode()
long	size()	Returns the size of this domain

Methods inherited from class java.lang.Object

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

Method Detail

fromConnections

public static HorizontalMesh fromConnections(List<HorizontalPosition> positions,
                                             List<int[]> connections,
                                             int connectionsStartFrom)

Create a new HorizontalMesh

Parameters:

positions - A List of HorizontalPositions which make up the vertices of this mesh

connections - A List of arrays of ints which define the connections between the vertices. Each element of the list should consist of at least 3 integers - these are the indices of the points in the HorizontalPosition List which make up each cell of the grid.

connectionsStartFrom - In the list of connections, what number refers to the first vertex in the positions list? This is almost always either 0 or 1

fromBounds

public static HorizontalMesh fromBounds(List<HorizontalPosition> positions,
                                        List<Polygon> boundaries)

getDomainObjects

public Array<HorizontalCell> getDomainObjects()

Description copied from interface: DiscreteDomain

Returns an Array of domain objects that comprise this domain.

Specified by:

getDomainObjects in interface DiscreteDomain<HorizontalPosition,HorizontalCell>

contains

public boolean contains(HorizontalPosition position)

Specified by:

contains in interface Domain<HorizontalPosition>

Returns:

true if the given position is contained within this domain.

getBoundingBox

public BoundingBox getBoundingBox()

Description copied from interface: HorizontalDomain

Returns the bounding box of the domain in the domain's own coordinate reference system. For domains which do not have a native co-ordinate reference system this may return a BoundingBox in a different CRS. Consequently this BoundingBox is not guaranteed to be a tight bound around the domain.

Specified by:

getBoundingBox in interface HorizontalDomain

getGeographicBoundingBox

public org.opengis.metadata.extent.GeographicBoundingBox getGeographicBoundingBox()

Description copied from interface: HorizontalDomain

Returns the bounding box of the domain in WGS84 latitude-longitude coordinates.

Specified by:

getGeographicBoundingBox in interface HorizontalDomain

getCoordinateReferenceSystem

public org.opengis.referencing.crs.CoordinateReferenceSystem getCoordinateReferenceSystem()

Description copied from interface: HorizontalDomain

Returns the co-ordinate reference system of this domain

Specified by:

getCoordinateReferenceSystem in interface HorizontalDomain

size

public long size()

Description copied from interface: DiscreteHorizontalDomain

Returns the size of this domain

Specified by:

size in interface DiscreteHorizontalDomain<HorizontalCell>

findIndexOf

public int findIndexOf(HorizontalPosition position)

Finds the index of the closest mesh vertex to the supplied position

Parameters:

position - The HorizontalPosition to test

Returns:

The index in the original position list, or -1 if the supplied position is outside the boundary of this HorizontalMesh

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object