Variant Connector
Remove or disconnect physical components from network
- Library:
Simscape / Utilities
Description
The Variant Connector block lets you define variant choices
in a physical network. Variant choices allow you to exclude some components from simulation
without physically removing the components from the physical network. The components to be
disconnected must be connected to the port associated with condition data. During simulation,
the variant condition is propagated to all the connected components within the physical
network. If the variant control associated with the block evaluates to
true, all the components that are connected to the block become active. If
the variant control evaluates to false, all the components connected to the
block become inactive.
Note
The Variant Connector block does not propagate the variant condition across the boundary between the Simscape™ physical network and the Simulink® blocks connected to it. In other words, a block that has both conserving ports and Simulink signal ports, such as a Simulink-PS Converter or a PS-Simulink Converter block, does not propagate the variant condition from a Variant Connector block between the two parts of the model.
Ports
Conserving
Parameters
Connector Type — Type of connector block
Leaf (default) | Primary | Nonprimary
Select a connector type based on the components to deactivate.
Leaf: If you want to deactivate all the components connected to the block, set Connection Type toLeaf.For example, in this model, the variant condition associated with the Variant Connector block, ConneBlk1, is
A == 1. The variant condition associated with the Variant Connector block, ConneBlk2, isB == 1. During simulation, whenA == 1evaluates totrueandB == 1evaluates tofalse, all the components connected to ConneBlk1 block become active, and all the components connected to ConneBlk2 block become inactive.
Primary and Nonprimary: If you want to restrict the propagation of the variant condition to a set of components, create a Bounded region by using primary and nonprimary connector blocks. To form a bounded region, the primary and nonprimary connector blocks must have the same Connector Tag property.When you set Connection Type to
PrimaryorNonprimary, the connector tag of the block is displayed on the block icon. The connector tag of the primary connector block is displayed with double lines and the connector tag of the nonprimary connector block is displayed with single lines.
Connector Tag — Unique identifier of bounded region
A (default) | Valid MATLAB® identifier that starts with a letter, contains no spaces or special
characters and is at most 63 characters long
Specify an identifier in the Connector Tag parameter. The primary and nonprimary connector blocks with the same tag form a Bounded region.
Dependencies
To enable this parameter, set Connector Type to
Primary or Nonprimary.
Variant control expression — Variant controls available in global workspace
'Choice_1' (default) | Boolean condition expression
Displays the variant controls available in the global workspace. The variant control
can be a Boolean condition expression containing a regular MATLAB variable or a Simulink.Variant
To edit a variant name, double-click a Variant control expression cell and type in the variant control expression. Click Apply after you edit a variant control name.
When the variant control associated with the block evaluates to
true, all the components connected to the block become
active.
Programmatic Use
Block Parameter:
VariantControls
|
| Type: cell array of character vectors |
| Value: Variant control that is associated with the Variant choice |
Default:
'Variant'
|
Condition (read-only) — Condition for Variant controls
no default
This read-only field is based on the condition for the associated Variant control in
the global workspace. Create or change a Variant condition in the
Simulink.Variant parameter dialog box or in the global
workspace.
For more information, see Create Variant Controls Programmatically
and Simulink.Variant.
Show variant condition on block — Display variant condition on block icon
off (default) | on
Select Show variant condition on block to display the variant condition associated with the block on the block icon.
Open block in Variant Manager — Open Variant Manager window
no default
Click Open block in Variant Manager to open the Variant Manager.
More About
Bounded region
A bounded region is a part of a model located between one Variant Connector block where
Connector type is set to Primary and any
number of Variant Connector blocks where Connector type is set to
Nonprimary. All of the blocks in a bounded region must use the
same Connector tag parameter.
For example, this model has two bounded regions. The first region has one primary and
two nonprimary Variant Connector blocks. These blocks are connected to each other by the
connector tag Region1 and the associated variant condition A ==
1. The second region has one primary and one nonprimary Variant Connector block.
These blocks are connected to each other by the connector tag Region2 and
the associated variant condition B == 1. During simulation, when
A == 1 evaluates to true, the components in the
first region become active. When B == 1 evaluates to
false, the components in the second region become inactive.
When you create a bounded region, ensure that:
Each region has only one primary Variant Connector block. Each primary Variant Connector block is connected to at least one nonprimary Variant Connector block. All Variant Connector blocks must be connected using the port associated with condition information.
All the primary and nonprimary blocks are at the same level of model hierarchy.
Each region has a unique connector tag.
The region is bounded and has no external connections.
There are no Variant Connector blocks where the Condition type is set to
Leafinside the bounded region.No bounded regions overlap each other.
