Interface OdinModelODE

The interface that odin ordinary differential equation (ODE) models will match, though they will be generated in plain JavaScript and not TypeScript.

Hierarchy

Methods

getInternal getMetadata initial names output rhs setUser

Methods

getInternal

getMetadata

  • Return metadata about the model - odin uses this internally.

    Returns any

initial

  • Get initial conditions from the model

    Parameters

    • t: number

      The time to compute initial conditions at

    Returns number[]

names

  • Return a vector of names of variables

    Returns string[]

Optional output

  • Compute additional quantities that are derived from the variables. Unlike rhs, this returns a vector rather than writing in place. Not all models include an output method - these models have no output.

    Parameters

    • t: number

      The time to compute output at

    • y: number[]

      The value of the variables

    Returns number[]

rhs

  • Compute the derivatives

    Parameters

    • t: number

      The time to compute initial conditions at

    • y: number[]

      The value of the variables

    • dydt: number[]

      An array that will be written into, will hold derivatives on exit. Must be the same length as y

    Returns void

setUser

  • Set parameters into an existing model.

    Parameters

    • pars: UserType

      New parameters for the model. Values are are omitted here but present in the model will be unchanged.

    • unusedUserAction: string

      String, describing the action to take if there are unknown values in pars - possible values are "error", "ignore", "warning" and "message"

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc