fixedWingCoefficient

Define numeric coefficients of fixed-wing aircraft

Since R2021b

Syntax

coefficient = fixedWingCoefficient( )

coefficient = fixedWingCoefficient(statevariables)

coefficient = fixedWingCoefficient(statevariables,referenceframe)

coefficient = fixedWingCoefficient(statevariables,referenceframe,multiplystatevariables)

coefficient = fixedWingCoefficient(statevariables,referenceframe,multiplystatevariables,nondimensional)

coefficient = fixedWingCoefficient(___,Name=Value)

Description

coefficient = fixedWingCoefficient( ) returns a fixed-wing coefficient object with default properties.

coefficient = fixedWingCoefficient(statevariables) returns a fixed-wing coefficient object with the specified state variables, statevariables.

coefficient = fixedWingCoefficient(statevariables,referenceframe) returns a fixed-wing coefficient object with the specified reference frame, referenceframe.

coefficient = fixedWingCoefficient(statevariables,referenceframe,multiplystatevariables) returns a fixed-wing coefficient object with the specified multiply state variables switch, multiplystatevariables.

coefficient = fixedWingCoefficient(statevariables,referenceframe,multiplystatevariables,nondimensional) returns a fixed-wing coefficient object with the specified nondimensional switch, nondimensional.

coefficient = fixedWingCoefficient(___,Name=Value) returns a fixed-wing coefficient object created with one or more Name=Value arguments.

Examples

Define Fixed-Wing Aircraft Numeric Coefficients

This example shows how to create fixed-wing coefficient objects.

Create Fixed-Wing Coefficient Object

Create a fixed-wing coefficient object.

coeffs = fixedWingCoefficient( )

coeffs = 
  Coefficient with properties:

                     Table: [6x1 table]
                    Values: {6x1 cell}
            StateVariables: "Zero"
               StateOutput: [6x1 string]
            ReferenceFrame: "Wind"
    MultiplyStateVariables: on
            NonDimensional: on
                Properties: [1x1 Aero.Aircraft.Properties]

Create Fixed-Wing Coefficient Object with Specified State Variables

Create a fixed-wing coefficient object in the body frame with nondimensional coefficients and nondefault state variables.

coeffs = fixedWingCoefficient(["U","Alpha"],"body","on","off")

coeffs = 
  Coefficient with properties:

                     Table: [6x2 table]
                    Values: {6x2 cell}
            StateVariables: ["U"    "Alpha"]
               StateOutput: [6x1 string]
            ReferenceFrame: "Body"
    MultiplyStateVariables: on
            NonDimensional: off
                Properties: [1x1 Aero.Aircraft.Properties]

Input Arguments

statevariables — State variable names

'Zero' (default) | 1-by-N of strings

State variable names, specified as a 1-by-N vector of strings. Each entry in this property corresponds to a column in the Values property. Each entry in StateVariables must be a valid property in the Aero.FixedWing.State object. Adding a state variable adds a column of zeros to the end of the Values cell array.

Tip

This argument also exists as the Name=Value argument StateVariables. If you specify the StateVariables Name=Value argument, its value supersedes the statevariables argument.

Data Types: string

referenceframe — Reference frame for coefficients

'Wind' (default) | 'Body' | 'Stability'

Reference frame for coefficients, specified as 'Wind', 'Body', or 'Stability' with these outputs.

Reference Frame	Coefficient Output
Wind	Forces: drag (CD) Y (CY) lift (CL)
	Moments: L (Cl) M (Cm) N (Cn)
Body	Forces: X (CX) Y (CY) Z (CZ)
	Moments: L (Cl) M (Cm) N (Cn)
Stability	Forces: drag (CD) Y (CY) lift (Cn)
	Moments: L (Cl) M (Cm) N (Cn)

Example of 'Wind' table:

Coefficient	State
CD	state
CY	state
CL	state
Cl	state
Cm	state
Cn	state

Example of 'Body' table:

Coefficient	State
CX	state
CY	state
CZ	state
Cl	state
Cm	state
Cn	state

Tip

This argument also exists as the name-value argument ReferenceFrame. If you specify the ReferenceFrame name-value argument, its value supersedes the referenceframe argument.

Data Types: string

multiplystatevariables — Option to multiply coefficients by state variables

