mpacts.commands.time_evolution. linearchange

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

import mpacts.commands.time_evolution.linearchange
#or assign it to a shorter name
import mpacts.commands.time_evolution.linearchange as lin

LinearChangeCommand

class mpacts.commands.time_evolution.linearchange.LinearChangeCommand

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

Command which increases a given array ‘array’ with a certain value determined by the slope given as ‘rate’. The command is executed if a given predicate is evaluated as True (or no predicate is given).
Default location: ‘loop_cmds/pre_body_force_cmds’
  • Required keywords:
    • array — Array which will be linearly increased / decreased
    • pc — Particle container on which the command is applied
    • rate — rate d(array)/ dt at which ‘array’ will be changed
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • max_value (default value = 1.7976931348623157e+308) — maximal value of ‘array’. Will stop changing when arrived here.
    • min_value (default value = -1.7976931348623157e+308) — minimal value of ‘array’. Will stop changing when arrived here.
    • 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, array, rate, [gate, predicate, min_value, max_value]
LinearChangeCommand(name, parent, **kwargs)

LinearChangePointCommand

class mpacts.commands.time_evolution.linearchange.LinearChangePointCommand

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

Command which increases a given array ‘array’ with a certain value determined by the slope given as ‘rate’. The command is executed if a given predicate is evaluated as True (or no predicate is given).
Default location: ‘loop_cmds/pre_body_force_cmds’
  • Required keywords:
    • array — Array which will be linearly increased / decreased
    • pc — Particle container on which the command is applied
    • rate — rate d(array)/ dt at which ‘array’ will be changed
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • max_value (default value = 4.46927e+153 4.46927e+153 4.46927e+153) — maximal value of ‘array’. Will stop changing when arrived here.
    • min_value (default value = -4.46927e+153 -4.46927e+153 -4.46927e+153) — minimal value of ‘array’. Will stop changing when arrived here.
    • 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, array, rate, [gate, predicate, min_value, max_value]
LinearChangePointCommand(name, parent, **kwargs)

LinearChangeVectorCommand

class mpacts.commands.time_evolution.linearchange.LinearChangeVectorCommand

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

Command which increases a given array ‘array’ with a certain value determined by the slope given as ‘rate’. The command is executed if a given predicate is evaluated as True (or no predicate is given).
Default location: ‘loop_cmds/pre_body_force_cmds’
  • Required keywords:
    • array — Array which will be linearly increased / decreased
    • pc — Particle container on which the command is applied
    • rate — rate d(array)/ dt at which ‘array’ will be changed
  • Optional keywords:
    • gate (default value = ET::ChildProperty const*) — Can decide to (temporarily) not execute the command in a CommandList. (Default is ExecuteAlways)
    • max_value (default value = 4.46927e+153 4.46927e+153 4.46927e+153) — maximal value of ‘array’. Will stop changing when arrived here.
    • min_value (default value = -4.46927e+153 -4.46927e+153 -4.46927e+153) — minimal value of ‘array’. Will stop changing when arrived here.
    • 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, array, rate, [gate, predicate, min_value, max_value]
LinearChangeVectorCommand(name, parent, **kwargs)