Main Content

slTunerOptions

Set slTuner interface options

collapse all in page

Syntax

options = slTunerOptions
options = slTunerOptions(Name,Value)

Description

options = slTunerOptions returns the default slTuner interface option set.

example

options = slTunerOptions(Name,Value) returns an option set with additional options specified by one or more Name,Value pair arguments.

Examples

collapse all

Open Live Script

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;

Input Arguments

collapse all

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'RateConversionMethod','prewarp' sets the rate conversion method to the Tustin method with prewarping.

Linearization sample time, specified as the comma-separated pair consisting of 'SampleTime' and one of the following:

  • 0 — Create a continuous-time model.

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

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' — Use truncated names for the I/Os and states in the linearized model.

  • 'on' — Use the full block path to name the I/Os and states in the linearized model.

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' — Use bus signal channel numbers to label I/Os on bus signals in the linearized model.

  • 'on' — 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

Flag indicating whether to compute linearization offsets for inputs, outputs, states, and state derivatives or updated states, specified as the comma-separated pair consisting of 'StoreOffsets' and one of the following:

  • false — Do not compute linearization offsets.

  • true — Compute linearization offsets.

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

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

  • false — Do not store linearization diagnostic information.

  • 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.

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 PreWarpFreq 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 PreWarpFreq option to the desired prewarp frequency.

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

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 '?'.

Prewarp frequency in rad/s, specified as the comma-separated pair consisting of 'PreWarpFreq' and a nonnegative scalar. This option applies only when RateConversionMethod is either 'prewarp' or 'upsampling_prewarp'.

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.

Output Arguments

collapse all

slTuner interface options, returned as an slTunerOptions option set.

Version History

Introduced in R2014a

See Also