mpacts.commands.time_evolution. interpolatedmotion

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

import mpacts.commands.time_evolution.interpolatedmotion
#or assign it to a shorter name
import mpacts.commands.time_evolution.interpolatedmotion as int

InterpolatedOffsetPointMotionCommand

class mpacts.commands.time_evolution.interpolatedmotion.InterpolatedOffsetPointMotionCommand

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

Command to impose interpolated motion on an object by imposing an offset that will be applied to all particles in a particle container (opposed to regular InterpolatedMotionCommands, which is applied to a single particle, and where an absolute position is imposed. In a certain sense this can be seen as a time integrator.
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • time_series — The times at which interpolated and double derivates values are given
    • v — The derivative of the target of interpolation, will also be set by InterpolatedMotionCommand (typically pc[“v”])
    • value_series — The values at different timestep of the interpolated quantity
    • x — The quantity that will be target of the interpolation (typically pc[“x”])
  • Optional keywords:
    • double_derivates_series (default value = None) — The double derivates at different timestep of the interpolated quantity
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • period (default value = -1) — Set this value to a positive number to make the whole thing periodic
    • 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 (only used for the InterpolatedPointOffsetMotion).
    • previous_offset (default value = 0 0 0) — In case the command is used in its offset form, this property holds the offset ‘up till now’
    • time_shift (default value = 0) — This value is added to the simulation time in order to look-up values in the time-series. This allows for easy synchronization with periodic motions in simulations.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: x, v, time_series, value_series, [gate, previous_offset, double_derivates_series, period, time_shift, predicate]
InterpolatedOffsetPointMotionCommand(name, parent, **kwargs)

InterpolatedPointMotionCommand

class mpacts.commands.time_evolution.interpolatedmotion.InterpolatedPointMotionCommand

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

Command to impose interpolated motion on an object. In a certain sense this can be seen as a time integrator. Accepts Vector arrays as interpolation target, and it can also set the derivative of this quantity,
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • time_series — The times at which interpolated and double derivates values are given
    • v — The derivative of the target of interpolation, will also be set by InterpolatedMotionCommand (typically pc[“v”])
    • value_series — The values at different timestep of the interpolated quantity
    • x — The quantity that will be target of the interpolation (typically pc[“x”])
  • Optional keywords:
    • double_derivates_series (default value = None) — The double derivates at different timestep of the interpolated quantity
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • particle_idx (default value = 0) — The index of the particle on which this interpolated motion will be applied.
    • period (default value = -1) — Set this value to a positive number to make the whole thing periodic
    • 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 (only used for the InterpolatedPointOffsetMotion).
    • time_shift (default value = 0) — This value is added to the simulation time in order to look-up values in the time-series. This allows for easy synchronization with periodic motions in simulations.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: x, v, time_series, value_series, [gate, double_derivates_series, particle_idx, period, time_shift, predicate]
InterpolatedPointMotionCommand(name, parent, **kwargs)

InterpolatedQuaternionMotionCommand

class mpacts.commands.time_evolution.interpolatedmotion.InterpolatedQuaternionMotionCommand

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

Command to impose interpolated motion on an object. In a certain sense this can be seen as a time integrator. Accepts Vector arrays as interpolation target, and it can also set the derivative of this quantity,
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • time_series — The times at which interpolated and double derivates values are given
    • v — The derivative of the target of interpolation, will also be set by InterpolatedMotionCommand (typically pc[“v”])
    • value_series — The values at different timestep of the interpolated quantity
    • x — The quantity that will be target of the interpolation (typically pc[“x”])
  • Optional keywords:
    • double_derivates_series (default value = None) — The double derivates at different timestep of the interpolated quantity
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • particle_idx (default value = 0) — The index of the particle on which this interpolated motion will be applied.
    • period (default value = -1) — Set this value to a positive number to make the whole thing periodic
    • 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 (only used for the InterpolatedPointOffsetMotion).
    • time_shift (default value = 0) — This value is added to the simulation time in order to look-up values in the time-series. This allows for easy synchronization with periodic motions in simulations.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: x, v, time_series, value_series, [gate, double_derivates_series, particle_idx, period, time_shift, predicate]
InterpolatedQuaternionMotionCommand(name, parent, **kwargs)

InterpolatedScalarMotionCommand

class mpacts.commands.time_evolution.interpolatedmotion.InterpolatedScalarMotionCommand

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

Command to impose interpolated motion on an object. In a certain sense this can be seen as a time integrator. Accepts scalar arrays as interpolation target, and it can also set the derivative of this quantity,
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • time_series — The times at which interpolated and double derivates values are given
    • v — The derivative of the target of interpolation, will also be set by InterpolatedMotionCommand (typically pc[“v”])
    • value_series — The values at different timestep of the interpolated quantity
    • x — The quantity that will be target of the interpolation (typically pc[“x”])
  • Optional keywords:
    • double_derivates_series (default value = None) — The double derivates at different timestep of the interpolated quantity
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • particle_idx (default value = 0) — The index of the particle on which this interpolated motion will be applied.
    • period (default value = -1) — Set this value to a positive number to make the whole thing periodic
    • 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 (only used for the InterpolatedPointOffsetMotion).
    • time_shift (default value = 0) — This value is added to the simulation time in order to look-up values in the time-series. This allows for easy synchronization with periodic motions in simulations.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: x, v, time_series, value_series, [gate, double_derivates_series, particle_idx, period, time_shift, predicate]
InterpolatedScalarMotionCommand(name, parent, **kwargs)

InterpolatedVectorMotionCommand

class mpacts.commands.time_evolution.interpolatedmotion.InterpolatedVectorMotionCommand

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

Command to impose interpolated motion on an object. In a certain sense this can be seen as a time integrator. Accepts Vector arrays as interpolation target, and it can also set the derivative of this quantity,
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • time_series — The times at which interpolated and double derivates values are given
    • v — The derivative of the target of interpolation, will also be set by InterpolatedMotionCommand (typically pc[“v”])
    • value_series — The values at different timestep of the interpolated quantity
    • x — The quantity that will be target of the interpolation (typically pc[“x”])
  • Optional keywords:
    • double_derivates_series (default value = None) — The double derivates at different timestep of the interpolated quantity
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • particle_idx (default value = 0) — The index of the particle on which this interpolated motion will be applied.
    • period (default value = -1) — Set this value to a positive number to make the whole thing periodic
    • 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 (only used for the InterpolatedPointOffsetMotion).
    • time_shift (default value = 0) — This value is added to the simulation time in order to look-up values in the time-series. This allows for easy synchronization with periodic motions in simulations.
object __init__(tuple args, dict kwds) :
args: name, parent kwds: x, v, time_series, value_series, [gate, double_derivates_series, particle_idx, period, time_shift, predicate]
InterpolatedVectorMotionCommand(name, parent, **kwargs)