Skip to Main Content Skip to Search
Product Documentation

Simulink Model Referencing Requirements

About Model Referencing Requirements

A model reference hierarchy must satisfy various Simulink requirements, as described in this section. Some limitations also apply, as described in Model Referencing Limitations.

Name Length Requirement

The name of a referenced model must contain fewer than 60 characters, exclusive of the .mdl suffix. An error occurs if the name of a referenced model is too long.

Configuration Parameter Requirements

A referenced model uses a configuration set in the same way that any other model does, as described in Manage a Configuration Set. By default, every model in a hierarchy has its own configuration set. Each model uses its configuration set the same way that it would if the model executed independently.

Because each model can have its own configuration set, configuration parameter values can be different in different models. Furthermore, some parameter values are intrinsically incompatible with model referencing. The Simulink response to an inconsistent or unusable configuration parameter depends on the parameter:

Manually eliminating all configuration parameter incompatibilities can be tedious when:

You can control or eliminate such overhead by using configuration references to assign an externally stored configuration set to multiple models. See Manage a Configuration Reference for details.

The tables in the following sections list Configuration parameter options that can cause problems if set:

Where possible, Simulink resolves violations of these requirements automatically, but most cases require changes to the parameters in some or all models.

Configuration Requirements for All Referenced Model Simulation

Dialog Box PaneOptionRequirement
SolverStart timeThe start time of the top model and all referenced models must be the same, but need not be zero.
Stop timeSimulink uses Stop time of the top model for simulation, overriding any differing Stop time in a submodel.
Type
Solver
The Type and Solver of the top model apply throughout the hierarchy. See Solver Requirements.
Data Import/ExportInitial stateCan be on for the top model, but must be off for a referenced model.

Optimization

Inline parametersCan be on or off for a top model, but must be on for a referenced model. See Inline Parameter Requirements.

Application lifespan (days)

Must be the same for top and referenced models.

Model ReferencingTotal number of instances allowed per top modelMust not be Zero in a referenced model. Specifying One rather than Multiple is preferable or required in some cases. See Model Instance Requirements.

Hardware Implementation

Embedded hardware options

All values must be the same for top and referenced models.

Solver Requirements.  Model referencing works with both fixed-step and variable-step solvers. All models in a model reference hierarchy use the same solver, which is always the solver specified by the top model. An error occurs if the solver type specified by the top model is incompatible with the solver type specified by any submodel.

Top Model Solver TypeSubmodel Solver TypeCompatibility
Fixed StepFixed StepAllowed
Variable StepVariable StepAllowed
Variable StepFixed-stepAllowed unless the submodel is multi-rate and specifies both a discrete sample time and a continuous sample time
Fixed StepVariable StepError

If an incompatibility exists between the top model solver and any submodel solver, one or both models must change to use compatible solvers. For information about solvers, see Solvers and Choosing a Solver.

Inline Parameter Requirements.  Simulink requires enabling Configuration Parameters > Optimization > Inline parameters (see Inline parameters) for all referenced models in a reference hierarchy. The top model can enable or disable inline parameters. If a referenced model disables inlined parameters, and you try to simulate the parent model:

Simulink ignores tunable parameter specifications in the Model Parameter Configuration dialog box for both the top model and referenced models. Do not use this dialog box to override the inline parameters optimization for selected parameters to permit them to be tuned. Instead, see Parameterizing Model References for alternate techniques.

Model Instance Requirements.  A referenced model must specify that it is available to be referenced, and whether it can be referenced at most once or can have multiple instances. The Configuration Parameters > Model Referencing > Total number of instances allowed per top model parameter provides this specification. See Total number of instances allowed per top model for more information. The possible values for this parameter are:

Setting Total number of instances allowed per top model to Multiple for a model that is referenced only once can reduce execution efficiency slightly. However, this setting does not affect data values that result from simulation or from executing code Simulink Coder generates. Specifying Multiple when only one model instance exists avoids having to change or rebuild the model when reusing the model:

Some model properties and constructs require setting Total number of instances allowed per top model to One. For details, see General Reusability Limitations and Accelerator Mode Reusability Limitations.

Model Structure Requirements

The following requirements relate to the structure of a model reference hierarchy.

Signal Propagation Requirements

The signal name must explicitly appear on any signal line connected to an Outport block of a referenced model. A signal connected to an unlabeled line of an Outport block of a referenced model cannot propagate out of the Model block to the parent model.

Bus Usage Requirements

A bus that propagates between a parent model and a referenced model must be nonvirtual. Use the same bus object to specify the properties of the bus in both the parent and the referenced model. Define the bus object in the MATLAB workspace. See About Composite Signals for more information.

Sample Time Requirements

The first nonvirtual block connected to a root-level Inport or Outport block of a referenced model must have the same sample time as the port to which it connects. Use Rate Transition blocks to match input and output sample times, as illustrated in the following diagram.

  


Related Products & Applications

Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.

 © 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS