Component Usage
SimBiology® lets you find species, parameters, and compartments that are not used in a model. You can also query how a particular quantity is used by other expressions such as a parameter being used as a reaction rate constant or species being used in an event.
From the command line, use the findUnusedComponents
function to look for unused model components and
the findUsages
function to see how a
component is used in expressions. If you are using the SimBiology Model Builder app, in the
Browser pane, expand Model Assessment
Tools. Then click Unused to see a list of unused
quantities. To look for usages of a quantity, click the quantity block in the diagram or
in the browser table. Then in the Property Editor pane, look at the
Usages section.
Species Usage
A species is used when it is referenced in any of the following properties of other components:
The Reaction or ReactionRate property of a
Reaction object
,The ParameterVariableNames or SpeciesVariableNames property of a
KineticLaw object
,The
Rule
property of aRule object
,The Trigger or EventFcns property of an
Event object
,The
Expression
property of anobservable
object, andThe
TargetName
property of aScheduleDose object
orRepeatDose object
.
Use the object method findUsages
to find out how a
species is used.
Parameter Usage
A parameter is used when it is referenced in any of the following properties of other components:
The ReactionRate property of a
Reaction object
,The ParameterVariableNames property of a
KineticLaw object
,The
Rule
property of aRule object
,The Trigger or EventFcns property of an
Event object
,The
Expression
property of anobservable
object,The
Content
property of aVariant object
, andThe
DurationParameterName
orLagParameterName
property of aScheduleDose object
orRepeatDose object
.The
Amount
,Rate
,Interval
,StartTime
, orRepeatCount
property of aSimBiology.RepeatDose
object.
Use the object method findUsages
to find out how a
parameter is used.
Compartment Usage
A compartment is used when it is referenced in any of the following properties of other components:
The
Parent
property of aSpecies object
,The
Owner
property of aCompartment object
,The ReactionRate property of a
Reaction object
,The ParameterVariableNames property of a
KineticLaw object
,The
Rule
property of aRule object
,The Trigger or EventFcns property of an
Event object
,The
Expression
property of anobservable
object, andThe
Content
property of aVariant object
.
Use the object method findUsages
to find out how a
compartment is used.
Observable Usage
An observable object is used when it is referenced in the
Expression
property of another observable.
Use the object method findUsages
to find out how an observable object is used.
Unit and UnitPrefix Usage
A unit or unit prefix is used when it is referenced in any of the following properties of other components:
The
Composition
property of all units in theBuiltInLibrary
andUserDefinedLibrary
,The
Units
property of a species, compartment, parameter, or observable object in the specified models,The
TimeUnits
property of all specified dosesdoses,The
AmountUnits
property of all specified doses, andThe
RateUnits
property of all specified doses.
Use the object method findUsages
to find out how a
Unit
or UnitPrefix
object is used.
Abstract Kinetic Law Usage
An abstract kinetic law object aklObj can only be used by a
Reaction object
robj. It is used when:
The KineticLaw property of the reaction object is not empty, and
robj.KineticLaw.KineticLawName
matches the name of the abstract kinetic lawaklObj.Name
.
Use the object method findUsages
to find out how an
AbstractKineticLaw
object is used.