getCoefficient

Class: Aero.FixedWing.Surface
Namespace: Aero

Get coefficient for fixed-wing surface object

Since R2021a

Syntax

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


Description

value = getCoefficient(fixedWingSurface,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

fixedWingSurface — Aero.FixedWing.Surface object for which to get coefficient

scalar

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

stateOutput — State output

6-by-1 vector

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

stateVariable — State variable

vector

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: 'Component','Hello'

State — Aero.FixedWing.State object to calculate numeric values of Simulink.LookupTable objects

scalar

Aero.FixedWing.State object to calculate numeric values of Simulink.LookupTable objects, specified as a scalar.

Data Types: double

Component — Valid component Name

scalar

Valid component name, specified as a scalar string. Valid component names depend on the 'Name' property of an object and all its subcomponents. The default component is the current object.

Data Types: char | string

Output Arguments

value — Coefficient values

vector

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 Vector	Vector
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

Version History

Introduced in R2021a