SimBiology.export.ODESimulationOptions class

Superclasses: SimBiology.export.SimulationOptions

Settings for deterministic, ordinary differential equation simulation of exported SimBiology model

Description

SimBiology.export.ODESimulationOptions is the class of simulation options associated with determinist, ordinary differential equation (ODE) solvers.

Construction

Deterministic simulation options are created by the export method for SimBiology® models with a deterministic SolverType (for example, sundials or ode15s).

export (model)Export SimBiology models for deployment and standalone applications

Properties

AbsoluteTolerance

Absolute error tolerance applied to state value during simulation, a positive scalar value.

AbsoluteToleranceScaling

Control scaling of absolute error tolerance, a logical value.

AbsoluteToleranceStepSize

Initial guess for time step size for scaling of absolute error tolerance, [] or a scalar value.

MaximumNumberofLogs

Maximum number of logs criterion to stop simulation, a positive scalar value.

MaximumWallClock

Maximum elapsed wall clock time criterion to stop simulation, a positive scalar value.

MaxStep

Upper bound on ODE solver step size, [] or a positive scalar value.

OutputTimes

Times to log in simulation output, a vector of sorted nonnegative values.

RelativeTolerance

Allowable error tolerance relative to state value during simulation, a scalar value in the range (0,1).

SolverType

Character vector indicating solver type to use for simulation. Possible deterministic solver types are:

  • 'sundials'

  • 'ode15s'

  • 'ode23t'

  • 'ode45'

StopTime

Simulation time criterion to stop simulation, a nonnegative scalar value.

TimeUnits

Time units for simulation. This property is read only.

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.