fixedWingThrust

Define thrust vector on fixed-wing aircraft

Since R2021b

Syntax

thrust = fixedWingThrust(name)

thrust = fixedWingThrust(name,controllable)

thrust = fixedWingThrust(name,controllable,symmetry)

thrust = fixedWingThrust(name,controllable,symmetry,bounds)

thrust = fixedWingThrust(Name=Value)

Description

thrust = fixedWingThrust(name) returns a fixed-wing thrust object with a specified component, name.

thrust = fixedWingThrust(name,controllable) returns a fixed-wing thrust object specifying the controllability, controllable, of the thrust.

thrust = fixedWingThrust(name,controllable,symmetry) returns a fixed-wing thrust object specifying the symmetry, symmetry, of the thrust.

thrust = fixedWingThrust(name,controllable,symmetry,bounds) returns a fixed-wing thrust object specifying the bounds, bounds, of the thrust.

thrust = fixedWingThrust(Name=Value) returns a fixed-wing thrust object with one or more Name=Value arguments.

Examples

Create Fixed-Wing Thrust Object

Create a fixed-wing thrust object named MyThrust.

thrust = fixedWingThrust("MyThrust")

thrust = 
  Thrust with properties:

        Coefficients: [1×1 Aero.FixedWing.Coefficient]
        MaximumValue: 1
        MinimumValue: 0
        Controllable: on
            Symmetry: "Symmetric"
    ControlVariables: "MyThrust"
          Properties: [1×1 Aero.Aircraft.Properties]

Create Asymmetric Thrust Object

Create an asymmetric fixed-wing thrust object named MyThrust using arguments.

thrust = fixedWingThrust("MyThrust","on","asymmetric")

thrust = 
  Thrust with properties:

        Coefficients: [1×1 Aero.FixedWing.Coefficient]
        MaximumValue: 1
        MinimumValue: 0
        Controllable: on
            Symmetry: "Asymmetric"
    ControlVariables: ["MyThrust_1"    "MyThrust_2"]
          Properties: [1×1 Aero.Aircraft.Properties]

Input Arguments

name — Fixed-wing aircraft thrust name

scalar string

Fixed-wing aircraft thrust name, specified as a scalar string.

Data Types: char | string

controllable — Controllable thrust value

'off' (default) | 'on'

Controllable thrust value, specified as 'on' or 'off'. To control the control thrust, set this property to 'on'. Otherwise, set this property to 'off'.

Data Types: string

symmetry — Symmetry of thrust control

Symmetric (default) | Asymmetric

Symmetry of thrust control, specified as Symmetric or Asymmetric.

The Asymmetric option creates two control variables, denoted by the name on the properties and appended by _1 and _2. These control variables can be independently controlled, but also produce an effective control variable specified by the name on the properties. This equation defines the control variable:

name = (name_1-name_2)/2.

You cannot set this effective control variable.

Data Types: string

bounds — Lower and upper bounds

[-inf,inf] (default) | two-element numeric vector

Lower and upper bounds of controllable thrust, specified as a two-element numeric vector.

Data Types: double

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.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'MaximumValue','500'

Coefficients — Aero.FixedWing.Coefficients object

scalar

Aero.FixedWing.Coefficients object, specified as a scalar, that defines the thrust vector.

MaximumValue — Maximum thrust value

1 (default) | scalar | scalar numeric

Maximum thrust value, specified as a scalar numeric.

Dependencies

If Symmetry is set to Asymmetric, then this value applies to both control variables.

Data Types: double

MinimumValue — Minimum thrust value

0 (default) | scalar numeric

Minimum thrust value, specified as a scalar numeric.

Dependencies

If Symmetry is set to Asymmetric, then this value applies to both control variables.

Data Types: double

Controllable — Controllable thrust value

on (default) | off

To control the thrust value, set this property to on. Otherwise, set this property to off.

Data Types: double

Symmetry — Symmetry of thrust control

Symmetric (default) | Asymmetric

Symmetry of the thrust control, specified as Symmetric or Asymmetric.

The Asymmetric option creates two control variables, denoted by the name on the properties and appended by _1 and _2. These control variables can be independently controlled, but also produce an effective control variable specified by the name on the properties. This equation defines the control variable:

name = (name_1-name_2)/2.

You cannot set this effective control variable.

Data Types: char | string

Properties — Aero.Aircraft.Properties object

scalar

Aero.Aircraft.Properties object, specified as a scalar.

Output Arguments

thrust — Aero.FixedWing.Thrust object

scalar

Aero.FixedWing.Thrust object, returned as a scalar.

Version History

Introduced in R2021b