RateUnits
Units for dose rate
Description
RateUnits
is a property of a PKData
, RepeatDose
or ScheduleDose
object.
In
RepeatDose
orScheduleDose
objects, this property defines units for theRate
property.In
PKData
object, this property defines units for theRateLabel
property.
Characteristics
Applies to | Object: RepeatDose , ScheduleDose , PKData |
Data type | Character vector |
Data values | Units from library with dimensions of amount divided by time. You cannot use units of concentration divided by time. Default = '' (empty). |
Access | Read/write |
Note
SimBiology® uses units including empty units in association with DimensionalAnalysis and UnitConversion features.
When
DimensionalAnalysis
andUnitConversion
are bothfalse
, units 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
istrue
andUnitConversion
isfalse
, 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 totrue
(which requiresDimensionalAnalysis
to betrue
), SimBiology performs a dimensional analysis and converts everything to consistent units. Hence, you must specify consistent units, and no units can be empty. If you have a dimensionless parameter, you must still set its units todimensionless
.
See Also
PKData object
,
ScheduleDose object
, RepeatDose object
, Rate
, RateLabel