addrule

Add rule object to model

Syntax

ruleObj = addrule(modelObj,ruleExpression)

ruleObj = addrule(modelObj,ruleExpression,ruleType)

ruleObj = addrule(___,Name=Value)

Description

ruleObj = addrule(modelObj,ruleExpression) creates a rule object ruleObj and adds the object to the SimBiology^® model object modelObj. The function also assigns

• ruleExpression to the Rule property of ruleObj.

• modelObj to the Parent property of ruleObj.

• 'initialAssignment' to the RuleType property for all assignment rules and 'algebraic' for all other rules.

To apply the rule in your simulation, set the Active property of ruleObj to true.

ruleObj = addrule(modelObj,ruleExpression,ruleType) also specifies the type of rule to create and add to the model. For more information on the types of rules, see Definitions and Evaluations of Rules in SimBiology Models.

ruleObj = addrule(___,Name=Value) also sets the properties of the rule object using one or more name-value arguments. Name is the property name and Value is the corresponding value.

Examples

Create and Add Rules to SimBiology Model

Create a SimBiology model.

m1 = sbiomodel("m1");
r1 = addreaction(m1,"A -> B")

r1 = 
   SimBiology Reaction Array

   Index:    Reaction:
   1         A -> B   

Create a rule that sets the initial values of species.

rule1 = addrule(m1,"A = 0.1")

rule1 = 
   SimBiology Rule Array

   Index:    RuleType:            Rule:  
   1         initialAssignment    A = 0.1

rule2 = addrule(m1,"B = 0.2")

rule2 = 
   SimBiology Rule Array

   Index:    RuleType:            Rule:  
   1         initialAssignment    B = 0.2

Add a rule which defines that the quantity of a species c. In the rule expression, k is the rate constant for a -> b.

rule3 = addrule(m1,'c = k*(a+b)')

rule3 = 
   SimBiology Rule Array

   Index:    RuleType:            Rule:      
   1         initialAssignment    c = k*(a+b)

Change the RuleType from default (initialAssignment') to 'rate'.

rule3.RuleType = "rate"

rule3 = 
   SimBiology Rule Array

   Index:    RuleType:    Rule:      
   1         rate         c = k*(a+b)

Use the get command to see the object properties.

get(rule3)

ans = struct with fields:
        Rule: 'c = k*(a+b)'
    RuleType: 'rate'
      Active: 1
        Name: 'Rule_3'
      Parent: [1x1 SimBiology.Model]
       Notes: ''
         Tag: ''
        Type: 'rule'
    UserData: []

Input Arguments

modelObj — SimBiology model

Model object

SimBiology model, specified as a Model object.

ruleExpression — Rule expression

character vector | string scalar

Rule expression, specified as a character vector or string scalar.

Data Types: char | string

ruleType — Type of rule

"initialAssignment" | "repeatedAssignment" | "rate" | 'algebraic'

Type of the rule to be added, specified as "initialAssignment", "repeatedAssignment", "rate", or "algebraic". By default, the function uses "initialAssignment" for all assignment rules and "algebraic" for all other rules.

For more information on the types of rules, see Definitions and Evaluations of Rules in SimBiology Models.

Data Types: char | string

Output Arguments

ruleObj — Added rule

SimBiology.Rule

Added rule, returned as a Rule object.

Version History

Introduced in R2006a

R2024a: Having duplicate model component names is no longer allowed

• When you load a model that contains duplicate names, SimBiology automatically updates those names. SimBiology disambiguates the duplicate names by adding a suffix "_N", where N is the first positive integer that results in a unique name. If there is an existing suffix, N will be incremented from that suffix. For example, if there are two model components named x_3, the function updates one of the names to x_4. If the existing suffix has leading zeros, the function omits the zeros in the new name. For instance, if x_003 is a duplicate name, it gets renamed to x_4. However, the function assumes that names with leading zeros and without leading zeros are different. For instance, x_005 and x_5 are considered to be different names.

• SimBiology issues an error if multiple model components (model, compartment, species, parameter, reaction, rule, event, observable, dose, and variant) have the same name. Within a single model, these components are required to have unique names even when they are of different types with the following two exceptions:

  • Species in different compartments can have the same name.

  • Parameters can have the same name if they are scoped to different parents. Specifically, you can use the same name for a model-scoped parameter and reaction-scoped parameters, where each reaction-scoped parameter belongs to a different reaction.

  For details on how to reference model component names in expressions, see Guidelines for Referencing Names in Expressions.

R2022b: Having duplicate model component names issues a warning

SimBiology issues a warning if multiple model components have the same name.

R2022a: Having duplicate model component names will not be allowed in a future release

SimBiology will not allow you to have duplicate names for model components within a model.