slTunerOptions

Set slTuner interface options

Description

The SlTunerOptions object stores and manages the options for the slTuner interface.

Creation

Syntax

options = slTunerOptions

options = slTunerOptions(PropertyName=Value)

Description

options = slTunerOptions returns the default slTuner interface option set.

options = slTunerOptions(PropertyName=Value) returns an option set with additional options specified by one or more property values.

Properties

General Options

SampleTime — Sample time of linearization result

0 (default) | positive scalar

Sample time of linearization result, specified as one of the following:

• 0 — Create a continuous-time model.

• Positive scalar — Specify the sample time for discrete-time systems.

UseFullBlockNameLabels — Flag indicating whether to truncate names of I/Os and states

"off" (default) | on/off logical value

Flag indicating whether to truncate names of I/Os and states in the linearized model, specified as the comma-separated pair consisting of 'UseFullBlockNameLabels' and either:

• "off", 0, or false — Use truncated names for the I/Os and states in the linearized model.

• "on", 1, or true — Use the full block path to name the I/Os and states in the linearized model.

UseBusSignalLabels — Flag indicating whether to use bus signal channel numbers or names

"off" (default) | on/off logical value

Flag indicating whether to use bus signal channel numbers or names to label the I/Os in the linearized model, specified as the comma-separated pair consisting of 'UseBusSignalLabels' and one of the following:

• "off", 0, or false — Use bus signal channel numbers to label I/Os on bus signals in the linearized model.

• "on", 1, or true — Use bus signal names to label I/Os on bus signals in the linearized model. Bus signal names appear in the results when the I/O points are located at the output of the following blocks:

  • Root-level inport block containing a bus object

  • Bus creator block

  • Subsystem block whose source traces back to the output of a bus creator block

  • Subsystem block whose source traces back to a root-level inport by passing through only virtual or nonvirtual subsystem boundaries

BatchConsistency — Perform state-consistent batch linearization

"off" (default) | on/off logical value

Since R2025a

Flag indicating whether to perform state-consistent reduction for linearized array with uniform state dimension. This means that the software removes only the states and delays that do not contribute to the input-output map for all models in the batch linearization array.

Specify this option as one of these logical on/off values:

• "on", 1, or true — Perform state-consistent reduction.

• "off", 0, or false — Do not perform state-consistent reduction.

AreParamsTunable — Flag indicating whether to recompile the model when varying parameter values

true (default) | false

Flag indicating whether to recompile the model when varying parameter values for linearization, specified as the comma-separated pair consisting of 'AreParamsTunable' and one of the following:

• true — Do not recompile the model when all varying parameters are tunable. If any varying parameters are not tunable, recompile the model for each parameter grid point, and issue a warning message.

• false — Recompile the model for each parameter grid point. Use this option when you vary the values of nontunable parameters.

For more information about model compilation when you linearize with parameter variation, see Batch Linearization Efficiency When You Vary Parameter Values.

StoreAdvisor — Flag indicating whether to store diagnostic information

"off" (default) | on/off logical value

Flag indicating whether to store diagnostic information during linearization, specified as the comma-separated pair consisting of 'StoreAdvisor' and one of the following:

• "off", 0, or false — Do not store linearization diagnostic information.

• "on", 1, or true — Store linearization diagnostic information.

Linearization commands store and return diagnostic information in a LinearizationAdvisor object. For an example of troubleshooting linearization results using a LinearizationAdvisor object, see Troubleshoot Linearization Results at Command Line.

StoreOffsets — Flag indicating whether to compute linearization offsets

"none" (default) | "struct" | "system"

Flag indicating whether to compute linearization offsets for inputs, outputs, states, and state derivatives or updated states, specified as one of the following:

• "none" — Do not compute linearization offsets.

• "stuct" — Return computed linearization offsets in the info output argument of linearize.

• "system" — Store computed linearization offsets in the Offsets property of the linearized system sys. This option is applicable only when sys is an ss or sparss model.

You can configure an LPV System block using linearization offsets. For an example, see Approximate Nonlinear Behavior Using Array of LTI Systems

Rate Conversion

RateConversionOptions — Rate conversion options for discretization

RateConversionOptions object (default)

Rate conversion options, specified as a RateConversionOptions object with the following properties.

Method — Rate conversion method

'zoh' (default) | 'tustin' | 'prewarp' | 'upsampling_zoh' | 'upsampling_tustin' | 'upsampling_prewarp'

Method used for rate conversion when linearizing a multirate system, specified as the comma-separated pair consisting of 'RateConversionMethod' and one of the following:

• 'zoh' — Zero-order hold rate conversion method

• 'tustin' — Tustin (bilinear) method

• 'prewarp' — Tustin method with frequency prewarp. When you use this method, set the PrewarpFrequency option to the desired prewarp frequency.

• 'upsampling_zoh' — Upsample discrete states when possible, and use 'zoh' otherwise.

• 'upsampling_tustin' — Upsample discrete states when possible, and use 'tustin' otherwise.

• 'upsampling_prewarp' — Upsample discrete states when possible, and use 'prewarp' otherwise. When you use this method, set the PrewarpFrequency option to the desired prewarp frequency.

For more information on rate conversion and linearization of multirate models, see:

• Linearize Multirate Models

