find

Find blocks in linearization results that match specific criteria

Syntax

result = find(advisor,query)

Description

When you linearize a Simulink^® model, you can create a LinearizationAdvisor object that contains diagnostic information about individual block linearizations. To find block linearizations that satisfy specific criteria, you can use the find function with custom query objects. Alternatively, you can analyze linearization diagnostics using the Linearization Advisor in the Model Linearizer. For more information on finding specific blocks in linearization results, see Find Blocks in Linearization Results Matching Specific Criteria.

result = find(advisor,query) returns the subset of block diagnostics in advisor that match the search criteria specified in query.

Examples

Find Blocks on Linearization Path

Load Simulink model.

mdl = 'scdspeed';
load_system(mdl)

Linearize the model and obtain LinearizationAdvisor object.

opts = linearizeOptions('StoreAdvisor',true);
io(1) = linio('scdspeed/throttle (degrees)',1,'input');
io(2) = linio('scdspeed/rad//s to rpm',1,'output');
[sys,~,info] = linearize(mdl,io,opts);
advisor = info.Advisor;

Create a query object for finding blocks on the linearization path.

query = linqueryIsOnPath;

Find blocks using query object.

advOnPath = find(advisor,query)

advOnPath = 
  LinearizationAdvisor with properties:

               Model: 'scdspeed'
      OperatingPoint: [1×1 opcond.OperatingPoint]
    BlockDiagnostics: [26×1 linearize.advisor.BlockDiagnostic]
           QueryType: 'On Linearization Path'

Find All SISO Blocks

Load the Simulink model.

mdl = 'scdspeed';
load_system(mdl)

Linearize the model and obtain the LinearizationAdvisor object.

opts = linearizeOptions('StoreAdvisor',true);
io(1) = linio('scdspeed/throttle (degrees)',1,'input');
io(2) = linio('scdspeed/rad//s to rpm',1,'output');
[sys,op,info] = linearize(mdl,io,opts);
advisor = info.Advisor;

Create compound query object for finding all blocks with one input and one output.

qSISO = linqueryHasInputs(1) & linqueryHasOutputs(1);

Find all SISO blocks using compound query object.

advSISO = find(advisor,qSISO)

advSISO = 
  LinearizationAdvisor with properties:

               Model: 'scdspeed'
      OperatingPoint: [1×1 opcond.OperatingPoint]
    BlockDiagnostics: [10×1 linearize.advisor.BlockDiagnostic]
           QueryType: '(Has 1 Inputs & Has 1 Outputs)'

Input Arguments

advisor — Diagnostic information for block linearizations

LinearizationAdvisor object | array of LinearizationAdvisor objects

Diagnostic information for block linearizations, specified as a LinearizationAdvisor object or an array of LinearizationAdvisor objects.

query — Search criteria

CompoundQuery object | linqueryIsOnPath object | linqueryHasDiagnostics object | linqueryHasOrder object | ...

Search criteria, specified as one of the following query objects or a logical combination of query objects (CompoundQuery object).

Query Object	Find Blocks That...
linqueryAdvise	Are potentially problematic for linearization.
linqueryAllBlocks	Are in the advisor object.
linqueryContributesToLinearization	Numerically contribute to the model linearization result.
linqueryHasDiagnostics	Have diagnostic messages regarding their linearization.
linqueryHasInputs	Have a specified number of inputs.
linqueryHasOrder	Have a specified number of states.
linqueryHasOutputs	Have a specified number of outputs.
linqueryHasSampleTime	Have a specified sample time.
linqueryHasZeroIOPair	Have at least one input/output pair that linearizes to zero.
linqueryIsBlockSubstituted	Have a custom block linearization specified.
linqueryIsBlockType	Are of a specified type.
linqueryIsExact	Are linearized using their defined exact linearization.
linqueryIsNumericallyPerturbed	Are linearized using numerical perturbation.
linqueryIsOnPath	Are on the linearization path.
linqueryIsZero	Linearize to zero.

To create a compound query, combine these queries using AND (&), OR (|), and NOT (~) logical operations. For example, to find all blocks on the linearization path that do not contribute to the model linearization result, use:

compundQuery = linqueryIsOnPath & ~linqueryContributesToLinearization

Output Arguments

result — Diagnostic information for blocks that match the search criteria

LinearizationAdvisor object | array of LinearizationAdvisor objects

Diagnostic information for blocks that match the search criteria specified in query, returned as:

• LinearizationAdvisor object if advisor is a single LinearizationAdvisor object.

• A LinearizationAdvisor object with the same dimensions as advisor if advisor is an array.

Version History

Introduced in R2017b