Main Content

InitialAmount

Species initial amount

Description

The InitialAmount property indicates the initial quantity of the SimBiology® species object. InitialAmount is the quantity of the species before the simulation starts.

The InitialAmount property and Value property are identical.

Characteristics

Applies toObject: species
Data typedouble
Data valuesPositive real number. Default value is 0.
AccessRead/write

Examples

Add a species to a model and set the initial amount of the species.

  1. Create a model object named my_model.

    modelObj = sbiomodel ('my_model');
  2. Add the species object named glucose.

    speciesObj = addspecies (modelObj, 'glucose');
  3. Set the initial amount to 100 and verify.

    set (speciesObj, 'InitialAmount',100);
    get (speciesObj, 'InitialAmount')

    MATLAB® returns:

    ans =
    
       100