'on' (default) | 'off'

Option to multiply coefficients by state variables when calculating forces and moments. To multiply coefficients by state variables, set this property to 'on'. Otherwise, set this property to 'off'.

Tip

This argument also exists as the name-value argument MultiplyStateVariables. If you specify the MultiplyStateVariables name-value argument, its value supersedes the multiplystatevariables argument.

Data Types: string

nondimensional — Option to specify nondimensional coefficients

'on' (default) | 'off'

Option to specify nondimensional coefficients, specified as 'on' or 'off'. To specify nondimensional coefficients, set this property to 'on'. Otherwise, set this property to 'off'.

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: 'ReferenceFrame','Body'

Table — Coefficient values

6-by-N table

Coefficient values, specified in a 6-by-N table. Each row in the table must be a member of and in the same order as the StateOutput property.

Setting the Table property also sets the contents of the Values property and StateVariables to the Table property variables. To have a Simulink.LookupTable object and a constant value in the same column, use the setCoefficient function or set the desired content of the Values property. Setting the Table property does not set the ReferenceFrame.

Note

Tables must have a single data type per column. If there are both constant values and Simulink.LookupTable objects in a given column, the Table property automatically converts the constants to Simulink.LookupTable objects.

Data Types: double

Values — Coefficient values

6-by-N cell array

Coefficient values, specified as a 6-by-N cell array. Each entry in the cell array must be a single coefficient value corresponding to the StateOutput (row) and StateVariable (column) properties. Each coefficient value must be a scalar numeric value or a Simulink.LookupTable object. If a value is a Simulink.LookupTable object, the FieldName of each breakpoint must be a valid property of the Aero.FixedWing.State object.

Note

Values do need to be a single data type per column.

Data Types: double

StateVariables — State variable names

'Zero' (default) | 1-by-N vector of strings

State variable names, specified as a 1-by-N vector of strings. Each entry in this property corresponds to a column in the Values property. Each entry in StateVariables must be a valid property in the Aero.FixedWing.State object. Adding a state variable adds a column of zeros to the end of the Values cell array.

Tip

This argument also exists as the statevariables argument. If you specify the StateVariables name-value argument, its value supersedes the statevariables argument.

Data Types: char | string

ReferenceFrame — Reference frame for coefficients

'Wind' (default) | 'Body'

Reference frame for coefficients, specified as 'Wind' or 'Body with these outputs.

Reference Frame	Coefficient Output
Wind	Forces: drag (CD) Y (CY) lift (CL)
	Moments: L (Cl) M (Cm) N (Cn)
Body	Forces: X (CX) Y (CY) Z (CZ)
	Moments: L (Cl) M (Cm) N (Cn)

Example of 'Wind' table:

Coefficient	State
CD	state
CY	state
CL	state
Cl	state
Cm	state
Cn	state

Example of 'Body' table:

Coefficient	State
CX	state
CY	state
CZ	state
Cl	state
Cm	state
Cn	state

Tip

This argument also exists as the referenceframe argument. If you specify the ReferenceFrame name-value argument, its value supersedes the referenceframe argument.

Data Types: char | string

MultiplyStateVariables — Option to multiply coefficients by state variables

'on' (default) | 'off'

Option to multiply coefficients by state variables when calculating forces and moments, specified as 'on' or 'off'. To multiply coefficients by state variables, set this property to 'on'. Otherwise, set this property to 'off'.

Tip

This argument also exists as the multiplystatvariables argument. If you specify the MultiplyStateVariables name-value argument, its value supersedes the multiplystatvariables argument.

NonDimensional — Option to specify nondimensional coefficients

'on' (default) | 'off'

Option to specify nondimensional coefficients, specified as 'on' or 'off'. To specify nondimensional coefficients, set this property to 'on'. Otherwise, set this property to 'off'.

Tip

This argument also exists as the nondimensional argument. If you specify the NonDimensional name-value argument, its value supersedes the nondimensional argument.

Properties — Aero.Aircraft.Properties object

scalar

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

Output Arguments

coefficient — Aero.FixedWing.Coefficient object

scalar

Fixed-wing aircraft coefficient returned as a scalar Aero.FixedWing.Coefficient object.

Version History

Introduced in R2021b