Documentation

addconfigset (model)

Create configuration set object and add to model object

Syntax

configsetObj = addconfigset(modelObj, 'NameValue')

configsetObj = addconfigset(..., 'PropertyName', PropertyValue, ...)

Arguments

modelObjModel object. Enter a variable name.
NameValueDescriptive name for a configuration set object. Reserved words 'active' and 'default' are not allowed.
configsetObjConfiguration set object.

Description

configsetObj = addconfigset(modelObj, 'NameValue') creates a configuration set object and returns to configsetObj.

In the configuration set object, this method assigns a value (NameValue) to the property Name.


configsetObj = addconfigset(..., 'PropertyName', PropertyValue, ...)
constructs a configuration set object, configsetObj, and configures configsetObj with property value pairs. The configsetObj properties are listed in Property Summary.

A configuration set stores simulation specific information. A model object can contain multiple configuration sets, with one being active at any given time. The active configuration set contains the settings that are used during a simulation. configsetObj is not automatically set to active. Use the function setactiveconfigset to define the active configset for modelObj.

Use the method copyobj to copy a configset object and add it to the modelObj.

Method Summary

Methods for configuration set objects

copyobj (any object)Copy SimBiology object and its children
delete (any object)Delete SimBiology object
display (any object)Display summary of SimBiology object
set (any object)Set object properties

Property Summary

Properties for configuration set objects

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
SolverOptionsSpecify model solver options
SolverTypeSelect solver type for simulation
StopTimeSimulation time criteria to stop simulation
TimeUnitsShow time units for dosing and simulation
TypeDisplay SimBiology object type

Add a Configuration Set Object

This example shows how to add a configset object to a SimBiology model and set it up for simulation.

Load the sample radiodecay model m1, and add a Configset object to the model.

sbioloadproject radiodecay;
configsetObj = addconfigset(m1, 'myset');

Configure the simulation stop criteria by setting the StopTime property.

configsetObj.StopTime = 15;

Set the configset object to be active so that its settings are used during simulation.

setactiveconfigset(m1,configsetObj);

Simulate the model and plot results.

simdata = sbiosimulate(m1);
sbioplot(simdata);

Was this topic helpful?