ValueUnits

Parameter value units

Description

The ValueUnits property indicates the unit definition of the parameter object Value property. ValueUnits can be one of the built-in units. To get a list of the built-in units, use the sbioshowunits function. If ValueUnits changes from one unit definition to another, the Value does not automatically convert to the new units. The sbioconvertunits function does this conversion.

You can add a parameter object to a model object or a kinetic law object.

Characteristics

Applies toObject: parameter
Data typechar string
Data valuesUnit from units library. Default is '' (empty string). Note that the default value of an empty string means unspecified. Unspecified units are permitted during dimensional analysis, but not during unit conversion. (Use the string 'dimensionless' to specify dimensionless units.)
AccessRead/write

    Note:   SimBiology® uses unit strings including empty units in association with DimensionalAnalysis and UnitConversion features.

    • When DimensionalAnalysis and UnitConversion are both false, unit strings are not used. However, SimBiology still performs a minimum level of dimensional analysis to decide whether a reaction rate is in dimensions of amount/time or concentration/time.

    • When DimensionalAnalysis is true and UnitConversion is false, units (if not empty) must have consistent dimensions so that SimBiology can perform dimensional analysis. However, the units are not converted.

    • When UnitConversion is set to true (which requires DimensionalAnalysis to be true), SimBiology performs a dimensional analysis and converts everything to consistent units. Hence, you must specify consistent units, and no unit strings can be empty. If you have a dimensionless parameter, you must still set its unit string to dimensionless.

Examples

Assign a parameter with a value to the model object.

  1. Create a model object, and then add a reaction object.

    modelObj = sbiomodel('my_model');
    
  2. Add a parameter with Value 0.5, and assign it to the model object (modelObj).

    parameterObj1 = addparameter(modelObj, 'K1', 0.5, 'ValueUnits', '1/second')
    

    MATLAB® returns:

    SimBiology Parameter Array
    
    Index:    Name:    Value:    ValueUnits:
     1         K1       0.5       1/second
Was this topic helpful?