Package etomica.action

Provides interfaces and classes that define elementary actions that can be performed on simulation elements.

See:
Description

Interface Summary

ActionGroup
AtomAction	Interface for a class that can perform an action on an atom.
BoxAction	Elementary action performed on a box.
ControllerAction	Elementary action performed on a controller.
IAction
IntegratorAction	Elementary action performed on an integrator.
MoleculeAction	Interface for a class that can perform an action on an atom.
SimulationAction	Interface for classes that apply some elementary action (transformation) to a simulation.
Undoable	Interface for an action that can be "undone", such that its effect is reversed if the undo() method is invoked immediately after the actionPerformed().

Class Summary

ActionGroupSeries	A set of Action instances grouped and performed in series as if a single action.
ActionIntegrate	Action that repeatedly invokes an Integrator's doStep method.
ActionToggle	Action that toggles a boolean value.
Activity	An Action that supports the capability of pausing/unpausing and terminating on request.
AtomActionRandomizeVelocity	Action that sets the velocity vector of a given atom to a randomly chosen value sampled from a Boltzmann distribution.
AtomActionRotateBy	Performs RIGHT-HANDED rotations of an atom about the x-, y-, and z-axes by the specified angles (roll, pitch, and yaw angles, respectively) in radians.
AtomActionTranslateBy	Moves (translates) an atom by a specified vector amount.
BoxActionAdapter	Convenience class used to define a BoxAction.
BoxDeleteMolecules	Deletes molecules from a box as determined by an AtomFilter.
BoxImposePbc	Action that imposes the central-image effect of a box having periodic boundaries.
BoxInflate	Performs actions that cause volume of system to expand or contract, with molecule positions scaled to keep them in the same relative positions.
BoxInflateDeformable	Performs actions that cause volume of a deformable system to expand, with molecule positions scaled to keep them in the same relative positions.
BoxQuench	Scales all velocities of a box so that its kinetic temperature is equal to a given value.
BoxRandomizeMomenta	Randomizes the velocities of all the leaf atoms in an IBox based on the Maxwell-Boltzmann distribution.
BoxScaleMomenta	Scales the momenta of all the leaf atoms in an IBox such that the kinetic temperature matches some value.
CalcVibrationalModes	Calculates the eigenvalues of an NxN matrix.
ControllerActionAdapter	Convenience class used to define a ControllerAction.
ControllerToggle	Switches controller between paused and unpaused conditions, or starts it if not yet active.
IntegratorActionAdapter	Convenience class used to define a IntegratorAction.
IntegratorDimerApproach
IntegratorReset	Action that calls the reset method of an integrator.
MoleculeActionTranslateTo	Moves (translates) an atom to a specified position.
MoleculeChildAtomAction	Wraps an AtomAction, and performs the wrapped action on the atom only if it is a leaf atom; if given an atom group (as indicated by the atom's node), performs action instead on all the atom's child atoms.
PDBWriter	Action that dumps a box's configuration to an PDB file.
ResetAccumulators
ResetAccumulatorsAveraged
SimulationActionAdapter	Convenience class used to define a SimulationAction.
SimulationDataAction	Action that performs a call to the reset() method of a set of accumulators, as specified via a list of AccumulatorManager instances.
SimulationRestart	Action that invokes reset method of all registered simulation elements, effectively initializing the entire simulation.
WriteConfiguration	Dumps a box's configuration to a file.
WriteConfigurationDLPOLY	Dumps a box's configuration to a file.
WriteConfigurationOriented	WriteConfiguration subclass capable of handling oriented atoms.
WriteConfigurationP2DLPOLY	Dumps a box's configuration to a file.
XYZWriter	Action that dumps a box's configuration to an XYZ file.

Package etomica.action Description

Provides interfaces and classes that define elementary actions that can be performed on simulation elements. Examples include classes that move an atom, or that change the density of a box. This package defines the Action interface. This interface includes the actionPerformed method, which a class implements to define its action.

Interfaces extending Action define actions for different etomica elements, such as Box, Atom, and so on. Atomset actions are expected as arguments to the allAtoms methods of atom iterators.

Activity implements Action and is an abstract class appropriate to encapsulate more complex, time-consuming tasks. Classes extending Activity are collected in the subpackage etomica.action.activity.