Package etomica.space

Class BoundaryRectangular

java.lang.Object

etomica.space.Boundary

etomica.space.BoundaryRectangular

Direct Known Subclasses:

BoundaryRectangularNonperiodic, BoundaryRectangularPeriodic, BoundaryRectangularPore, BoundaryRectangularSlit

public abstract class BoundaryRectangular
extends Boundary

Boundary that is in the shape of a rectangular parallelepiped. Periodicity in each direction is specified by subclass.

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector	dimensions
protected Vector[]	edgeVectors
protected float[][]	shift0

Fields inherited from class etomica.space.Boundary

box, eventManager, inflateEvent, shape, space

Constructor Summary

Constructors

Constructor	Description
BoundaryRectangular(Space _space)	Constructs cubic boundary of the given periodicity, using the space and default box-size given by the Simulation.
BoundaryRectangular(Space space, double boxSize)	Constructs cubic boundary of the given periodicity with each edge of length boxSize
BoundaryRectangular(Space space, double[] boxSize)	Constructs rectangular boundary of the given periodicity with edges given by the values in the array boxSize.

Method Summary

Modifier and Type	Method	Description
Vector	getBoxSize()	Returns a vector with elements equal to the lengths of the edges of the boundary.
Vector	getEdgeVector(int d)	Returns the vector that defines the edge of this boundary for the given dimension.
double[][]	imageOrigins(int nShells)	Returns a set of image origins for a set of periodic image shells.
void	setBoxSize(Vector v)	Sets the size and shape of the rectangular boundary.
protected void	updateDimensions()
double	volume()	Returns the "volume" of the rectangular region defined by this Boundary.

Methods inherited from class etomica.space.Boundary

centralImage, getBox, getCenter, getEventManager, getIndexIterator, getPeriodicity, getPeriodicity, getShape, nearestImage, setBox

Methods inherited from class java.lang.Object

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

Field Detail

dimensions

protected final Vector dimensions

shift0

protected final float[][] shift0

edgeVectors

protected final Vector[] edgeVectors

Constructor Detail

BoundaryRectangular

public BoundaryRectangular(Space _space)

Constructs cubic boundary of the given periodicity, using the space and default box-size given by the Simulation.

BoundaryRectangular

public BoundaryRectangular(Space space,
                           double boxSize)

Constructs cubic boundary of the given periodicity with each edge of length boxSize

BoundaryRectangular

public BoundaryRectangular(Space space,
                           double[] boxSize)

Constructs rectangular boundary of the given periodicity with edges given by the values in the array boxSize. Length of arrays must equal dimension of space.

Method Detail

getBoxSize

public Vector getBoxSize()

Returns a vector with elements equal to the lengths of the edges of the boundary. The returned Vector does not represent the values internally, so manipulation of the vector has no effect on this BoundaryRectangular instance.

Specified by:

getBoxSize in class Boundary

Returns:

the box size

setBoxSize

public void setBoxSize(Vector v)

Sets the size and shape of the rectangular boundary. Values are copied, so manipulation of the given vector has no subsequent effect on this Boundary instance.

Specified by:

setBoxSize in class Boundary

Parameters:

v - the box's new size

updateDimensions

protected void updateDimensions()

volume

public double volume()

Returns the "volume" of the rectangular region defined by this Boundary. For a 2D and 1D spaces, this volume is actually an area and length, respectively.

Overrides:

volume in class Boundary

Returns:

the volume enclosed by the boundary

getEdgeVector

public Vector getEdgeVector(int d)

Description copied from class: Boundary

Returns the vector that defines the edge of this boundary for the given dimension. All vectors returned by this method can be considered to originate from one corner.

Specified by:

getEdgeVector in class Boundary

Parameters:

d - the dimension of the desired edge vector

Returns:

the edge vector

imageOrigins

public double[][] imageOrigins(int nShells)

Returns a set of image origins for a set of periodic image shells. The returned array is of dimension [(2*nShells+1)^D][D], where D is the dimension of the space.

Specified by:

imageOrigins in class Boundary

Parameters:

nShells - the number of shells of images to be computed