Main Content

ssGetStateAbsTol

Get the absolute tolerance used by the variable-step solver for a specified state

Syntax

real_T ssGetStateAbsTol(SimStruct *S, int_T state)

Arguments

S

SimStruct that represents an S-Function block.

state

Index of the state whose absolute tolerance is to be returned.

Returns

A real_T value for the absolute tolerance of the state referenced by the index state.

Description

Use to get the absolute tolerance for a particular state.

Note

Absolute tolerances are not allocated for fixed-step solvers. Therefore, you should never invoke this macro until you have verified that the simulation is using a variable-step solver, using ssIsVariableStepSolver.

Languages

C, C++

Examples

See the S-function sfun_atol.c used in sfcndemo_sfun_atol.

Version History

Introduced before R2006a