Documentation

TimeUnits

Show time units for dosing and simulation

Description

The TimeUnits property specifies time units for these properties:

  • StopTime property of a Configset object

  • OutputTimes and AbsoluteToleranceStepSize properties of the SolverOptions property of a Configset object

  • StartTime and Interval properties of a RepeatDose object

  • Time property of a ScheduleDose object

  • Time property of a SimData object

    Note:   If you change the value of the TimeUnits property, make sure:

    • You update the values of the Time, StartTime, Interval, StopTime, and OutputTimes properties accordingly.

    • You update raw numbers used in any event triggers that use the keyword time accordingly. For more information, see Trigger.

    • The units, if any, associated with expressions used in any event triggers that use the keyword time, are consistent with the updated TimeUnits property. For more information, see Trigger.

    Tip   If UnitConversion is on and your model has any event, follow the recommendation below.

    Non-dimensionalize any parameters used in the event trigger if they are not already dimensionless. For example, suppose you have a trigger x > 1, where x is the species concentration in mole/liter. Non-dimensionalize x by scaling (dividing) it with a constant such as x/x0 > 1, where x0 is a parameter defined as 1.0 mole/liter. Note that x does not have to have the same unit as the constant x0, but must be dimensionally consistent with it. For example, the unit of x can be picomole/liter instead of mole/liter.

Characteristics

Applies toObjects: Configset, RepeatDose, ScheduleDose, SimData
Data typestring
Data values

Empty string or a string specifying any unit defined in the Units Library.

Default value is:

  • second — properties of a Configset object or SimData object for a model object created using sbiomodel

  • hour — properties of a Configset object or SimData object for a model object created from a PKModelDesign object

  • '' (empty string) — properties of RepeatDose and ScheduleDose objects

Access

Read/write for properties of Configset, RepeatDose, and ScheduleDose objects

Read only for properties of SimData objects

Was this topic helpful?