Documentation Center

  • Trial Software
  • Product Updates

AbstractKineticLaw object

Kinetic law information in library

Description

The abstract kinetic law object represents a kinetic law definition, which provides a mechanism for applying a rate law to multiple reactions. The information in this object acts as a mapping template for the reaction rate. The kinetic law definition specifies a mathematical relationship that defines the rate at which reactant species are produced and product species are consumed in the reaction. The expression is shown in the Expression property. The species variables are defined in the SpeciesVariables property, and the parameter variables are defined in the ParameterVariables property of the abstract kinetic law object. For an explanation of how the kinetic law definition relates to the kinetic law object, see KineticLaw object.

Create your own kinetic law definition and add it to the kinetic law library with the sbioaddtolibrary function. You can then use the kinetic law to define a reaction rate. To retrieve a kinetic law definition from the user-defined library, first create a root object using sbioroot, then use the command get(rootObj.UserDefinedLibrary, 'KineticLaws').

See Property Summary for links to abstract kinetic law object property reference pages.

Properties define the characteristics of an object. For example, an abstract kinetic law object includes properties for the expression, the name of the law, parameter variables, and species variables. Use the get and set commands to list object properties and change their values at the command line. You can graphically change object properties in the SimBiology® desktop.

Constructor Summary

sbioabstractkineticlawCreate kinetic law definition

Method Summary

delete (any object)Delete SimBiology object
display (any object)Display summary of SimBiology object
get (any object)Get object properties
set (any object)Set object properties

Property Summary

Expression (AbstractKineticLaw, KineticLaw)Expression to determine reaction rate equation
NameSpecify name of object
NotesHTML text describing SimBiology object
ParameterVariablesParameters in kinetic law definition
ParentIndicate parent object
SpeciesVariables Species in abstract kinetic law
TagSpecify label for SimBiology object
TypeDisplay SimBiology object type
UserDataSpecify data to associate with object
Was this topic helpful?