Documentation Center

  • Trial Software
  • Product Updates

AmountUnits

Dose amount units

Description

AmountUnits is a property of a RepeatDose or ScheduleDose object. This property defines units for the Amount property.

If the TargetName property defines a species, then AmountUnits for a dose must be a chemical amount (for example, milligram, mole, or molecule), not a concentration. To get a list of the defined units in the library, use the sbioshowunits function. To add a user-defined unit to the list, see sbioaddtolibrary.

Characteristics

Applies toObjects: RepeatDose, ScheduleDose
Data typestring
Data valuesUnits from library with dimensions of amount. Default = '' (empty)
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.

Was this topic helpful?