DefaultSpeciesDimension

Dimension of species name in expression

Description

The DefaultSpeciesDimension property specifies how SimBiology® interprets species names in expressions (namely reaction rate, rule, or event expressions). The valid property values are substance or concentration. If you specify InitialAmountUnits, SimBiology interprets species names appearing in expressions as concentration or substance amount according to the units specified, regardless of the value in DefaultSpeciesDimension. Thus, if DefaultSpeciesDimension is concentration and you specify species units as molecule, SimBiology interprets species names in expressions as substance. This interpretation applies even when DimensionalAnalysis is off.

You can find DefaultSpeciesDimension in the CompileOptions property.

When you set DefaultSpeciesDimension to substance, if you do not specify units, SimBiology interprets species names appearing in expressions as substance amounts, and does not scale by compartment capacity. To include a species concentration in an expression, divide by the appropriate compartment capacity in the expression. To specify compartment capacity in an expression enter the compartment name.

When you set DefaultSpeciesDimension to concentration, SimBiology interprets species names appearing in expressions as concentrations, and scales by compartment capacity in the expressions. To include a species amount in an expression, multiply by the species name by the appropriate compartment name in the expression.

For information on dimensional analysis for reaction rates, see How Reaction Rates Are Evaluated.

Characteristics

Applies toObject: CompileOptions (in configset object)
Data typechar string
Data values

concentration or substance. Default value is concentration.

AccessRead/write

Was this topic helpful?