sdo.SimulationTest

R2026b

Simulation configuration description

Description

Create a configuration to simulate a Simulink^® model. A simulation configuration specifies input signals, model parameter and initial state values, and signals to log for a model. You can also specify linear systems to compute if you have Simulink Control Design™ toolbox. Use a simulation configuration to simulate a model with alternative inputs and model parameter and initial state values, without modifying the model.

Creation

Syntax

sim_obj = sdo.SimulationTest(modelname)

Description

sim_obj = sdo.SimulationTest(modelname) creates an sdo.SimulationTest object and assigns the specified model name to the ModelName property and default values to the remaining properties.

You can also create an sdo.SimulationTest object using the createSimulator function of an sdo.Experiment object. The createSimulator function configures the properties of the sdo.SimulationTest object to simulate the model associated with the experiment.

Properties

ModelName — Name of Simulink model

'' (default) | character vector | string scalar

Name of Simulink model, specified as a character vector or string scalar. The model must be on the MATLAB^® path.

Parameters — Model parameter values

[] (default) | param.Continuous object

Model parameter values, specified as a param.Continuous object. The software changes the model parameters to the specified values before simulating the model and restores them to their original value after the simulation completes.

Inputs — Input signals

[] (default)

Input signals to apply to root level input ports when simulating the model, specified as an input signal format that the sim function supports.

InitialState — Initial state of model

[] (default)

Initial state of model for simulation, specified as an initial state format that the sim function supports.

LoggingInfo — Signals to log when simulating model

Simulink.SimulationData.ModelLoggingInfo object (default)

Signals to log when simulating a model, specified as a Simulink.SimulationData.ModelLoggingInfo object. Specify the signals to log in its Signals property.

SystemLoggingInfo — Linear system logging settings

[] (default) | vector of sdo.SystemLoggingInfo objects

Linear system logging settings, specified as a vector of sdo.SystemLoggingInfo objects. If you specify the SystemLoggingInfo property, the sim method linearizes the model during simulation.

Note

You can also use the linearize (Simulink Control Design) function from Simulink Control Design to compute linear systems. However, to use fast restart, you must use SystemLoggingInfo property and sim instead.

LoggedData — Data logged during simulation

Read-only: [] (default)

This property is read-only.

Data logged during simulation, stored in a Simulink.SimulationOutput object and populated by the sim function. You must also specify the signals to log in the LoggingInfo property.

Name — Name of configuration

'' (default) | character vector | string scalar

Name of the configuration, specified as a character vector or string scalar.

Object Functions

find	Find logged data set
prepareToDeploy	Set up simulation configuration for deployment with Simulink Compiler
sim	Simulate Simulink model
who	List logged data names
setScenario	Set simulation scenario for a model
setup	Set up simulation configuration and model for optimization and evaluation
restore	Restore simulation configuration and model to their previous state

Examples

Create Simulation Configuration for Model

Create a simulation configuration for a model.

T = Simulink.SimulationData.SignalLoggingInfo;
T.BlockPath = "sdoCSTR/CSTR";
T.OutputPortIndex = 1;
simulator = sdo.SimulationTest("sdoCSTR");

Specify model signals to log.

simulator.LoggingInfo.Signals = [T];

Create Simulation Configuration for Experiment

Specify an experiment for a model.

experiment = sdo.Experiment('sdoRCCircuit');

Create a simulation configuration for the experiment.

sim_obj = createSimulator(experiment);

Alternatives

Design Optimization to Meet Step Response Requirements (GUI)

Version History

Introduced in R2011b