Package etomica.action

Class BoxQuench

java.lang.Object

etomica.action.BoxActionAdapter

etomica.action.BoxQuench

All Implemented Interfaces:

BoxAction, IAction

public class BoxQuench
extends BoxActionAdapter

Scales all velocities of a box so that its kinetic temperature is equal to a given value.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	dim
protected MeterTemperature	meterTemperature
protected double	temperature

Fields inherited from class etomica.action.BoxActionAdapter

box

Constructor Summary

Constructors

Constructor	Description
BoxQuench(double temperature, int dim)	Constructs class without specifying box and using Default temperature.
BoxQuench(int dim)
BoxQuench(Box p, double temperature)	Constructs class ready to perform quench on given box to given temperature.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed()	Completes the action defined by the class implementing this interface.
double	getTemperature()	Returns the quench temperature.
void	setBox(Box p)	Specifies the Box that will be subject to the action, upon subsequent call to actionPerformed()
void	setTemperature(double temperature)	Sets the quench temperature.

Methods inherited from class etomica.action.BoxActionAdapter

getBox

Methods inherited from class java.lang.Object

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

Field Detail

temperature

protected double temperature

meterTemperature

protected MeterTemperature meterTemperature

dim

protected final int dim

Constructor Detail

BoxQuench

public BoxQuench(int dim)

BoxQuench

public BoxQuench(double temperature,
                 int dim)

Constructs class without specifying box and using Default temperature. Requires call to setBox before action will have any effect.

BoxQuench

public BoxQuench(Box p,
                 double temperature)

Constructs class ready to perform quench on given box to given temperature.

Method Detail

setBox

public void setBox(Box p)

Description copied from interface: BoxAction

Specifies the Box that will be subject to the action, upon subsequent call to actionPerformed()

Specified by:

setBox in interface BoxAction

Overrides:

setBox in class BoxActionAdapter

Parameters:

p - The box on which this action will be performed.

actionPerformed

public void actionPerformed()

Description copied from interface: IAction

Completes the action defined by the class implementing this interface.

See Also:

IAction.actionPerformed()

getTemperature

public double getTemperature()

Returns the quench temperature.

setTemperature

public void setTemperature(double temperature)

Sets the quench temperature.