Class SingleSpringSim

Simulation of a spring-mass system. One end of the spring is fixed, the other end has the mass attached.

Variables and Parameters

Variables:

x = position of mass, stored in vars[0]
v = x' = velocity of mass, stored in vars[1]
L = x - x_0 = current length of spring
L - R = how much spring is stretched from rest length

Parameters:

x_0 = fixed point of spring
R = rest length of spring
k = spring constant
b = damping constant

The fixed point is set to a location such that the mass is at position x=0 when the spring is at its rest length. This makes the simulation match the differential equations shown in the corresponding web page on the myPhysicsLab website. When spring rest length changes, we move the fixed point so that the resting position is still x=0.

Equations of Motion

See also https://www.myphysicslab.com/spring1.html.

The spring force is -k (L - R). Damping force is - b v.

F = -k (L- R) - b v
F = -k (x - x_0 - R) - b V
F = m a = m v'
-k (x - x_0 - R) - b v = m v'

The equations of motion are:

x' = v
v' = -(k/m)(x - x_0 - R) -(b/m)v

Work from Damping

The work from damping is stored in vars[3]. We intergrate the work done by damping as follows:

dW = F dR  (work = force times distance)

divide by dt

dW/dt = F dR/dt = F v

Since the damping force is F = -b v we have

dW/dt = -b v^2.

Note that initWork method should be called if initial conditions are modified.

TO DO: bring back the display of the work from damping in DisplayEnergy, as in Java version.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

initialState_ potentialOffset_

Methods

addObserver addParameter broadcast broadcastParameter evaluate finishDrag getBroadcast getClassName getEnergyInfo getName getObservers getPEOffset getParameter getParameterBoolean getParameterNumber getParameterString getParameters getSimList getTime getVarsList handleKeyEvent initWork modifyObjects mouseDrag removeObserver removeParameter reset restoreState saveInitialState saveState setBroadcast setPEOffset setTerminal setVarsList startDrag toString toStringShort

Constructors

constructor

Properties

Protected initialState_

initialState_: null | number[] = null

Initial values.

Private potentialOffset_

potentialOffset_: number = 0

potential energy offset

Methods

addObserver

  • addObserver(observer): void

  • Adds the given Observer to this Subject's list of Observers, so that the Observer will be notified of changes in this Subject. An Observer may call Subject.addObserver during its observe method.

    Parameters

    Returns void

addParameter

broadcast

broadcastParameter

evaluate

  • evaluate(vars, change, _timeStep): null | object

  • Defines the differential equations of this ODESim; for an input set of variables, returns the current rate of change for each variable (the first derivative of each variable with respect to time).

    The timeStep is the time since the state variables were last fully calculated, which can be and often is zero. The current time can be regarded as getTime() + timeStep. The input variables correspond to the Simulation state at that time. Note that timeStep is different from the time step used to advance the Simulation (as in AdvanceStrategy.advance). The timeStep is typically used when finding collisions in CollisionSim.findCollisions.

    Parameters

    • vars: number[]

      the current array of state variables (input), corresponding to the state at getTime() + timeStep

    • change: number[]

      array of change rates for each variable (output), all values are zero on entry.

    • _timeStep: number

      the current time step (might be zero)

    Returns null | object

    null if the evaluation succeeds, otherwise an object relating to the error that occurred. The change array contains the output results.

finishDrag

  • finishDrag(_simObject, _location, _offset): void

  • Called at the end of a mouse drag operation, performs whatever action is appropriate. Only called if startDrag returned true.

    Parameters

    • _simObject: null | SimObject

      the SimObject being dragged, or null if no SimObject was found

    • _location: Vector

      the location of the mouse in simulation coordinates of the SimView where simObject was found, or in the focus view if simObject is null.

    • _offset: Vector

      distance from the initial object position to the mouse location at start of drag.

    Returns void

Protected getBroadcast

getClassName

getEnergyInfo

getName

getObservers

getPEOffset

getParameter

getParameterBoolean

getParameterNumber

getParameterString

getParameters

getSimList

getTime

getVarsList

handleKeyEvent

  • handleKeyEvent(_evt, _pressed, _modifiers): void

  • Called when a key is pressed or released, performs whatever action is appropriate for that event.

    Parameters

    • _evt: KeyboardEvent

      the KeyboardEvent that happened

    • _pressed: boolean

      true means this is a key-down event; false means a key-up event

    • _modifiers: ModifierKeys

      the modifier keys down during event

    Returns void

initWork

  • initWork(): void

  • Initializes the energy calculations, including the 'work from damping' variable; this should be called after changing the initial conditions of the simulation.

    Returns void

modifyObjects

mouseDrag

  • mouseDrag(simObject, location, offset): void

  • Called at each movement during a mouse drag, performs whatever action is appropriate. Only called if startDrag returned true. The SimObject being moved is passed in, along with the current mouse position, in simulation coordinates, and an offset calculated at the start of the drag.

    Setting the SimObject position to (x - offsetX, y - offsetY) will move the SimObject smoothly along with the mouse movement.

    Parameters

    • simObject: null | SimObject

      the SimObject being dragged, or null if no SimObject was found

    • location: Vector

      the location of the mouse in simulation coordinates of the SimView where simObject was found, or in the focus view if simObject is null.

    • offset: Vector

      distance from the initial object position (from DisplayObject.getPosition) to the mouse location at start of drag.

    Returns void

removeObserver

removeParameter

reset

restoreState

saveInitialState

saveState

Protected setBroadcast

  • setBroadcast(value): boolean

  • Sets whether this Subject will broadcast events, typically used to temporarily disable broadcasting. Intended to be used in situations where a subclass overrides a method that broadcasts an event. This allows the subclass to prevent the superclass broadcasting that event, so that the subclass can broadcast the event when the method is completed.

    Parameters

    • value: boolean

      whether this Subject should broadcast events

    Returns boolean

    the previous value

setPEOffset

setTerminal

Protected setVarsList

startDrag

  • startDrag(simObject, _location, _offset, _dragBody, _modifiers): boolean

  • Called at the start of a mouse drag. The nearest dragable SimObject is passed in, along with mouse position in simulation coordinates. If no dragable SimObject was found, null is passed for the first argument. If the EventHandler does not recognize the SimObject then it should return false.

    Parameters

    • simObject: null | SimObject

      the SimObject that is nearest to the mouse drag coordinates, or null if no SimObject was found

    • _location: Vector

      the location of the mouse in simulation coordinates of the SimView where simObject was found, or in the focus view if simObject is null.

    • _offset: Vector

      distance from the initial object position (from DisplayObject.getPosition) to the mouse location at start of drag

    • _dragBody: null | Vector

      location of 'drag point' on the SimObject in body coordinates of the SimObject; this is where for example a spring will be attached on the SimObject when dragging; or null when no SimObject was found

    • _modifiers: ModifierKeys

      the modifier keys down during event

    Returns boolean

    true if the EventHandler will handle dragging the SimObject

toString

toStringShort

  • toStringShort(): string

  • Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

    For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:

    DisplayShape{polygon:Polygon{'chain3'}}

    Returns string

    a minimal string representation of this object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc