Interface DustModel

The interface that dust models conform to

Hierarchy

  • DustModel

Methods

getInternal info initial size update

Methods

getInternal

  • getInternal(): InternalStorage

  • Return the state of the internal storage - odin uses this for debugging and testing.

    Returns InternalStorage

info

  • Return information about how variables are packed into the state vector

    Returns DustModelInfo

initial

  • initial(step: number): number[]

  • Compute initial conditions

    Parameters

    • step: number

      Step to compute initial conditions at

    Returns number[]

size

  • size(): number

  • Length of the state variables for this model

    Returns number

update

  • update(step: number, y: readonly number[], yNext: number[], random: Random): void

  • The workhorse function, defining how the state is transformed at step step from y to yNext

    Parameters

    • step: number

      The step number

    • y: readonly number[]

      The initial state

    • yNext: number[]

      The state at the end of the step, will be updated in-place

    • random: Random

      The random state, used for any stochastic updates

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc