Package etomica.space

Class BoundaryRectangularPeriodic

java.lang.Object

etomica.space.Boundary

etomica.space.BoundaryRectangular

etomica.space.BoundaryRectangularPeriodic

Direct Known Subclasses:

BoundaryRectangularPeriodicSwitch

public class BoundaryRectangularPeriodic
extends BoundaryRectangular

Rectangular boundary that is periodic in every dimension.

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector	tempImage

Fields inherited from class etomica.space.Boundary

box, eventManager, inflateEvent, shape, space

Fields inherited from class etomica.space.BoundaryRectangular

dimensions, edgeVectors, shift0

Constructor Summary

Constructors

Constructor	Description
BoundaryRectangularPeriodic(Space _space)	Constructs cubic boundary with the default box-size given by the Simulation.
BoundaryRectangularPeriodic(Space _space, double boxSize)	Constructs cubic boundary for the given Space, with each edge of length boxSize.
BoundaryRectangularPeriodic(Space _space, double[] boxSize)	Constructs rectangular boundary for the given Space, with each edge of length boxSize.

Method Summary

Modifier and Type	Method	Description
Vector	centralImage(Vector r)	Determines the translation vector needed to apply a periodic-image transformation that moves the given point to an image point within the boundary (if it lies outside, in a direction subject to periodic imaging).
IndexIteratorSizable	getIndexIterator()
boolean	getPeriodicity(int d)	Returns true if the boundary is periodic in the given direction (as defined by the getEdgeVector method).
void	nearestImage(Vector dr)	The nearest image is the pair of atom images that are closest when all periodic-boundary images are considered.
void	updateDimensions()

Methods inherited from class etomica.space.Boundary

getBox, getCenter, getEventManager, getPeriodicity, getShape, setBox

Methods inherited from class etomica.space.BoundaryRectangular

getBoxSize, getEdgeVector, imageOrigins, setBoxSize, volume

Methods inherited from class java.lang.Object

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

Field Detail

tempImage

protected final Vector tempImage

Constructor Detail

BoundaryRectangularPeriodic

public BoundaryRectangularPeriodic(Space _space)

Constructs cubic boundary with the default box-size given by the Simulation.

BoundaryRectangularPeriodic

public BoundaryRectangularPeriodic(Space _space,
                                   double boxSize)

Constructs cubic boundary for the given Space, with each edge of length boxSize.

BoundaryRectangularPeriodic

public BoundaryRectangularPeriodic(Space _space,
                                   double[] boxSize)

Constructs rectangular boundary for the given Space, with each edge of length boxSize.

Method Detail

updateDimensions

public void updateDimensions()

Overrides:

updateDimensions in class BoundaryRectangular

getIndexIterator

public IndexIteratorSizable getIndexIterator()

Specified by:

getIndexIterator in class Boundary

centralImage

public Vector centralImage(Vector r)

Description copied from class: Boundary

Determines the translation vector needed to apply a periodic-image transformation that moves the given point to an image point within the boundary (if it lies outside, in a direction subject to periodic imaging).

Specified by:

centralImage in class Boundary

Parameters:

r - vector position of untransformed point; r is not changed by this method

Returns:

the displacement that must be applied to r to move it to its central-image location

nearestImage

public void nearestImage(Vector dr)

Description copied from class: Boundary

The nearest image is the pair of atom images that are closest when all periodic-boundary images are considered.

If the vector passed to this method is the displacement vector between two points, the vector will be transformed such that it corresponds to the vector between the nearest image of those two points.

Specified by:

nearestImage in class Boundary

Parameters:

dr - the vector to be transformed

getPeriodicity

public boolean getPeriodicity(int d)

Description copied from class: Boundary

Returns true if the boundary is periodic in the given direction (as defined by the getEdgeVector method).

Specified by:

getPeriodicity in class Boundary

Parameters:

d - the dimension of the desired periodicity

Returns:

the periodicity of dimension d