mpacts.commands.time_evolution. controllers

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

import mpacts.commands.time_evolution.controllers
#or assign it to a shorter name
import mpacts.commands.time_evolution.controllers as con


class mpacts.commands.time_evolution.controllers.PIDControllerCommand

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

Command which sets an array according to an “error” array and up to three parameters for proportional, integral and derivative control.
Default location: ‘loop_cmds/pre_body_force_cmds’
  • Required keywords:
    • Kp — Proportional gain
    • array — Array of to be manipulated/controlled.
    • errors — Array of error to be corrected
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • Kd (default value = 0) — Derivative gain
    • Ki (default value = 0) — Integral gain
    • 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 deciding whether the command should be executed for a given particle
object __init__(tuple args, dict kwds) :
args: name, parent kwds: array, errors, pc, Kp, [gate, Kd, Ki, predicate]
PIDControllerCommand(name, parent, **kwargs)