Main Content

getCoefficient

Class: Aero.FixedWing.Coefficient
Package: Aero

Get coefficient values from fixed-wing coefficient object

Syntax

value = getCoefficient(fixedWingCoefficient,stateOutput,stateVariable)
value = getCoefficient(___,Name,Value)

Description

value = getCoefficient(fixedWingCoefficient,stateOutput,stateVariable) gets the coefficient value value from the coefficient specified by stateOutput and stateVariable.

value = getCoefficient(___,Name,Value) gets the coefficient value using one or more Name,Value pairs.

Input Arguments

expand all

Aero.FixedWing.Coefficient object for which to get coefficient, specified as a scalar.

State output, specified as a 6-by-1 vector where each entry is a valid state output. For more information on state outputs, see Aero.FixedWing.Coefficient.

Data Types: char | string

State variable, specified as a vector where each entry is a valid state variable. Valid state variables depend on the coefficients defined on the object. For more information on fixed-wing states, see Aero.FixedWing.State.

Data Types: char | string

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: 'State','on'

Aero.FixedWing.State object, specified as a scalar, that calculates the numeric values of any Simulink.LookupTable objects. Including an Aero.FixedWing.State guarantees value is a numeric vector.

Data Types: char | string

Component name, specified as a string. Valid component names depend on the object properties and all subcomponents on the object. The default component name is the current object.

Data Types: char | string

Output Arguments

expand all

Coefficient values, returned as a vector of the same size as stateOutput and stateVariable. Vector contents depend on the type of coefficients in the vector.

Type of Coefficients in VectorVector

All numeric constants

Numeric vector

Simulink.LookupTable objects

Vector of Simulink.LookupTable objects

Mix of numeric constants and Simulink.LookupTable objects

Vector of cells

Simulink.LookupTable objects with state included

Numeric vector

Examples

expand all

Get a CD_alpha on a fixed-wing coefficient object.

C182 = astC182();
CD_alpha = getCoefficient(C182, "CD", "Alpha")
CD_alpha =

    0.1210

Get a vector of coefficient values on a component within a fixed-wing coefficient object.

C182 = astC182();
coeffs = getCoefficient(C182, ["CY"; "Cm"], ["Aileron"; "Aileron"], "Component", "Aileron")
coeffs =

     0     0

Get a Simulink.LookupTable coefficient from a fixed-wing coefficient object.

SkyHogg = astSkyHogg();
Cl_zero = getCoefficient(SkyHogg, "Cl", "Zero")
Cl_zero =

     0

Get a Simulink.LookupTable coefficient from a fixed-wing coefficient object and include a state.

[SkyHogg, CruiseState] = astSkyHogg();
Cl_zero = getCoefficient(SkyHogg, "Cl", "Zero", "State", CruiseState)
Cl_zero =

     0

Limitations

  • The vectors for the stateOutput, stateVariable, and value arguments must be the same length.

  • When used with Simulink.LookupTable objects, this method requires a Simulink® license.

Version History

Introduced in R2021a