setShortPeriodRequirements

Class: Aero.FixedWing.Specification
Namespace: Aero

Set requirements for short period mode for flying quality analysis

Since R2025a

Syntax

specificationOut = setShortPeriodRequirements(specificationIn,Name=Value)


Description

specificationOut = setShortPeriodRequirements(specificationIn,Name=Value) sets requirements for short period mode for flying quality analysis.

Input Arguments

specificationIn — Aero.FixedWing.Specification object

object

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

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: MinDampingRatio=10

MinDampingRatio — Minimum damping ratio

scalar

Minimum damping ratio, specified as a scalar. For more information, see Properties.

Data Types: double

MaxDampingRatio — Maximum damping ratio

scalar

Maximum damping ratio, specified as a scalar. For more information, see Properties.

Data Types: double

MaxRelativeAmplitude — Maximum relative amplitude

scalar

Maximum relative amplitude, specified as a scalar. For more information, see Properties.

Data Types: double

Ncycles — N cycles for MaxRelativeAmplitude

7 (default) | scalar integer

N cycles for MaxRelativeAmplitude, specified as a scalar integer. For more information, see Properties.

MaxTimeToHalf — Maximum time to halve amplitude of flight mode

scalar

Maximum time to halve amplitude of flight mode, specified as a scalar, in seconds. For more information, see Properties.

Data Types: double

MaxTimeToDouble — Maximum time to double amplitude of flight mode

scalar

Maximum time to double amplitude of flight mode, specified as a scalar, in seconds. For more information, see Properties.

Data Types: double

MinTimeToDouble — Maximum time to double amplitude of flight mode

scalar

Maximum time to double amplitude of flight mode, specified as a scalar, in seconds. For more information, see Properties.

Data Types: double

MinNaturalFrequency — Minimum natural frequency of oscillatory mode

scalar

Minimum natural frequency of oscillatory mode, specified as a scalar, in rad/s. For more information, see Properties.

Data Types: double

MaxNaturalFrequency — Maximum natural frequency of oscillatory mode

scalar

Maximum natural frequency of oscillatory mode, specified as a scalar, in rad/s. For more information, see Properties.

Data Types: double

Output Arguments

specificationOut — Aero.FixedWing.Specification object

scalar

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

Examples

Set Requirement for Short Period Mode

Set requirement for short period mode MinDampingRatio for flying quality analysis.

Create an Aero.FixedWing.Specification object.

spec = Aero.FixedWing.Specification;

Set the requirement for short period mode MinDampingRatio for flying quality analysis.

spec = setShortPeriodRequirements(spec,MinDampingRatio=10);

View the short period mode updates.

spec.ShortPeriod

ans = 
  ShortPeriodMode with properties:

         MinDampingRatio: 10
         MaxDampingRatio: Inf
     MinNaturalFrequency: 0
     MaxNaturalFrequency: Inf
           MaxTimeToHalf: Inf
         MinTimeToDouble: -Inf
    MaxRelativeAmplitude: Inf
                 NCycles: 7
                  Active: 1
                    Name: "Short-Period Mode"
    RequirementFunctions: {}

Version History

Introduced in R2025a