Package etomica.math.geometry

Class Cuboid

java.lang.Object

etomica.math.geometry.Polytope

etomica.math.geometry.Polyhedron

etomica.math.geometry.Hexahedron

etomica.math.geometry.Cuboid

All Implemented Interfaces:

Rectangular, Shape

public class Cuboid
extends Hexahedron
implements Rectangular

A polyhedron composed of three pairs of rectangular faces placed opposite each other and joined at right angles, also known as a rectangular parallelepiped.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.math.geometry.Polyhedron

edges, faces

Fields inherited from class etomica.math.geometry.Polytope

D, embeddedSpace, hyperPlanes, position, vertices

Constructor Summary

Constructors

Constructor	Description
Cuboid(Space embeddedSpace)	Constructs a cuboid with equal faces of unit size (a cube).
Cuboid(Space embeddedSpace, double a, double b, double c)	Constructs a cuboid with edges of lengths having the given values.

Method Summary

Modifier and Type	Method	Description
boolean	contains(Vector v)	Returns true if the given vector lies inside (or on the surface of) this cell, false otherwise.
Vector	getEdgeLengths()	Returns a vector with elements equal to the edge lengths of the cuboid.
double	getPerimeter()	Returns the sum of the length of the edges of the polyhedron
double	getSurfaceArea()	Returns the sum the area of the faces of the polyhedron
double	getVolume()	Returns the (hyper)volume enclosed by the polytope.
void	setEdgeLengths(double a, double b, double c)	Sets the lengths of all edges of the cuboid.
void	setEdgeLengths(Vector e)	Sets the three edge lengths of the cuboid, taking each element of the given vector for the length of the corresponding cuboid edge.
void	updateVertices()	This method should be defined by the subclass to calculate the vertices in accordance with the internal representation of the polytope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class etomica.math.geometry.Polyhedron

distanceTo, getEdges, getFaces

Methods inherited from class etomica.math.geometry.Polytope

applyTranslationRotation, D, getEmbeddedSpace, getPosition, getVertexCount, getVertices, setPosition, toString

Constructor Detail

Cuboid

public Cuboid(Space embeddedSpace)

Constructs a cuboid with equal faces of unit size (a cube).

Cuboid

public Cuboid(Space embeddedSpace,
              double a,
              double b,
              double c)

Constructs a cuboid with edges of lengths having the given values.

Method Detail

getVolume

public double getVolume()

Description copied from class: Polytope

Returns the (hyper)volume enclosed by the polytope. So for a LineSegment instance, this is its length; for a polygon, it is the area; for a polyhedron, it is the volume.

Specified by:

getVolume in interface Shape

Specified by:

getVolume in class Polytope

getSurfaceArea

public double getSurfaceArea()

Description copied from class: Polyhedron

Returns the sum the area of the faces of the polyhedron

Overrides:

getSurfaceArea in class Polyhedron

getPerimeter

public double getPerimeter()

Description copied from class: Polyhedron

Returns the sum of the length of the edges of the polyhedron

Overrides:

getPerimeter in class Polyhedron

updateVertices

public void updateVertices()

Description copied from class: Polytope

This method should be defined by the subclass to calculate the vertices in accordance with the internal representation of the polytope. If the internal representation is kept by the vertices themselves, then this method need do nothing; if this method applies another internal representation to the vertices (for example, it might represent a square by keeping the edge length), it should then invoke applyTranslationRotation() before returning. Subclass methods allowing mutation of the internal representation should invoke updateVertices to ensure the vertices reflect the internal state. Vertices may be changed directly, but these changes will overridden by updateVertices if it is called afterwards.

Specified by:

updateVertices in class Polytope

contains

public boolean contains(Vector v)

Returns true if the given vector lies inside (or on the surface of) this cell, false otherwise.

Specified by:

contains in interface Shape

Specified by:

contains in class Polytope

setEdgeLengths

public void setEdgeLengths(Vector e)

Sets the three edge lengths of the cuboid, taking each element of the given vector for the length of the corresponding cuboid edge.

Specified by:

setEdgeLengths in interface Rectangular

getEdgeLengths

public Vector getEdgeLengths()

Returns a vector with elements equal to the edge lengths of the cuboid. The returned vector is not used to represent the cuboid internally, so changing its values will not affect the state of the cuboid.

Specified by:

getEdgeLengths in interface Rectangular

Returns:

the D edge lengths as the elements of the vector.

setEdgeLengths

public void setEdgeLengths(double a,
                           double b,
                           double c)

Sets the lengths of all edges of the cuboid.