Package etomica.space3d

Class Space3D

java.lang.Object

etomica.space.Space

etomica.space3d.Space3D

public final class Space3D
extends Space

Factory and methods appropriate to a 3-dimensional space. This is a singleton class that can be accessed only via the static getInstance method.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
int	D()
static Space3D	getInstance()
double[]	makeArrayD(double d)
int[]	makeArrayD(int i)
IOrientation	makeOrientation()
RotationTensor	makeRotationTensor()
Tensor	makeTensor()
Vector	makeVector()
double	powerD(double a)
int	powerD(int n)
static double	r2(Vector3D u1, Vector3D u2, Boundary b)	Computes the square of the magnitude of the difference of two vectors, subject to a nearest image transformation.
static double	r2(Vector3D u1, Vector3D u2, Boundary b, Vector3D work)	Computes the square of the magnitude of the difference of two vectors, subject to a nearest image transformation.
double	rootD(double a)	Returns the cube root of the given value, a^(1/D) which is a^(1/3).
double	sphereArea(double r)	The surface "area" of the "sphere" defined in the D-dimensional space.
double	sphereVolume(double r)	The "volume" of the "sphere" defined in the D-dimensional space.

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.space.Space

getD, getInstance, makeVector, makeVector, makeVector, makeVectorArray

Method Detail

getInstance

public static Space3D getInstance()

Returns:

Returns the instance.

D

public final int D()

Specified by:

D in class Space

Returns:

the dimension of this space.

powerD

public final int powerD(int n)

Specified by:

powerD in class Space

Returns:

the given value raised to the Dth power, where D is the dimension of the space.

powerD

public final double powerD(double a)

Specified by:

powerD in class Space

Returns:

the given value raised to the Dth power, where D is the dimension of the space.

rootD

public double rootD(double a)

Returns the cube root of the given value, a^(1/D) which is a^(1/3).

Specified by:

rootD in class Space

Returns:

the given value raised to the power 1/D, where D is the dimension of the space.

makeArrayD

public int[] makeArrayD(int i)

Specified by:

makeArrayD in class Space

Returns:

an array of dimension D (as defined for this Space instance), with each element equal to the given value.

makeArrayD

public double[] makeArrayD(double d)

Specified by:

makeArrayD in class Space

Returns:

an array of dimension D (as defined for this Space instance), with each element equal to the given value.

sphereVolume

public double sphereVolume(double r)

Description copied from class: Space

The "volume" of the "sphere" defined in the D-dimensional space. In 1-D, this is twice the radius; in 2-D the area of the circle; in 3-D the volume of the sphere.

Specified by:

sphereVolume in class Space

Parameters:

r - the radius

Returns:

the volume

sphereArea

public double sphereArea(double r)

Description copied from class: Space

The surface "area" of the "sphere" defined in the D-dimensional space. In 1-D this is zero; in 2-D the circumference of the circle; in 3-D the surface area of the sphere.

Specified by:

sphereArea in class Space

Parameters:

r - the sphere radius

Returns:

the area

makeVector

public Vector makeVector()

Specified by:

makeVector in class Space

Returns:

a new Vector appropriate to the space.

makeOrientation

public IOrientation makeOrientation()

Specified by:

makeOrientation in class Space

Returns:

a new Orientation appropriate to the space.

makeTensor

public Tensor makeTensor()

Specified by:

makeTensor in class Space

Returns:

a new Tensor appropriate to the space.

makeRotationTensor

public RotationTensor makeRotationTensor()

Specified by:

makeRotationTensor in class Space

Returns:

a new RotationTensor appropriate to the space.

r2

public static final double r2(Vector3D u1,
                              Vector3D u2,
                              Boundary b)

Computes the square of the magnitude of the difference of two vectors, subject to a nearest image transformation. This method constructs a new vector that is used as the work-vector input to the other r2 method.

r2

public static final double r2(Vector3D u1,
                              Vector3D u2,
                              Boundary b,
                              Vector3D work)

Computes the square of the magnitude of the difference of two vectors, subject to a nearest image transformation.

Parameters:

u1 - one of the vectors and is unchanged by the calculation

u2 - the other vector and is unchanged by the calculation

b - a nearest image transformation

work - a work vector used for the calculation.