Package etomica.models.nitrogen

Class BoundaryRectangularPeriodicSwitch

java.lang.Object

etomica.space.Boundary

etomica.space.BoundaryRectangular

etomica.space.BoundaryRectangularPeriodic

etomica.models.nitrogen.BoundaryRectangularPeriodicSwitch

public class BoundaryRectangularPeriodicSwitch
extends BoundaryRectangularPeriodic

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	doPBC

Fields inherited from class etomica.space.Boundary

box, eventManager, inflateEvent, shape, space

Fields inherited from class etomica.space.BoundaryRectangular

dimensions, edgeVectors, shift0

Fields inherited from class etomica.space.BoundaryRectangularPeriodic

tempImage

Constructor Summary

Constructors

Constructor	Description
BoundaryRectangularPeriodicSwitch(Space _space)

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).
boolean	getPeriodicity(int d)	Returns true if the boundary is periodic in the given direction (as defined by the getEdgeVector method).
boolean	isDoPBC()
void	nearestImage(Vector dr)	The nearest image is the pair of atom images that are closest when all periodic-boundary images are considered.
void	setDoPBC(boolean doPBC)

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 etomica.space.BoundaryRectangularPeriodic

getIndexIterator, updateDimensions

Methods inherited from class java.lang.Object

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

Field Detail

doPBC

protected boolean doPBC

Constructor Detail

BoundaryRectangularPeriodicSwitch

public BoundaryRectangularPeriodicSwitch(Space _space)

Method Detail

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.

Overrides:

nearestImage in class BoundaryRectangularPeriodic

Parameters:

dr - the vector to be transformed

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).

Overrides:

centralImage in class BoundaryRectangularPeriodic

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

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).

Overrides:

getPeriodicity in class BoundaryRectangularPeriodic

Parameters:

d - the dimension of the desired periodicity

Returns:

the periodicity of dimension d

isDoPBC

public boolean isDoPBC()

setDoPBC

public void setDoPBC(boolean doPBC)