• Linearize Models Using Different Rate Conversion Methods

• Continuous-Discrete Conversion Methods

Note

If you use a rate conversion method other than 'zoh', the converted states no longer have the same physical meaning as the original states. As a result, the state names in the resulting LTI system change to '?'.

This option applies only when LinearizationAlgorithm is 'blockbyblock'.

Example: options.RateConversionOptions.Method = "tustin";

DelayModeling — Format of modeling extra delays

'state' (default) | 'delay'

Since R2025a

Format of modeling extra delays arising from discretization, specified as 'delay' or 'state'. Discretizing models with input or output delays that are fractional multiples of Ts can give rise to additional delays besides the discrete input and output delays. Use this option to specify whether to model these extra delays as internal delays (''delay') or additional states ('state').

This option is only applicable when UseExactDelayModel is on, or when substituting blocks with models that have delays.

Example: options.RateConversionOptions.DelayModeling = "delay";

PrewarpFrequency — Prewarp frequency

0 (default) | positive scalar

Prewarp frequency in rad/s, specified as a nonnegative scalar. This option applies only when RateConversionMethod is either 'prewarp' or 'upsampling_prewarp'.

Example: options.RateConversionOptions.PrewarpFrequency = 100;

ThiranOrder — Maximum order of Thiran filter for 'tustin'and 'matched' methods

0 (default) | positive integer

Since R2025a

Maximum order of the Thiran filter used to approximate fractional delays in the 'tustin' method. A value of 0 means that discretization rounds fractional delays to the nearest integer multiple of the sample time. If you set this property to a positive integer, discretization uses thiran to approximate fractional delays before discretizing.

For models with fractional delays, the Thiran filters contribute additional internal delays when DelayModeling is set to 'delay' and additional states when DelayModeling is set to 'state'.

This option is only applicable when UseExactDelayModel is on, or when substituting blocks with models that have delays.

Example: options.RateConversionOptions.ThiranOrder = 5;

Object Functions

Examples

Create Option Set for slTuner Interface

Create an option set for an slTuner interface that sets the rate conversion method to the Tustin method with prewarping at a frequency of 10 rad/s.

options = slTunerOptions('RateConversionMethod','prewarp',...
                           'PreWarpFreq',10);

Alternatively, use dot notation to set the values of options.

options = slTunerOptions;
options.RateConversionMethod = 'prewarp';
options.PreWarpFreq = 10;

Version History

Introduced in R2014a

R2025a: Improvements to sparse and descriptor state-space linearization, discrete rate conversion, offset handling, and state consistency

The linearization tools available in Simulink^® Control Design™ software now provide the following enhancements for linearization:

• Enhanced rate conversion options — The object now store the rate conversion related options under the new RateConversionOptions property. Additionally, rate conversion options now include DelayModeling and ThiranOrder. The DelayModeling option allows you to specify whether to model extra delays from discretization as internal delays or additional states. The ThiranOrder option specifies the order of the Thiran filter used to approximate fractional delays in the Tustin discretization. To set these properties, use dot notation:

  opt = linearizeOptions;
  opt.RateConversionOptions.Method = "tustin";
  opt.RateConversionOptions.DelayModeling = "delay";
  opt.RateConversionOptions.ThiranOrder = 3;

• Offset computation and storage — The software now allows you to directly store offsets in the Offsets property of the linearized ss and sparss models using the new value "system" for the option.

  opt = linearizeOptions(StoreOffsets="system")

  Additionally, you can now compute offsets during snapshot linearization. Calculation of offsets during simulation are limited to continuous time blocks and linear discrete time blocks. For example:

  tsnap = 7.5;
  sys = linearize(mdl,io,tsnap,opt);

• Consistent block reduction — When performing batch linearization, you can now use the new BatchConsistency option of linearizeOptions and slTunerOptions to only reduce the states that are reducible for all models in the grid of operating points. In addition, the software maintains this consistency during any rate conversion or delay modeling.

These changes also simplify LPV modeling workflows. Building LPV models in MATLAB^® and Simulink require consistent and uniform state dimensions, delay modeling, and offset handling across the linearization grid. For more information about building LPV models from batch linearization results, see ssInterpolant.

R2025a: linearizeOptions and slTunerOptions: Offset and rate conversion options changed

As a result of improvements to linearization workflows, how you specify options related to offsets and rate conversion in linearizeOptions and slTunerOptions have changed. This table describes the change in the workflow.

Before R2025a	R2025a
Offsets Do not compute linearization offsets. opt.StoreOffsets = "off"; Compute linearization offsets and return as an output argument of linearize. opt.StoreOffsets = "on"; [sys,~,info] = linearize(__,opt); offsets = info.Offsets;	Offsets Do not compute linearization offsets. opt.StoreOffsets = "none"; Compute linearization offsets and return as an output argument of linearize. opt.StoreOffsets = "struct"; [sys,~,info] = linearize(__,opt); offsets = info.Offsets;
Rate conversion Rate conversion method opt.RateConversionMethod = "tustin"; Prewarp frequency opt.PreWarpFreq = 10;	Rate conversion Rate conversion method opt.RateConversionOptions.Method = "tustin"; Prewarp frequency opt.RateConversionOptions.PrewarpFrequency = 10;