Interface OdinModelBase

Common interface for all odin models

Hierarchy

OdinModelBase
- OdinModelODE
- OdinModelDDE

Index

Methods

getInternal getMetadata initial names setUser

Methods

getInternal

getInternal(): InternalStorage
Return the state of the internal storage - odin uses this for debugging and testing.

Returns InternalStorage

getMetadata

getMetadata(): any
Return metadata about the model - odin uses this internally.

Returns any

initial

initial(t: number): number[]
Get initial conditions from the model
Parameters
- t: number
  
  The time to compute initial conditions at
Returns number[]

names

names(): string[]
Return a vector of names of variables

Returns string[]

setUser

setUser(pars: UserType, unusedUserAction: string): void
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

Generated using TypeDoc