SolverOptions
Specify model solver options
Description
The SolverOptions
property is an object that
holds the model solver options in the configset
object.
Changing the property SolverType
changes the options
specified in the SolverOptions
object.
Properties of SolverOptions
are summarized
in Property Summary.
Property Summary
AbsoluteTolerance | Absolute error tolerance applied to state value during simulation |
AbsoluteToleranceScaling | Control scaling of absolute error tolerance during simulation |
AbsoluteToleranceStepSize | Initial guess for time step size for scaling of absolute error tolerance |
ErrorTolerance | Specify explicit or implicit tau error tolerance |
LogDecimation | Specify frequency to log stochastic simulation output |
MaxIterations | Specify nonlinear solver maximum iterations in implicit tau |
MaxStep | Specify upper bound on ODE solver step size |
OutputTimes | Specify times to log deterministic simulation output |
RandomState | Set random number generator |
RelativeTolerance | Allowable error tolerance relative to state value during a simulation |
SensitivityAnalysis | Enable or disable sensitivity analysis |
Type | Display SimBiology object type |
Characteristics
Applies to | Object: configset |
Data type | Object |
Data values | Solver options depending on SolverType .
Default is SolverOptions for default SolverType (ode15s ). |
Access | Read-only |
Examples
This example shows the changes in SolverOptions
for
various SolverType
settings.
Retrieve the
configset
object from themodelObj
.modelObj = sbiomodel('cell'); configsetObj = getconfigset(modelObj);
Configure the
SolverType
toode45
.set(configsetObj, 'SolverType', 'ode45'); get(configsetObj, 'SolverOptions') Solver Settings: (ode) AbsoluteTolerance: 1.000000e-006 RelativeTolerance: 1.000000e-003
Configure the
SolverType
tossa
.set(configsetObj, 'SolverType', 'ssa'); get(configsetObj, 'SolverOptions') Solver Settings: (ssa) LogDecimation: 1 RandomState: []
Configure the
SolverType
toimpltau
.set(configsetObj, 'SolverType', 'impltau'); get(configsetObj, 'SolverOptions') Solver Settings: (impltau) ErrorTolerance: 3.000000e-002 LogDecimation: 1 AbsoluteTolerance: 1.000000e-002 RelativeTolerance: 1.000000e-002 MaxIterations: 15 RandomState: []
Configure the
SolverType
toexpltau
.set(configsetObj, 'SolverType', 'expltau'); get(configsetObj, 'SolverOptions') Solver Settings: (expltau) ErrorTolerance: 3.000000e-002 LogDecimation: 1 RandomState: []