restore

Restore simulation scenario and model to their previous state

Since R2024a

Syntax

simulator_out = restore(simulator)

Description

simulator_out = restore(simulator) restores the configuration set, signal logging, fast-restart state, dirty state, and any other simulation arguments changed by the setup function.

Examples

collapse all

Simulate Model in Fast Restart Mode

Open Script

Open the model.

model = "sdoHydraulicCylinder";
open_system(model)

Create a simulation scenario for the model.

simulator = sdo.SimulationTest(model);

Configure the model and simulator for optimization and simulation, enabling fast restart.

simulator = setup(simulator,FastRestart="on");

Simulate the model.

simulator = sim(simulator);

The first simulation in fast restart mode requires the model to compile. Subsequent simulations execute in fast restart mode and reuse the compiled data.

Adjust tunable model parameters.

Ac = sdo.getParameterFromModel(model,"Ac");
Ac.Value = 0.5;
simulator.Parameters = Ac;

Simulate the model again.

simulator = sim(simulator);

The model simulates in fast restart mode.

Restore the simulator to its initial configuration, which disables fast restart.

simulator = restore(simulator);

Input Arguments

collapse all

`simulator` — Simulation scenario
`sdo.SimulationTest` object

Simulation scenario for Simulink^® model, specified as an sdo.SimulationTest object. A simulation scenario specifies input signals, model parameter and initial state values, and signals to log for a model.

Output Arguments

collapse all

`simulator_out` — Restored simulation scenario
`sdo.SimulationTest` object

Restored simulation scenario, returned as an sdo.SimulationTest object.

Tips

You can add a cleanup function to ensure that the restore function always runs, even when the optimization generates an error.
```
simulator = sdo.SimulationTest('mymodel');
simulator = setup(simulator);
scenario_cleanup = onCleanup(restore(scenario));
```