Units for dose rate
RateUnits
is a property of a PKData
, RepeatDose
or ScheduleDose
object.
In RepeatDose
or ScheduleDose
objects,
this property defines units for the Rate
property.
In PKData
object, this property
defines units for the RateLabel
property.
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
and UnitConversion
are
both false
, 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
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 units can be empty. If you have a dimensionless parameter, you
must still set its units to dimensionless
.
PKData object
,
ScheduleDose object
, RepeatDose object
, Rate
, RateLabel