setModelParameter - Set model parameter values for simulation using

            SimulationInput or Simulation
        object - MATLAB ([original](https://in.mathworks.com/help/simulink/slref/simulink.simulationinput.setmodelparameter.html)) ([raw](?raw))

Set model parameter values for simulation usingSimulationInput or Simulation object

Syntax

Description

s = setModelParameter([s](#mw%5Fb2b58806-d857-4679-b1f0-8e4d979f4924),[Name=Value](#namevaluepairarguments)) sets the model parameter named Name to the valueValue on the Simulink.SimulationInput or Simulation object s.

• When s is a SimulationInput object, you can specify only a single value for each parameter to use for the entire simulation.
• When s is a Simulation object, you can specify a single value for each parameter to use at the start of the simulation and specify new values for tunable parameters during simulation.

You can use the setModelParameter function to specify a value for any model parameter on a SimulationInput orSimulation object. The parameter values you specify override the values saved in the model for simulations you run using theSimulationInput or Simulation object during simulation and are reverted when the simulation completes. You can use aSimulationInput or Simulation object to override any number of parameter values.

example

Examples

collapse all

Configure model parameter values for a simulation using aSimulationInput object.

Open the model.

mdl = "sldemo_househeat"; openExample("simulink_general/sldemo_househeatExample",... SupportingFile=mdl)

Create a SimulationInput object for the model.

simin = Simulink.SimulationInput(mdl);

Specify a simulation timeout of 5 seconds, and then specify the start and stop time for the simulation.

simin = setModelParameter(simin,Timeout=5); simin = setModelParameter(simin,StartTime="1",StopTime="4");

Simulate the model.

Input Arguments

collapse all

Simulation specification or simulation in which to set model parameter, specified as a Simulink.SimulationInput object or a Simulation object.

A SimulationInput object represents a simulation specification that includes the initial state, external inputs, model parameter values, block parameter values, and variable values to use in the simulation. When you specify the first input argument as aSimulationInput object:

• For each model parameter, you can specify only a single value to use for the entire simulation.
• You must specify the SimulationInput object as a return argument.

The Simulation object represents a simulation and provides an interface for controlling and interacting with the simulation. When you specify the first input argument as a Simulation object:

• For each model parameter, you can specify the initial value to use in the simulation.
• You can modify the values of tunable model parameters during simulation.
• Specifying the Simulation object as a return argument is optional.

Example: simin = setModelParameter(simin,FixedStep="0.1") specifies a fixed step size of 0.1 seconds in the simulation configuration stored on theSimulationInput objectsimin.

Example: sm = setModelParameter(sm,FixedStep="0.1") changes the value of the fixed step size to 0.1 in the simulation represented by the Simulation objectsm.

Name-Value Arguments

collapse all

Specify optional pairs of arguments asName1=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: simin = setModelParameter(simin,TimeOut="100") configures a SimulationInput object with a simulation timeout of 100 seconds.

Model configuration parameter, specified as a name-value argument that consists of the programmatic name of the configuration parameter and the configuration parameter value. For example, to specify a value for the**Stop time** parameter, use the programmatic parameter nameStopTime as the name in the name-value argument and specify the simulation stop time as the value. This command sets the simulation stop time to 100 seconds on theSimulationInput object namedsimin.

simin = setModelParameter(simin,StopTime="100");

You can use the setModelParameter function to specify the value for any model configuration parameter on aSimulationInput object or aSimulation object. When you simulate a model hierarchy, the configuration parameter values you specify apply to the top model.

Example: simin = setModelParameter(simin,FixedStep="0.1") specifies a fixed step size of 0.1 seconds in the simulation configuration stored on theSimulationInput objectsimin.

Example: sm = setModelParameter(sm,FixedStep="0.1") changes the value of the fixed step size to 0.1 in the simulation represented by the Simulation objectsm.

Tips

To get a list of model configuration parameters, use thegetActiveConfigSet function and theget_param function. For example, to see the configuration parameters for a model named vdp, enter these commands in the MATLAB® Command Window.

configSet = getActiveConfigSet("vdp"); configSetNames = get_param(configSet,"ObjectParameters")

The get_param function returns a list of all the model configuration parameters, such asStopTime, SaveTime,SaveState, SaveOutput, andSignalLogging.

Since R2024a

Option to enable fast restart for individual, iterative simulations, specified as "on" or "off".

• "on" — Enables fast restart for simulation. Fast restart saves time in iterative simulation workflows by skipping compilation and termination after compiling the model for the first simulation you run after enabling fast restart. By default, fast restart is disabled. For more information, seeHow Fast Restart Improves Iterative Simulations.
  When you run a simulation that enables fast restart using aSimulation object or a scalarSimulationInput object, if the model is not already initialized in fast restart, the software compiles the model before running the simulation. At the end of the simulation, the model remains initialized in fast restart.
• "off" — Disables fast restart for simulation.

This parameter affects only individual simulations run using:

• The sim function with a scalarSimulationInput object
• A Simulation object

When you run multiple simulations by specifying an array ofSimulationInput objects as an input to functions such as sim, parsim, andbatchsim, enable fast restart by specifying theUseFastRestart name-value argument for thesim, parsim, orbatchsim function. For more information, seeScript Iterative or Batch Simulations Using Fast Restart.

Example: simin = setModelParameter(simin,FastRestart="on") configures theSimulationInput object simin to enable fast restart for a simulation you run by specifying the scalarSimulationInput object as an input argument to thesim function.

Example: sm = setModelParameter(sm,FastRestart="on") configures the simulation represented by the Simulation object sm to enable fast restart.

Data Types: char | string

Simulation mode, specified as "normal","accelerator", or"rapid-accelerator".

For more information, see Choosing a Simulation Mode and Code Regeneration in Accelerated Models.

Example: simin = setModelParameter(simin,SimulationMode="rapid-accelerator") configures the simulation run using the SimulationInput object simin to use rapid accelerator mode.

Example: sm = setModelParameter(sm,SimulationMode="rapid-accelerator") configures the simulation represented by the Simulation object sm to simulate using rapid accelerator mode.

Tips

• Visualization blocks update during simulation when you run simulations from a UI, such as the Simulink Editor, but do not update during simulation when you run rapid accelerator simulations programmatically.
• To prevent rebuilding the standalone executable, you can disable the rapid accelerator up-to-date check by specifying theRapidAcceleratorUpToDateCheck parameter value as"off". With the up-to-date check disabled, changes you make that would require rebuilding the executable are ignored.
• To simulate using rapid accelerator mode, you can specify "rapid" as a partial match for "rapid-accelerator". For more information about name-value arguments in MATLAB, see Validate Name-Value Arguments.

Data Types: char | string

Since R2024a

Option to capture simulation errors in simulation output, specified as"off" or "on". This parameter affects only individual simulations run using:

• The sim function with a scalarSimulationInput object
• A Simulation object

When you run multiple simulations by specifying an array ofSimulationInput objects as an input to functions such as sim, parsim, andbatchsim, the CaptureErrors parameter is always enabled.

Example: simin = setModelParameter(simin,CaptureErrors="on") configures a single simulation run using the scalar SimulationInput object simin to capture simulation errors in the simulation output.

Example: sm = setModelParameter(sm,CaptureErrors="on") configures the simulation represented by the Simulation objectsm to capture simulation errors in the simulation output.

Tips

• This option is not supported for software-in-the-loop (SIL) and processor-in-the-loop (PIL) simulations.
• When you configure an individual simulation to capture simulation errors and when you run multiple simulations by specifying an array of SimulationInput objects, you can view information about the error and the simulation in the simulation results.
  • To view the message, use theErrorMessage property of theSimulationOutput object.
  • For more information about the error, use theExecutionInfo property of theSimulink.SimulationMetadata object. TheErrorDiagnostic field includes information about the error, including the simulation phase in which the error occurred.

Data Types: char | string

Option to disable rebuilding rapid accelerator target, specified as"on" or "off". When you specify this argument as "on", changes that require rebuilding the rapid accelerator target are ignored. When you use this option, modify only options that do not require rebuilding the rapid accelerator target.

Example: simin = setModelParameter(simin,RapidAcceleratorUpToDateCheck="off") configures a SimulationInput object to disable rebuilding the rapid accelerator target.

Example: sm = setModelParameter(sm,RapidAcceleratorUpToDateCheck="off") disables the rapid accelerator up-to-date check in the simulation represented by the Simulation objectsm.

Data Types: char | string

Maximum simulation run time, specified as a positive scalar. Specify the time, in seconds, to allow the simulation to run. If the simulation runs for longer than the value you specify, the software issues a warning and stops the simulation. For example, if you specifyTimeOut as 30, the software stops the simulation and issues a warning if computing simulation results takes more than 30 seconds.

The TimeOut parameter specifies a limit on the amount of clock time for a simulation to run. To specify the maximum time value to simulate, use the Stop time parameter.

Example: simin = setModelParameter(simin,TimeOut=60) sets a maximum run time of 60 seconds in the simulation configuration stored on the SimulationInput objectsimin.

Example: sm = setModelParameter(sm,TimeOut=60) sets a maximum run time of 60 seconds in the simulation represented by theSimulation objectsm.

Data Types: char | string

Output Arguments

collapse all

Simulation specification or simulation with model parameter added or modified, returned as a Simulink.SimulationInput object or a Simulation object.

When you use the setModelParameter function to specify the value of a model parameter on a SimulationInput object, you must specify the SimulationInput object as the return argument.

When you use the setModelParameter function to specify the value of a model parameter on a Simulation object, assigning the return argument is optional.

Tips

• Use the getModelParameter function to get the value of a parameter specified on a SimulationInput object or aSimulation object.
  paramval = getModelParameter(s,"ParamName");
• Use the removeModelParameter function to remove a model parameter from a SimulationInput object or aSimulation object.
  s = removeModelParameter(s,"ParamName");

Version History

Introduced in R2017a

expand all

The Simulation object represents a simulation and provides an interface to control simulation execution and tune model parameter, block parameter, and variable values during simulation. You can use the setModelParameter function to specify model parameter values to use during simulation and to modify values of tunable model parameters during simulation.

You can use the setModelParameter function to enable theFastRestart parameter on a SimlationInput object or a Simulation object. Fast restart saves time in iterative simulation workflows by skipping compilation and termination after compiling the model for the first simulation you run after enabling fast restart.

The FastRestart parameter applies only for individual simulations you run one at a time using the Simulation object or the sim function. To use fast restart when you run multiple simulations using an array of SimulationInput objects and thesim, parsim, orbatchsim functions, specify theUseFastRestart name-value argument for thesim, parsim, orbatchsim function.

For more information, see How Fast Restart Improves Iterative Simulations.

In prior releases, the sim function overwrote theCaptureErrors parameter for a single simulation if you specified one or more name-value arguments in addition to the scalarSimulationInput object, including theStopOnError name-value argument. Now, thesim function has consistent default behavior and options, summarized in the table.