Package etomica.space

Specifies abstract classes and interfaces that define the nature of the physical space in which a simulation is performed. Implementations are given in the packages etomica.space3d, etomica.space2d, and etomica.space1d, for 3-, 2-, and 1-dimensional spaces, respectively. The key elements are:

• Space, which serves primarily as a factory for the other classes. Subclasses of Space make vectors, etc. appropriate to the space it represents.
• Vector, which for a D-dimensional space is a set of D fields of type double, with methods used the perform vector operations on them.
• Tensor, which defines a 2nd-rank tensor in the D-dimensional space. It hold D² fields of type double, and defines methods used to perform tensor operations on them.
• Orientation, which provides fields and operations define and manipulate the orientation of a rigid body.
• Boundary, which is held by a Box instance to define the size of the box and to specify what happens as atoms cross the boundary of the space (e.g., periodic boundaries).

All of the classes above (except perhaps Boundary) are implemented in the space subpackages in a manner specific to the space being defined.

Interface Summary

Interface	Description
BoundaryEventListener	Listener for boundary events.
IOrientation	Interface for a class that specifies an orientation in space.
RotationTensor	A tensor intended for use to perform rotations in space.
Tensor	Interface for a second-order tensor.
Vector	Interface containing vector operations, accessor, and mutator methods.

Class Summary

Class	Description
BenchVector
BenchVector3D
Boundary	Parent class of boundary objects that describe the size and periodic nature of the box boundaries.
BoundaryDeformableLattice	Deformable boundary that takes the shape of a primitive with some number of cells in each dimension.
BoundaryDeformablePeriodic	Boundary shaped as an arbitrary parallelepiped.
BoundaryEvent	Event that informs a listener about some change to a boundary.
BoundaryEventManager	Manager of listeners for boundary events.
BoundaryRectangular	Boundary that is in the shape of a rectangular parallelepiped.
BoundaryRectangularNonperiodic	Boundary that is not periodic in any direction.
BoundaryRectangularPeriodic	Rectangular boundary that is periodic in every dimension.
BoundaryRectangularPore	Class for implementing pore periodic boundary conditions, in which one dimension is periodic.
BoundaryRectangularSlit	Class for implementing slit periodic boundary conditions, in which one dimension is not periodic.
Space	Superclass for all Space instances.