addShortPeriodRequirementFunctions

Class: Aero.FixedWing.Specification
Namespace: Aero

Add custom requirement functions for short period modes

Since R2025a

expand all in page

Syntax

specificationOut = addShortPeriodRequirementFunctions(specificationIn,customFunction)

Description

specificationOut = addShortPeriodRequirementFunctions(specificationIn,customFunction) adds custom requirement functions for phugoid modes. Use addShortPeriodRequirementFunctions if you want to add custom requirements for your analysis.

Input Arguments

expand all

Aero.FixedWing.Specification object, specified as a scalar.

Custom requirements function, specified as a scalar function handle. The function must have these inputs:

  • zeta — Damping ratio.

  • wn — Natural frequency.

  • wd — Damped natural frequency.

  • T2 — Time to double or negative time to halve.

The function must return a logical, true (1) or false (0).

For more information, see Properties.

Output Arguments

expand all

Aero.FixedWing.Specification object, returned as the modified Aero.FixedWing.Specification object.

Examples

expand all

Open Live Script

Add a custom requirement function for short period mode.

Create an Aero.FixedWing.Specification object.

spec = Aero.FixedWing.Specification;

Create the custom short period mode requirement function shortPeriodFcn.

shortPeriodFcn = @(zeta,wn,wd,T2)zeta*wn>=0.05
shortPeriodFcn = function_handle with value:
    @(zeta,wn,wd,T2)zeta*wn>=0.05

Add the shortPeriodFcn function to the Aero.FixedWing.Specification object.

spec = addShortPeriodRequirementFunctions(spec,shortPeriodFcn)
spec = 
  Specification with properties:

           Phugoid: [1×1 Aero.FixedWing.FlyingQuality.PhugoidMode]
       ShortPeriod: [1×1 Aero.FixedWing.FlyingQuality.ShortPeriodMode]
         DutchRoll: [1×1 Aero.FixedWing.FlyingQuality.DutchRollMode]
            Spiral: [1×1 Aero.FixedWing.FlyingQuality.SpiralMode]
    RollSubsidence: [1×1 Aero.FixedWing.FlyingQuality.RollSubsidenceMode]
        Properties: [1×1 Aero.Aircraft.Properties]

Version History

Introduced in R2025a

See Also