SimBiology.export.Model

Exported SimBiology model object

Description

Exported SimBiology^® models are limited-access models that can be simulated and accelerated. You can speedup simulation of exported models using Parallel Computing Toolbox™, and deploy exported models using MATLAB^® Compiler™.

By default, all active dose objects, species, parameters, and compartments export with a SimBiology model, and are editable in the exported model object. You can limit which doses, species, parameters, and compartments are editable using additional options during export. Reactions, rules, and events are never editable in an exported model.

Creation

Use the export function to export a SimBiology model.

Properties

DependentFiles — Function files the model depends on

cell array of character vectors

This property is read-only.

Function files the model depends on, specified as a cell array of character vectors.

ExportNotes — Text with additional information

character vector

This property is read-only.

Text with additional information associated with the exported model, specified as a character vector.

ExportTime — Creation time of the exported model

character vector

This property is read-only.

Creation time of the exported model, specified as a character vector.

InitialValues — Initial values for modifiable species, compartments, and parameters

vector of values

Initial values for modifiable species, compartments, and parameters, specified as a vector of values.

Name — Name of the exported model

character vector

This property is read-only.

Name of the exported model, specified as a character vector.

Notes — HTML text describing the exported model object

character vector

This property is read-only.

HTML text describing the exported model object, specified as a character vector.

SimulationOptions — Simulation options

SimBiology.export.SimulationOptions object

Simulation options, specified as a SimBiology.export.SimulationOptions object.

ValueInfo — Modifiable value components

array of SimBiology.export.ValueInfo objects

Modifiable value components, specified as an array of SimBiology.export.ValueInfo objects of modifiable species, parameters, and compartments.

Object Functions

accelerate	Prepare exported SimBiology model for acceleration
getIndex	Get indices into ValueInfo and InitialValues properties
getdose	Return exported SimBiology model dose object
isAccelerated	Determine whether an exported SimBiology model is accelerated
simulate	Simulate exported SimBiology model

Examples

Export SimBiology Model Object

Load a sample SimBiology model object, and export.

modelObj = sbmlimport('lotka');
em = export(modelObj)

em = 
  Model with properties:

           Name: 'lotka'
     ExportTime: '05-Sep-2024 14:10:36'
    ExportNotes: ''

Display the editable values (compartments, species, and parameters) information.

em.ValueInfo

ans=8×1 ValueInfo array with properties:
    Constant
    InitialValue
    Name
    Parent
    QualifiedName
    Tag
    Type
    Units

There are 8 editable values. Display the names of the editable values.

{em.ValueInfo.Name}

ans = 1x8 cell
    {'unnamed'}    {'x'}    {'y1'}    {'y2'}    {'z'}    {'c1'}    {'c2'}    {'c3'}

Display the exported model simulation options.

em.SimulationOptions

ans = 
  ODESimulationOptions with properties:

            AbsoluteTolerance: 1.0000e-06
     AbsoluteToleranceScaling: 1
    AbsoluteToleranceStepSize: [0x1 double]
                      MaxStep: [0x1 double]
                  OutputTimes: [0x1 double]
            RelativeTolerance: 1.0000e-03
                   SolverType: 'ode15s'
          MaximumNumberOfLogs: Inf
             MaximumWallClock: Inf
                     StopTime: 10
                    TimeUnits: 'second'

Version History

Introduced in R2012b