SimBiology®

InitialAmountUnits - Species initial amount units

Description

The InitialAmountUnits property indicates the unit definition for the InitialAmount property of a species object. InitialAmountUnits can be one of the builtin units. To get a list of the defined units use the sbioshowunits function. If InitialAmountUnits changes from one unit definition to another, the InitialAmount does not automatically convert to the new units. The sbioconvertunits function does this conversion. To add a user-defined unit to the list see sbioregisterunit.

See DefaultSpeciesDimension for more information on specifying dimensions for species quantities. InitialAmountUnits must have corresponding dimensions to CapacityUnits. For example, if the CapacityUnits are meter² then species must be amount/meter² or amount.

Characteristics

Example

1. Create a model object named my_model.

   modelObj = sbiomodel ('my_model');
   compObj = addcompartment(modelObj, 'cell');

2. Add a species object with the name glucose.

   speciesObj = addspecies (compObj, 'glucose');

3. Set the initial amount to 100, InitialAmountUnits to molecule, and verify.

   set (speciesObj,'InitialAmountUnits','molecule'); 
   get (speciesObj,'InitialAmountUnits')
   

   MATLAB^® returns

   ans =
   
   molecule

See Also

DefaultSpeciesDimension, InitialAmount, sbioshowunits, sbioconvertunits, sbioregisterunit

InitialAmount

KineticLaw