Package etomica.integrator.mcmove

Class MCMoveBoxStep

java.lang.Object

etomica.integrator.mcmove.MCMove

etomica.integrator.mcmove.MCMoveBox

etomica.integrator.mcmove.MCMoveBoxStep

All Implemented Interfaces:

MCMoveStepDependent

Direct Known Subclasses:

MCMoveAtom, MCMoveAtomCoupled, MCMoveAtomCoupled, MCMoveAtomCoupledBennet, MCMoveAtomCoupledUmbrella, MCMoveAtomSuperBox, MCMoveBoxSize, MCMoveChangeBondLength, MCMoveClusterAngleBend, MCMoveClusterAngleBendAceticAcid, MCMoveDimer, MCMoveDimer, MCMoveDimerRotate, MCMoveDimerRotate, MCMoveHarmonicStep, MCMoveMolecule, MCMoveMoleculeCoupled, MCMoveMoleculeCoupledInitPert, MCMoveMoleculeCoupledSuperBox, MCMovePhaseAngle, MCMoveSingleMode, MCMoveSmer, MCMoveSmerRotate, MCMoveVolume, MCMoveVolumeAssociated, MCMoveVolumeAssociatedMolecule, MCMoveVolumeMonoclinic, MCMoveVolumeMonoclinicAngle, MCMoveVolumeMonoclinicScaled, MCMoveVolumeN2, MCMoveVolumeSolid, MCMoveVolumeSolidNPTMolecular, MCMoveWV

public abstract class MCMoveBoxStep
extends MCMoveBox
implements MCMoveStepDependent

MCMove parent class for moves that have a step size and operate on a single Box.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	stepSize
protected double	stepSizeMax
protected double	stepSizeMin

Fields inherited from class etomica.integrator.mcmove.MCMove

moveTracker, nominalFrequency, potential

Fields inherited from class etomica.integrator.mcmove.MCMoveBox

box, perParticleFrequency

Constructor Summary

Constructors

Constructor	Description
MCMoveBoxStep(PotentialMaster potentialMaster)
MCMoveBoxStep(PotentialMaster potentialMaster, MCMoveStepTracker acceptanceTracker)

Method Summary

Modifier and Type	Method	Description
double	getStepSize()	returns the current step size.
Dimension	getStepSizeDimension()
double	getStepSizeMax()	Returns the maximum allowable steps size.
Dimension	getStepSizeMaxDimension()
double	getStepSizeMin()	Returns the minimum allowable steps size.
Dimension	getStepSizeMinDimension()
void	setStepSize(double newStepSize)	Sets the step size of the move.
void	setStepSizeMax(double newStepSizeMax)	Sets the maximum allowable step size.
void	setStepSizeMin(double newStepSizeMin)	Returns the maximum allowable steps size.

Methods inherited from class etomica.integrator.mcmove.MCMove

acceptNotify, doTrial, getChi, getNominalFrequency, getTracker, rejectNotify, setTracker

Methods inherited from class etomica.integrator.mcmove.MCMoveBox

affectedAtoms, affectedAtoms, energyChange, energyChange, getBox, isNominallyPerParticleFrequency, setBox, toString

Methods inherited from class java.lang.Object

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

Field Detail

stepSize

protected double stepSize

stepSizeMax

protected double stepSizeMax

stepSizeMin

protected double stepSizeMin

Constructor Detail

MCMoveBoxStep

public MCMoveBoxStep(PotentialMaster potentialMaster)

MCMoveBoxStep

public MCMoveBoxStep(PotentialMaster potentialMaster,
                     MCMoveStepTracker acceptanceTracker)

Method Detail

getStepSize

public double getStepSize()

Description copied from interface: MCMoveStepDependent

returns the current step size.

Specified by:

getStepSize in interface MCMoveStepDependent

getStepSizeMax

public double getStepSizeMax()

Description copied from interface: MCMoveStepDependent

Returns the maximum allowable steps size.

Specified by:

getStepSizeMax in interface MCMoveStepDependent

getStepSizeMin

public double getStepSizeMin()

Description copied from interface: MCMoveStepDependent

Returns the minimum allowable steps size.

Specified by:

getStepSizeMin in interface MCMoveStepDependent

setStepSize

public void setStepSize(double newStepSize)

Description copied from interface: MCMoveStepDependent

Sets the step size of the move.

Specified by:

setStepSize in interface MCMoveStepDependent

setStepSizeMax

public void setStepSizeMax(double newStepSizeMax)

Description copied from interface: MCMoveStepDependent

Sets the maximum allowable step size.

Specified by:

setStepSizeMax in interface MCMoveStepDependent

setStepSizeMin

public void setStepSizeMin(double newStepSizeMin)

Description copied from interface: MCMoveStepDependent

Returns the maximum allowable steps size.

Specified by:

setStepSizeMin in interface MCMoveStepDependent

getStepSizeDimension

public final Dimension getStepSizeDimension()

getStepSizeMaxDimension

public final Dimension getStepSizeMaxDimension()

getStepSizeMinDimension

public final Dimension getStepSizeMinDimension()