Package etomica.lattice

Class LatticePlane

java.lang.Object

etomica.lattice.LatticePlane

All Implemented Interfaces:

AtomTest, java.io.Serializable, java.util.function.Predicate<IAtom>

public class LatticePlane
extends java.lang.Object
implements AtomTest, java.io.Serializable

Class describing a plane through a lattice. Holds a Plane object and a Primitive. The orientation of the plane is specified using Miller indices defined according to the primitive. As an AtomTest, returns true if the IAtom is on the "negative" side of the plane.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LatticePlane(Primitive primitive, int[] h)

Method Summary

Modifier and Type	Method	Description
int	getMillerIndex(int i)	Returns the current value of the i-th Miller index.
Vector	getOrigin()
Plane	getPlane()
double	getPosition()	Returns the position i, such the the plane is located at the i-th from the origin.
double	getSpacePosition()	Gets the position of the plane as the distance from the origin in the direction of the normal.
boolean	inPlane(Vector p)	Returns true if the given point is inside the plane (within some small tolerance).
void	invert()	Changes the direction of the normal vector so that it points toward the other side of the plane from its present orientation.
boolean	isPositiveSide(Vector p)	Returns true if the given point is on the side of the plane toward which the normal vector points.
void	setMillerIndex(int i, int h)	Sets the i-th Miller index to h, keeping the others fixed.
void	setMillerIndices(int[] h)	Sets the plane to the orientation specified by the given Miller indices applied to the current primitive.
void	setOrigin(Vector origin)	Sets the origin from which the position of the atom is measured.
void	setPosition(double d)	Sets to the position of the i-th plane from the one through the origin.
void	setPrimitive(Primitive primitive)
void	setSpacePosition(double d)	Sets the position of the plane to be the given distance from the origin in the direction of the normal.
void	setTolerance(double tolerance)
boolean	test(IAtom a)	Returns true if atom passes the test.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

LatticePlane

public LatticePlane(Primitive primitive,
                    int[] h)

Method Detail

test

public boolean test(IAtom a)

Description copied from interface: AtomTest

Returns true if atom passes the test.

Specified by:

test in interface AtomTest

Specified by:

test in interface java.util.function.Predicate<IAtom>

setTolerance

public void setTolerance(double tolerance)

setPrimitive

public void setPrimitive(Primitive primitive)

setMillerIndices

public void setMillerIndices(int[] h)

Sets the plane to the orientation specified by the given Miller indices applied to the current primitive.

getMillerIndex

public int getMillerIndex(int i)

Returns the current value of the i-th Miller index.

setMillerIndex

public void setMillerIndex(int i,
                           int h)

Sets the i-th Miller index to h, keeping the others fixed. If setting causes all indices to be zero, change is not implemented.

setSpacePosition

public void setSpacePosition(double d)

Sets the position of the plane to be the given distance from the origin in the direction of the normal.

getSpacePosition

public double getSpacePosition()

Gets the position of the plane as the distance from the origin in the direction of the normal.

setPosition

public void setPosition(double d)

Sets to the position of the i-th plane from the one through the origin.

getPosition

public double getPosition()

Returns the position i, such the the plane is located at the i-th from the origin.

isPositiveSide

public boolean isPositiveSide(Vector p)

Returns true if the given point is on the side of the plane toward which the normal vector points. The direction of the normal vector can be inverted using the invert method.

inPlane

public boolean inPlane(Vector p)

Returns true if the given point is inside the plane (within some small tolerance).

getPlane

public Plane getPlane()

setOrigin

public void setOrigin(Vector origin)

Sets the origin from which the position of the atom is measured.

getOrigin

public Vector getOrigin()

invert

public void invert()

Changes the direction of the normal vector so that it points toward the other side of the plane from its present orientation. Does not affect the location or absolute orientation of the plane.