Main Content

Configset object

Solver settings information for model simulation


The SimBiology® configset object, also known as the configuration set object, contains the options that the solver uses during simulation of the model object. The configuration set object contains the following options for you to choose:

  • Type of solver

  • Stop time for the simulation

  • Solver error tolerances, and for ode solvers — the maximum time step the solver should take

  • Whether to perform sensitivity analysis during simulation

  • Whether to perform dimensional analysis and unit conversion during simulation

  • Species and parameter input factors for sensitivity analysis

A SimBiology model can contain multiple configsets with one being active at any given time. The active configset contains the settings that are used during the simulation. Use the method setactiveconfigset to define the active configset. Use the method getconfigset to return a list of configsets contained by a model. Use the method addconfigset to add a new configset to a model.


The Active property of the configset object will be removed in a future release. Explicitly specify a configset object as an input argument when you simulate a model using sbiosimulate.

See Property Summary for links to configset object property reference pages.

Properties define the characteristics of an object. Use the get and set commands to list object properties and change their values at the command line. You can graphically change object properties in the SimBiology desktop.

Constructor Summary

addconfigset (model)Create configuration set object and add to model object

Method Summary

copyobjCopy SimBiology object and its children
deleteDelete SimBiology object
displayDisplay summary of SimBiology object
getGet SimBiology object properties
setSet SimBiology object properties

Property Summary

ActiveIndicate object in use during simulation
AmountUnitsAmount unit used internally during simulation when UnitConversion is on
CompileOptionsDimensional analysis and unit conversion options
MassUnitsMass unit used internally during simulation when UnitConversion is on
MaximumNumberOfLogsMaximum number of logs criteria to stop simulation
MaximumWallClockMaximum elapsed wall clock time to stop simulation
NameSpecify name of object
NotesHTML text describing SimBiology object
RuntimeOptionsOptions for logged species
SensitivityAnalysisOptionsSpecify sensitivity analysis options
SolverTypeSelect solver type for simulation
StopTimeSimulation time criteria to stop simulation
TimeUnitsShow time units for dosing and simulation
TypeDisplay SimBiology object type

Version History

Introduced in R2006b