This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

RelativeTolerance

Allowable error tolerance relative to state value during a simulation

Description

RelativeTolerance is a property of the SolverOptions object, which is a property of a Configset object. It is available for the ode solvers (ode15s, ode23t, ode45, and sundials).

The RelativeTolerance property specifies the allowable error tolerance relative to the state vector at each simulation step. The state vector contains values for all the state variables, for example, amounts for all the species.

If you set the RelativeTolerance at 1e-2, you are specifying that an error of 1% relative to each state value is acceptable at each simulation step.

For details, see Selecting Absolute Tolerance and Relative Tolerance for Simulation.

Characteristics

Applies toObject: SolverOptions
Data typedouble
Data valuesPositive scalar that is <1. Default is 1e-3.
AccessRead/write

Examples

This example shows how to change AbsoluteTolerance.

  1. Retrieve the configset object from the modelObj.

    modelObj  = sbiomodel('cell');
    configsetObj = getconfigset(modelObj)
  2. Change the AbsoluteTolerance to 1e-8.

    set(configsetObj.SolverOptions, 'RelativeTolerance', 1.0e-6);
    get(configsetObj.SolverOptions, 'RelativeTolerance')
    
    ans =
    
      1.0000e-006