Interface ODESim

A Simulation based on ordinary differential equations. Contains an array of variables given by getVarsList which holds the simulation state and an evaluate method that defines the differential equation. A DiffEqSolver can act on the ODESim to advance the variables over time.

Note that the VarsList returned by getVarsList method is implicitly a significant part of the API of ODESim. For example: initial conditions are set by modifying the values stored in the VarsList.

Time is stored in the VarsList. When the simulation state is advanced, the time is advanced by the DiffEqSolver like any other variable. The time variable always has a rate of change of exactly 1.0, which is specified in the evaluate method.

interface ODESim {
    addObserver(observer): void;
    broadcast(evt): void;
    broadcastParameter(name): void;
    evaluate(vars, change, timeStep): null | object;
    getName(): string;
    getObservers(): Observer[];
    getParameter(name): Parameter;
    getParameterBoolean(name): ParameterBoolean;
    getParameterNumber(name): ParameterNumber;
    getParameterString(name): ParameterString;
    getParameters(): Parameter[];
    getSimList(): SimList;
    getTime(): number;
    getVarsList(): VarsList;
    modifyObjects(): void;
    removeObserver(observer): void;
    reset(): void;
    restoreState(): void;
    saveInitialState(): void;
    saveState(): void;
    setTerminal(terminal): void;
    toStringShort(): string;
}

Hierarchy (view full)

Implemented by

Methods

addObserver broadcast broadcastParameter evaluate getName getObservers getParameter getParameterBoolean getParameterNumber getParameterString getParameters getSimList getTime getVarsList modifyObjects removeObserver reset restoreState saveInitialState saveState setTerminal toStringShort

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

broadcast

broadcastParameter

  • broadcastParameter(name): void

  • Notifies all Observers that the Parameter with the given name has changed by calling observe on each Observer.

    Parameters

    • name: string

      the language-independent or English name of the Parameter that has changed

    Returns void

    Throws

    if there is no Parameter with the given name

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.

getName

  • getName(): string

  • Return the language-independent name of this Subject for scripting purposes.

    Returns string

    name the language-independent name of this Subject

getObservers

getParameter

  • getParameter(name): Parameter

  • Returns the Parameter with the given name.

    Parameters

    • name: string

      the language-independent or English name of the Parameter

    Returns Parameter

    the Parameter with the given name

    Throws

    if there is no Parameter with the given name

getParameterBoolean

getParameterNumber

getParameterString

getParameters

getSimList

getTime

  • getTime(): number

  • Returns the current Simulation time.

    Returns number

    the current Simulation time.

    Throws

    if there is no time variable for the simulation

getVarsList

  • getVarsList(): VarsList

  • Returns the VarsList that represents the current state of this Simulation.

    Returns VarsList

    the VarsList that represents the current state of this Simulation

modifyObjects

removeObserver

  • removeObserver(observer): void

  • Removes the Observer from this Subject's list of Observers. An Observer may call removeObserver during its observe method.

    Parameters

    • observer: Observer

      the Observer to detach from list of Observers

    Returns void

reset

restoreState

saveInitialState

saveState

  • saveState(): void

  • Saves the current state of the Simulation, so that we can back up to this state later on. The state is defined mainly by the set of Simulation variables, see getVarsList, but can include other data. This state is typically used for collision detection as the before collision state, see CollisionSim.findCollisions.

    Returns void

setTerminal

  • setTerminal(terminal): void

  • Sets the Terminal object that this simulation can print data into.

    Parameters

    • terminal: null | Terminal

      the Terminal object that this simulation can print data into.

    Returns void

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