BoundaryTruncatedOctahedron

java.lang.Object
- etomica.space.Boundary
- - etomica.space3d.BoundaryTruncatedOctahedron

```
public class BoundaryTruncatedOctahedron
extends Boundary
```
This class enables creation of a periodic truncated-octahedron boundary. Truncated octahedrons are spacefillers; unlike spheres, about which voids form when placed in an array, truncated octahedrons can be flush with other truncated octahedrons at every face when grouped in an array. Moreover, truncated octahedrons are considerably more sphere-like than cubes, and using a truncated octahedron as a boundary greatly increases the isotropy of the system.
There are no subclasses for periodic and nonperiodic boundary conditions for this class because nonperiodic boundary conditions are not applicable for truncated octahedrons.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Vector`	`dimensions`
`protected Vector`	`dimensionsHalf`
`protected Vector`	`intoTruncatedOctahedron`
`protected Vector`	`rrounded`
`protected float[][]`	`shift`
`protected float[][]`	`shift0`

Fields inherited from class etomica.space.Boundary
box, eventManager, inflateEvent, shape, space

Constructor Summary

Constructors
Constructor Description

BoundaryTruncatedOctahedron(Space _space)

BoundaryTruncatedOctahedron(Space _space, double boxSize)

Constructors
Constructor	Description
`BoundaryTruncatedOctahedron(Space _space)`
`BoundaryTruncatedOctahedron(Space _space, double boxSize)`

Method Summary

All Methods Instance Methods Concrete Methods
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).
`Vector`	`getBoxSize()`	Returns the length of the sides of a rectangular box oriented in the lab frame and in which the boundary is inscribed.
`Vector`	`getEdgeVector(int d)`	Returns the vector that defines the edge of this boundary for the given dimension.
`IndexIteratorSizable`	`getIndexIterator()`
`boolean`	`getPeriodicity(int i)`	Returns true if the boundary is periodic in the given direction (as defined by the getEdgeVector method).
`double[][]`	`imageOrigins(int nShells)`	Set of vectors describing the displacements needed to translate the central image to all of the periodic images.
`void`	`nearestImage(Vector dr)`	The nearest image is the pair of atom images that are closest when all periodic-boundary images are considered.
`Vector`	`randomPosition()`
`void`	`setBoxSize(Vector v)`	Scales the boundary dimensions such that the boundary's would be inscribed within a rectangle of the of the given size.

Methods inherited from class etomica.space.Boundary
getBox, getCenter, getEventManager, getPeriodicity, getShape, setBox, volume

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - intoTruncatedOctahedron
```
protected final Vector intoTruncatedOctahedron
```
  - rrounded
```
protected final Vector rrounded
```
  - dimensions
```
protected final Vector dimensions
```
  - dimensionsHalf
```
protected final Vector dimensionsHalf
```
  - shift0
```
protected final float[][] shift0
```
  - shift
```
protected float[][] shift
```
- Constructor Detail
  - BoundaryTruncatedOctahedron
```
public BoundaryTruncatedOctahedron(Space _space)
```
  - BoundaryTruncatedOctahedron
```
public BoundaryTruncatedOctahedron(Space _space,
                                   double boxSize)
```
- Method Detail
  - getPeriodicity
```
public boolean getPeriodicity(int i)
```
    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:
    
    i - the dimension of the desired periodicity
    
    Returns:
    
    the periodicity of dimension d
  - getBoxSize
```
public final Vector getBoxSize()
```
    Description copied from class: Boundary
    
    Returns the length of the sides of a rectangular box oriented in the lab frame and in which the boundary is inscribed. For a rectangular boundary, this is simply the length of the boundary in each direction. Each element of the returned vector gives in that coordinate direction the maximum distance from one point on the boundary to another.
    Manipulation of this copy will not cause any change to the boundary's dimensions.
    
    Specified by:
    
    getBoxSize in class Boundary
    
    Returns:
    
    the box size
  - randomPosition
```
public Vector randomPosition()
```
  - getIndexIterator
```
public IndexIteratorSizable getIndexIterator()
```
    Specified by:
    
    getIndexIterator in class Boundary
  - setBoxSize
```
public void setBoxSize(Vector v)
```
    Description copied from class: Boundary
    
    Scales the boundary dimensions such that the boundary's would be inscribed within a rectangle of the of the given size. For a rectangular boundary, this simply sets the boundary length in each dimension. Specific interpretation of the given values for non-rectangular shapes depends on the subclass.
    
    Specified by:
    
    setBoxSize in class Boundary
    
    Parameters:
    
    v - the box's new size
  - 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)
```
    Description copied from class: Boundary
    
    Set of vectors describing the displacements needed to translate the central image to all of the periodic images. The first index specifies each periodic image, while the second index indicates the xyz components of the translation vector.
    
    Specified by:
    
    imageOrigins in class Boundary
    
    Parameters:
    
    nShells - the number of shells of images to be computed
  - 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
  - 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

Class BoundaryTruncatedOctahedron

Field Summary

Fields inherited from class etomica.space.Boundary

Constructor Summary

Method Summary

Methods inherited from class etomica.space.Boundary

Methods inherited from class java.lang.Object

Field Detail

intoTruncatedOctahedron

rrounded

dimensions

dimensionsHalf

shift0

shift

Constructor Detail

BoundaryTruncatedOctahedron

BoundaryTruncatedOctahedron

Method Detail

getPeriodicity

getBoxSize

randomPosition

getIndexIterator

setBoxSize

getEdgeVector

imageOrigins

nearestImage

centralImage