Save final operating point

Option to save complete model operating point when simulation is paused or stopped

Model Configuration Pane: Data Import/Export

Description

When the simulation is paused or stops, the software saves the complete model operating point, including block states, hidden block states, the state of the solver and execution engine, and some block output values, to the specified MATLAB^® variable.

Dependencies

To enable this parameter, select Final states.

Settings

off (default) | on

off

If you select Final states, the software exports only the final values for block states at the end of simulation. This information might not be sufficient to accurately resume a simulation from the same point.

on

The software saves complete information about the simulation state as a Simulink.op.ModelOperatingPoint object. The operating point information is stored in the Final states logging variable.

Examples

Resume Simulation Using Initial Operating Point

Open the model vdp.

mdl = "vdp";
open_system(mdl);

Configure the model to save the final operating point at the end of simulation.

1. On the Modeling tab, under Setup, click Model Settings.

2. In the Configuration Parameters dialog box, select the Data Import/Export pane.

3. On the Data Import/Export tab, select Final states and Save final operating point.

4. Click OK.

Alternatively, create a Simulink.SimulationInput object to store the parameter values for the simulation. Then, use the setModelParameter function to specify the parameter values to use in the simulation.

simIn = Simulink.SimulationInput(mdl);

simIn = setModelParameter(simIn,"SaveFinalState","on");
simIn = setModelParameter(simIn,"SaveOperatingPoint","on");

Set the stop time for the simulation to 10 seconds. On the Simulation tab, under Simulate, in the Stop Time box, enter 10, or use the setModelParameter function to specify the value of the StopTime parameter for the simulation.

simIn = setModelParameter(simIn,"StopTime","10");

Simulate the model.

out = sim(simIn);

To view the simulation results, double-click the Scope block in the model. The plot in the Scope displays the values of the signals x1 and x2 over the 10-second simulation.

Resume the simulation by using the operating point you saved at the end of the first simulation as the initial operating point for the second simulation.

Get the final operating point from the first simulation from the Simulink.SimulationOutput object out.

vdpOP = out.xFinal;

Specify the operating point as the initial state for the simulation.

1. On the Modeling tab, under Setup, click Model Settings.

2. In the Configuration Parameters dialog box, on the Data Import/Export pane, select Initial state.

3. In the text box, enter vdpOP.

4. Click OK.

Alternatively, create another Simulink.SimulationInput object to configure this simulation. Then, use the setInitialState function to specify the initial state.

simIn2 = Simulink.SimulationInput(mdl);

simIn2 = setInitialState(simIn2,vdpOP);

Set the stop time for this simulation to 20. On the Simulation tab, under Simulate, in the Stop Time box, enter 20, or use the setModelParameter function to specify the value of the StopTime parameter for the simulation.

simIn2 = setModelParameter(simIn2,"StopTime","20");

Simulate the model again, resuming the prior simulation by starting this simulation from the final operating point saved in the first simulation.

out2 = sim(simIn2);

The plot in the Scope window updates to show the data from this simulation. The time axis starts at 0 and goes to the simulation stop time of 20. Because this simulation started from the initial operating point from the first simulation, which ended after 10 simulation seconds, the plot shows the values of the signals x1 and x2 only between simulation time 10 seconds and 20 seconds.

Recommended Settings

The table summarizes recommended values for this parameter based on considerations related to code generation.

Application	Setting
Debugging	No impact
Traceability	No impact
Efficiency	No recommendation
Safety precaution	No recommendation

Programmatic Use

Parameter: SaveOperatingPoint

Value: 'on' | 'off'

Default: 'off'

Version History

Introduced in R2019a

R2019a: Save complete SimState in final state parameter renamed to Save final operating point

The Save complete SimState in final state parameter, which was introduced in R2009a, is renamed and replaced with the Save final operating point parameter. To programmatically configure the parameter in previous releases, you used the SaveCompleteFinalSimState parameter. Starting in R2019a, use the SaveOperatingPoint parameter.

The SaveCompleteFinalSimState parameter continues to work and results in the same behavior as the SaveOperatingPoint parameter.