mpacts.commands.time_evolution. integration

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

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

ComputeVelocitiesFromSegmentForcesAndTorque

class mpacts.commands.time_evolution.integration.ComputeVelocitiesFromSegmentForcesAndTorque

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

Determine the velocities of the nodes from segment data in the overdamped case. This can be seen as an explicit solver.
Default location: ‘loop_cmds/pre_integration_cmds’
  • Required keywords:
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • chi_r (default value = None) — Array containing mobility matrices for rotation. By default the ‘invgamma_rot’ array is used.
    • chi_t (default value = None) — Array containing mobility matrices for translation. By default the ‘invgamma’ array is used.
    • 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, chi_t, chi_r]
ComputeVelocitiesFromSegmentForcesAndTorque(name, parent, **kwargs)

ForwardEuler_Generic

class mpacts.commands.time_evolution.integration.ForwardEuler_Generic

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

Time integration for any arrays ‘x’ and ‘dx’ belonging to the same manager, vector or scalar.
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • dx — The value ‘dx’ that gets integrated as x += dx*dt
    • pc — Particle container on which the command is applied
    • x — The value ‘x’ that needs to be integrated as x += dx*dt
  • 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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, x, dx, [gate, predicate, timestep]
ForwardEuler_Generic(name, parent, **kwargs)

ForwardEuler_LiquidDragDominated

class mpacts.commands.time_evolution.integration.ForwardEuler_LiquidDragDominated

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

Time integration specifically for objects where drag with a fluidum is dominant. Experimental, and currently requests a single drag coefficient which includes effect of frontal area and liquid density, usage is not recommended (yet)!
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • c (kg . m^-1) — Drag coefficient c of the particle. Drag force: F = -c v^2
    • 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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, c, [gate, predicate, timestep]
ForwardEuler_LiquidDragDominated(name, parent, **kwargs)

ForwardEuler_Translation

class mpacts.commands.time_evolution.integration.ForwardEuler_Translation

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

Time integration
Default location: ‘loop_cmds/integration_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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep]
ForwardEuler_Translation(name, parent, **kwargs)

ForwardEuler_UncoupledOverdamped

class mpacts.commands.time_evolution.integration.ForwardEuler_UncoupledOverdamped

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

Time integration which sets the velocity based on a prescribed damping coefficient and uses Forward Euler integration to increment the positions
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • gamma_array (default value = None) — Array with damping symmetric matrices. If given, parameter ‘gamma’ will be ignored
    • gamma (default value = -1) — Scalar damping coefficient
    • 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.
    • set_v_array (default value = 1) — If ‘false’, the positions will be directly set without updating a velocity array
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep, gamma, gamma_array, set_v_array]
ForwardEuler_UncoupledOverdamped(name, parent, **kwargs)

ForwardEuler_UncoupledOverdampedMatrix

class mpacts.commands.time_evolution.integration.ForwardEuler_UncoupledOverdampedMatrix

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

Time integration which sets the velocity based on a prescribed mobility matrix and uses Forward Euler integration to increment the positions
Default location: ‘loop_cmds/integration_cmds’
  • Required keywords:
    • pc — Particle container on which the command is applied
  • Optional keywords:
    • chi (default value = None) — Array with mobility matrices. By default the array ‘chi’ is taken.
    • 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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep, chi]
ForwardEuler_UncoupledOverdampedMatrix(name, parent, **kwargs)

GearsCorrector_Translation

class mpacts.commands.time_evolution.integration.GearsCorrector_Translation

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

Time integration by using Gears’ Predictor Corrector method of order 4.
Default location: ‘loop_cmds/integration_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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep]
GearsCorrector_Translation(name, parent, **kwargs)

GearsPredictor_Translation

class mpacts.commands.time_evolution.integration.GearsPredictor_Translation

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

Time integration by using Gears’ Predictor Corrector method of order 4.
Default location: ‘loop_cmds/integration_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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep]
GearsPredictor_Translation(name, parent, **kwargs)

LeapFrog_Rotation

class mpacts.commands.time_evolution.integration.LeapFrog_Rotation

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

Time integration
Default location: ‘loop_cmds/integration_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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep]
LeapFrog_Rotation(name, parent, **kwargs)

LeapFrog_Translation

class mpacts.commands.time_evolution.integration.LeapFrog_Translation

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

Time integration
Default location: ‘loop_cmds/integration_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.
    • timestep (default value = 0) — timestep used by this time integration command
object __init__(tuple args, dict kwds) :
args: name, parent kwds: pc, [gate, predicate, timestep]
LeapFrog_Translation(name, parent, **kwargs)

SteppingForwardEuler

class mpacts.commands.time_evolution.integration.SteppingForwardEuler

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

Integration of arrays ‘x’ and ‘dx’ using a user-given array with ‘Scalar’ type steps.
Default location: ‘loop_cmds/pre_body_force_cmds’
  • Required keywords:
    • dx — The value ‘dx’ (usually unit vector) that gets integrated as dest = x + step*dx
    • pc — Particle container on which the command is applied
    • step — The (always Scalar) step size
    • x — The value ‘x’ that needs to be integrated as dest = x+ step*dx
  • Optional keywords:
    • dest (default value = None) — Destination arrray. If not given, ‘x’ will simply be used. Must be same type as x
    • 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, x, dx, step, [gate, predicate, dest]
SteppingForwardEuler(name, parent, **kwargs)