August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year, primarily targeted around Python 3 and ecosystem compatibility. PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)

Kamaelia.Support.Particles.SimpleLaws

Simple Particle Physics Laws

A class implementing laws for interactions between particles in discrete time simulations. Can be used with the physics ParticleSystem class. Laws are based on the inverse square law.

Different laws are applied for 'bonded' and 'unbonded' particles. Unbonded particles repel. Repulsion and attraction forces balance for bonded particles at a specified "bond length".

There are a range of parameters that can be set at initialisation. All have sensible defaults.

Example usage

Laws for particles that bond at a distance of 200 units:

>>> laws = SimpleLaws(bondLength=200)
>>> laws.bonded("","", 200, 200**2)
0.0
>>> laws.bonded("","", 210, 210**2)
2.0
>>> laws.bonded("","", 195, 195**2)
1.0

Laws for particles that decelerate fast:

>>> laws = SimpleLaws(damp=0.5)
>>> velocity = [10.0, 5.0]
>>> laws.dampening("", velocity)
[5.0, 2.5]

Laws for particles that don't repel much but bond extra strongly:

>>> laws = SimpleLaws(repulsionStrength = 1.0, maxBondForce = 40.0)
>>> laws.unbonded("","", 50, 50**2)
-4.0
>>> laws.bonded("","", 50, 50**2)
-20.0

The physics model used

Instances of this class provide methods for calculating the force that acts between a pair of particles when bonded or unbonded. It can also calculate any reduction in velocity due to 'friction'.

Repulsion forces are calculated using the inverse square law (1 / distance squared).

Bonding attraction and repulsion forces are calculated using Hook's law for springs. However a cut-off is applied so the force is never greater than when the bond is stretched to twice its resting length.

There are also other cut-offs (described below) to help prevent a simulation becoming unstable, and to help speed up simulation.

How does it work?

You specify arguments to control the strengths of bonding and repulsion (unbonded) forces and the distances they act over.

You can also specify friction and cutoffs for maximum and minimum velocities. These latter arguments are 'fudge factors' that you can use to help stop a system spiralling out of control. Note that in a discrete time simulation, if particle velocities/accelerations are too great the simulation can become unstable and particles will fly everywhere!

You may also specify a 'maximum interaction radius' - the distance at which, for unbonded particles, a simulator need not bother calculating the forces acting (because they are too small to worry about). This is to allow simulators to run faster by reducing the number of calculations performed per cycle.

For unspecified arguments, their defaults are scaled appropriately for the bondLength you specify, such that behaviour will appear unchanged, just at a different scaling.


Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT