mpacts.commands.misc. recordenergy

In order to be able to use this module import it like this:

import mpacts.commands.misc.recordenergy
#or assign it to a shorter name
import mpacts.commands.misc.recordenergy as rec

RecordEnergyCommand

class mpacts.commands.misc.recordenergy.RecordEnergyCommand

Bases: mpacts.core.command.Command, mpacts.core.baseobject.BaseObject

Records the energy each particle receives or loses by accumulating the work of each timestep by taking the dot product of force and displacement.
Default location: ‘loop_cmds/output_cmds’
  • Required keywords:
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • predicate (default value = None) — Predicate that will decide whether this command is executed for a specific particle, when absent the command is executed for every particle.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate]
RecordEnergyCommand(name, parent, **kwargs)