Simple Variable Mass 3DOF (Wind Axes)

Ports

Input

expand all

F_x — Applied force along wind x-axis
scalar

Applied force along the wind x-axis, specified as a scalar, in the units selected in Units.

Data Types: double

F_z — Applied force along wind z-axis
scalar

Applied force along the wind z-axis, specified as a scalar.

Data Types: double

M — Applied pitching moment
scalar

Applied pitching moment, specified as a scalar.

Data Types: double

dm/dt — Rate of change of mass
scalar

Rate of change of mass (positive if accreted, negative if ablated), specified as a scalar.

Dependencies

To enable this port, select Include mass flow relative velocity.

Data Types: double

g — Gravity
scalar

Gravity, specified as a scalar.

Dependencies

To enable this port, set Gravity source to External.

Data Types: double

V_re — Relative velocity
two-element vector

Relative velocity at which mass is accreted to or ablated from the body in body-fixed axes, specified as a two-element vector.

Dependencies

To enable this port, select Include mass flow relative velocity.

Data Types: double

Output

expand all

γ — Flight path angle
scalar

Flight path angle, within ±pi, returned as a scalar, in radians.

Data Types: double

q — Pitch angular rate
scalar

Pitch angular rate, returned as a scalar, in radians per second.

Data Types: double

dq/dt — Pitch angular acceleration
scalar

Pitch angular acceleration, returned as a scalar, in radians per second squared.

Data Types: double

X_eZ_e — Location of body
two-element vector

Location of the body in the flat Earth reference frame, (Xe, Ze), returned as a two-element vector.

Data Types: double

V_w — Velocity in wind-fixed frame
two-element vector

Velocity of the body resolved into the wind-fixed coordinate frame, (V, 0), returned as a two-element vector.

Data Types: double

A_xbA_zb — Acceleration of body
two-element vector

Acceleration of the body with respect to the body-fixed coordinate frame, (Ax, Az), returned as a two-element vector.

Data Types: double

α — Angle of attack
scalar

Angle of attack, returned as a scalar, in radians.

Data Types: double

Fuel — Fuel tank status
scalar

Fuel tank status, returned as:

1 — Tank is full.
0 — Tank is neither full nor empty.
-1 — Tank is empty.

Dependencies

To enable this port, set Mass type to Simple Variable.

Data Types: double

A_xeA_ze — Acceleration of body
two-element vector

Accelerations of the body with respect to the inertial (flat Earth) coordinate frame, returned as a two-element vector. You typically connect this signal to the accelerometer.

Dependencies

To enable this port, select the Include inertial acceleration check box.

Data Types: double

Parameters

expand all

Main

Units — Input and output units
`Metric (MKS)` (default) | `English (Velocity in ft/s)` | `English (Velocity in kts)`

Input and output units, specified as Metric (MKS), English (Velocity in ft/s), or English (Velocity in kts).

Units	Forces	Moment	Acceleration	Velocity	Position	Mass	Inertia
`Metric (MKS)`	Newton	Newton-meter	Meters per second squared	Meters per second	Meters	Kilogram	Kilogram meter squared
`English (Velocity in ft/s)`	Pound	Foot-pound	Feet per second squared	Feet per second	Feet	Slug	Slug foot squared
`English (Velocity in kts)`	Pound	Foot-pound	Feet per second squared	Knots	Feet	Slug	Slug foot squared

Programmatic Use

Block Parameter: units

Type: character vector

Values: Metric (MKS) | English (Velocity in ft/s) | English (Velocity in kts)

Default: Metric (MKS)

Axes — Body or wind axes
`Wind` (default) | `Body`

Body or wind axes, specified as Wind or Body.

Programmatic Use

Block Parameter: axes

Type: character vector

Values: Wind | Body

Default: Wind

Mass type — Mass type
`Simple Variable` (default) | `Fixed` | `Custom Variable`

Mass type, specified according to the following table.

Mass Type	Description	Default For
`Fixed`	Mass is constant throughout the simulation.	3DOF (Body Axes) 3DOF (Wind Axes)
`Simple Variable`	Mass and inertia vary linearly as a function of mass rate.	Simple Variable Mass 3DOF (Body Axes) Simple Variable Mass 3DOF (Wind Axes)
`Custom Variable`	Mass and inertia variations are customizable.	Custom Variable Mass 3DOF (Body Axes) Custom Variable Mass 3DOF (Wind Axes)

The Simple Variable selection conforms to the equations of motion described in Algorithms.

Programmatic Use

Block Parameter: mtype

Type: character vector

Values: Fixed | Simple Variable | Custom Variable

Default: 'Simple Variable'

Initial airspeed — Initial speed
`100` (default) | scalar

Initial speed of the body, (V₀), specified as a scalar.

Programmatic Use

Block Parameter: V_ini

Type: character vector

Values: '100' | scalar

Default: '100'

Initial flight path angle — Initial flight path angle
`0` (default) | scalar

Initial flight path angle of the body, (γ₀), specified as a scalar.

Programmatic Use

Block Parameter: gamma_ini

Type: character vector

Values: '0' | scalar

Default: '0'

Initial body rotation rate — Initial pitch rotation rate
`0` (default) | scalar

Initial pitch rotation rate, (q₀), specified as a scalar.

Programmatic Use

Block Parameter: q_ini

Type: character vector

Values: '0' | scalar

Default: '0'

Initial incidence — Initial angle
`0` (default) | scalar

Initial angle between the velocity vector and the body, (α₀), specified as a scalar.

Programmatic Use

Block Parameter: alpha_ini

Type: character vector

Values: '0' | scalar

Default: '0'

Initial position (x,z) — Initial location
`[0 0]` (default) | two-element vector

Initial location of the body in the flat Earth reference frame, specified as a two-element vector.

Programmatic Use

Block Parameter: pos_ini

Type: character vector

Values: '[0 0]' | two-element vector

Default: '[0 0]'

Initial mass — Initial mass
`1.0` (default) | scalar

Initial mass of the rigid body, specified as a scalar.

Programmatic Use

Block Parameter: mass

Type: character vector

Values: '1.0' | scalar

Default: '1.0'

Empty mass — Mass of body when fuel tank is empty
`0.5` (default) | scalar

Mass of body when fuel tank is empty, specified as a scalar.

Programmatic Use

Block Parameter: mass_e

Type: character vector

Values: '0.5' | scalar

Default: '0.5'

Full mass — Mass of body when fuel tank is full
`3.0` (default) | scalar

Mass of body when fuel tank is full, specified as a scalar.

Programmatic Use

Block Parameter: mass_f

Type: character vector

Values: '3.0' | scalar

Default: '3.0'

Empty inertia body axes — Inertia of body when fuel tank is empty
`0.5` (default) | scalar

Inertia of body when fuel tank is empty, specified as a scalar.

Dependencies

To enable this parameter, set Mass type to Simple Variable.

Programmatic Use

Block Parameter: Iyy_e

Type: character vector

Values: '1.0' | scalar

Default: '1.0'

Full inertia body axes — Body inertia when fuel tank is full
`3.0` (default) | scalar

Body inertia when the fuel tank is full, specified as a scalar.

Dependencies

To enable this parameter, set Mass type to Simple Variable.

Programmatic Use

Block Parameter: Iyy_f

Type: character vector

Values: '3.0' | scalar

Default: '3.0'

Gravity Source — Gravity source
`Internal` (default) | `External`

Gravity source, specified as:

`External`	Variable gravity input to block
`Internal`	Constant gravity specified in mask

Programmatic Use

Block Parameter: g_in

Type: character vector

Values: 'Internal' | 'External'

Default: 'Internal'

Acceleration due to gravity — Gravity source
`9.81` (default) | scalar

Acceleration due to gravity, specified as a double scalar and used if internal gravity source is selected. If gravity is to be neglected in the simulation, this value can be set to 0.

Dependencies

To enable this parameter, set Gravity Source to Internal.

Programmatic Use

Block Parameter: g

Type: character vector

Values: '9.81' | scalar

Default: '9.81'

Include mass flow relative velocity — Mass flow relative velocity port
`off` (default) | `on`

Select this check box to add a mass flow relative velocity port. This is the relative velocity at which the mass is accreted or ablated.

Programmatic Use

Block Parameter: vre_flag

Type: character vector

Values: off | on

Default: 'off'

Limit mass flow when mass is empty or full — Limit mass flow
`on` (default) | `off`

Select this check box to limit the input mass flow rate when one of these is true:

Fuel tank is full and input mass flow rate is positive.
Fuel tank is empty and input mass flow rate is negative.

When the input mass flow rate might cause the mass to exceed its limits, the block uses a zero mass flow rate value in the equations of motion. For more information, see Algorithms.

If you do not want to limit the input mass flow rate, clear this check box.

Dependencies

To enable this parameter, set Mass type to Simple Variable.

Programmatic Use

Block Parameter: mdot_flag

Type: character vector

Values: 'off' | 'on'

Default: 'on'

Data Types: double

Include inertial acceleration — Include inertial acceleration port
`off` (default) | `on`

Select this check box to add an inertial acceleration in flat Earth frame output port. You typically connect this signal to the accelerometer.

Dependencies

To enable the A_xeA_ze port, select this parameter.

Programmatic Use

Block Parameter: abi_flag

Type: character vector

Values: 'off' | 'on'

Default: 'off'

State Attributes

Assign a unique name to each state. You can use state names instead of block paths during linearization.

The number of names must match the number of states, as shown for each item, or be empty. Set all or none of the block states.
To assign names to single-variable states, enter unique names between quotes, for example, 'q' or "q".
To assign names to two-variable states, enter a comma-separated list surrounded by braces, for example, {'Xe','Ze'}.
If a state parameter is empty (' '), no name is assigned.
To assign state names with a variable in the MATLAB^® workspace, enter the variable without quotes. A variable can be a character vector, cell array of character vectors, or string.

Velocity: e.g., 'V' — Velocity state name
`''` (default) | character vector

Velocity state name, specified as a character vector or string.

Programmatic Use

Block Parameter: V_statename

Type: character vector | string

Values: '' | scalar

Default: ''

Position: e.g., {'Xe', 'Ze'} — Position state name
`''` (default) | comma-separated list surrounded by braces

Position state names, specified as a comma-separated list surrounded by braces.

Programmatic Use

Block Parameter: pos_statename

Type: character vector

Values: '' | comma-separated list surrounded by braces

Default: ''

Body rotation rate: e.g., 'q' — Body rotation state name
`''` (default) | scalar

Body rotation rate state names, specified as a character vector or string.

Programmatic Use

Block Parameter: q_statename

Type: character vector | string

Values: '' | scalar

Default: ''

Flight path angle: e.g., 'gamma' — Flight path angle state name
`''` (default)

Flight path angle state name, specified as a character vector or string.

Programmatic Use

Block Parameter: gamma_statename

Type: character vector | string

Values: '' | scalar

Default: ''

Incidence angle e.g., 'alpha' — Incidence angle state name
`''` (default) | scalar

Incidence angle state name, specified as a character vector or string.

Programmatic Use

Block Parameter: alpha_statename

Type: character vector | string

Values: '' | scalar

Default: ''

Mass: e.g., 'mass' — Mass state name
`''` (default) | scalar

Mass state name, specified as a character vector or string.

Programmatic Use

Block Parameter: mass_statename

Type: character vector | string

Values: '' | scalar

Default: ''

Algorithms

The block considers the rotation in the vertical plane of a wind-fixed coordinate frame about a flat Earth reference frame.

Rotation in the vertical plane of a wind-fixed coordinate frame about a flat Earth reference frame

The equations of motion are

$\begin{array}{l} A_{x b} = A_{x e} - q V \sin α \\ A_{z b} = A_{z e} + q V \cos α \\ A_{x e} = (\frac{F_{x}}{m} - g \sin γ) \cos α - (\frac{F_{z}}{m} + g \cos γ) \sin α \\ A_{z e} = (\frac{F_{x}}{m} - g \sin γ) \sin α + (\frac{F_{z}}{m} + g \cos γ) \cos α \\ \dot{V} = \frac{(F_{x} + \dot{m} u_{r e})}{m} - g \sin γ \\ {\dot{X}}_{e} = V \cos γ \\ {\dot{Z}}_{e} = - V \sin γ \\ \dot{q} = \frac{M_{y} - {\dot{I}}_{y y} q}{I_{y y}} \\ \dot{γ} = q - \dot{α} \\ \dot{α} = \frac{(F_{z} + \dot{m} w_{r e})}{m V} + \frac{g}{V} \cos γ + q \\ {\dot{I}}_{y y} = \frac{I_{y y_f u l l} - I_{y y_e m p t y}}{m_{f u l l} - m_{e m p t y}} \dot{m} \\ I_{y y} = I_{y y_e m p t y} + (I_{y y_f u l l} - I_{y y_e m p t y}) \frac{m - m_{e m p t y}}{m_{f u l l} - m_{e m p t y}} \end{array}$

where the applied forces are assumed to act at the center of gravity of the body. Input variables are wind-axes forces F_x and F_z, body moment M_y, and $\dot{m}$ . u_re, w_re, and g are optional input variables. Mass m is limited between m_empty and m_full. Whenever mass is saturated at empty or full, for consistency, limit $\dot{m}$ within the equations of motion.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Version History

Introduced in R2006a

expand all

R2021b: Simple Variable Mass 3DOF (Wind Axes) Block Changes

The 3DOF equations of motion have been updated. Existing models created prior to R2021b that contain 3DOF equations of motion blocks continue to run. If you replace a pre-R2021b version of a 3DOF equation of motion block with an R2021b or later version, your updated model might have a higher tendency for algebraic loops. For an example of how to remove algebraic loops using unit delays, see Remove Algebraic Loops. For further information about algebraic loops, see Identify Algebraic Loops in Your Model.

Simple Variable Mass 3DOF (Wind Axes)

Description

Ports

Input

Fx — Applied force along wind x-axis scalar

Fz — Applied force along wind z-axis scalar

M — Applied pitching moment scalar

dm/dt — Rate of change of mass scalar

Dependencies

g — Gravity scalar

Dependencies

Vre — Relative velocity two-element vector

Dependencies

Output

γ — Flight path angle scalar

q — Pitch angular rate scalar

dq/dt — Pitch angular acceleration scalar

XeZe — Location of body two-element vector

Vw — Velocity in wind-fixed frame two-element vector

AxbAzb — Acceleration of body two-element vector

α — Angle of attack scalar

Fuel — Fuel tank status scalar

Dependencies

AxeAze — Acceleration of body two-element vector

Dependencies

Parameters

Main

Units — Input and output units Metric (MKS) (default) | English (Velocity in ft/s) | English (Velocity in kts)

Programmatic Use

Axes — Body or wind axes Wind (default) | Body

Programmatic Use

Mass type — Mass type Simple Variable (default) | Fixed | Custom Variable

Programmatic Use

Initial airspeed — Initial speed 100 (default) | scalar

Programmatic Use

Initial flight path angle — Initial flight path angle 0 (default) | scalar

Programmatic Use

Initial body rotation rate — Initial pitch rotation rate 0 (default) | scalar

Programmatic Use

Initial incidence — Initial angle 0 (default) | scalar

Programmatic Use

Initial position (x,z) — Initial location [0 0] (default) | two-element vector

Programmatic Use

Initial mass — Initial mass 1.0 (default) | scalar

Programmatic Use

Empty mass — Mass of body when fuel tank is empty 0.5 (default) | scalar

Programmatic Use

Full mass — Mass of body when fuel tank is full 3.0 (default) | scalar

Programmatic Use

Empty inertia body axes — Inertia of body when fuel tank is empty 0.5 (default) | scalar

Dependencies

Programmatic Use

Full inertia body axes — Body inertia when fuel tank is full 3.0 (default) | scalar

Dependencies

Programmatic Use

Gravity Source — Gravity source Internal (default) | External

Programmatic Use

Acceleration due to gravity — Gravity source 9.81 (default) | scalar

Dependencies

Programmatic Use

Include mass flow relative velocity — Mass flow relative velocity port off (default) | on

Programmatic Use

Limit mass flow when mass is empty or full — Limit mass flow on (default) | off

Dependencies

Programmatic Use

Include inertial acceleration — Include inertial acceleration port off (default) | on

Dependencies

Programmatic Use

State Attributes

Velocity: e.g., 'V' — Velocity state name '' (default) | character vector

Programmatic Use

Position: e.g., {'Xe', 'Ze'} — Position state name '' (default) | comma-separated list surrounded by braces

Programmatic Use

Body rotation rate: e.g., 'q' — Body rotation state name '' (default) | scalar

Programmatic Use

Flight path angle: e.g., 'gamma' — Flight path angle state name '' (default)

Programmatic Use

Incidence angle e.g., 'alpha' — Incidence angle state name '' (default) | scalar

Programmatic Use

Mass: e.g., 'mass' — Mass state name '' (default) | scalar

F_x — Applied force along wind x-axis
scalar

F_z — Applied force along wind z-axis
scalar

M — Applied pitching moment
scalar

dm/dt — Rate of change of mass
scalar

g — Gravity
scalar

V_re — Relative velocity
two-element vector

γ — Flight path angle
scalar

q — Pitch angular rate
scalar

dq/dt — Pitch angular acceleration
scalar

X_eZ_e — Location of body
two-element vector

V_w — Velocity in wind-fixed frame
two-element vector

A_xbA_zb — Acceleration of body
two-element vector

α — Angle of attack
scalar

Fuel — Fuel tank status
scalar

A_xeA_ze — Acceleration of body
two-element vector

Units — Input and output units
`Metric (MKS)` (default) | `English (Velocity in ft/s)` | `English (Velocity in kts)`

Axes — Body or wind axes
`Wind` (default) | `Body`

Mass type — Mass type
`Simple Variable` (default) | `Fixed` | `Custom Variable`

Initial airspeed — Initial speed
`100` (default) | scalar

Initial flight path angle — Initial flight path angle
`0` (default) | scalar

Initial body rotation rate — Initial pitch rotation rate
`0` (default) | scalar

Initial incidence — Initial angle
`0` (default) | scalar

Initial position (x,z) — Initial location
`[0 0]` (default) | two-element vector

Initial mass — Initial mass
`1.0` (default) | scalar

Empty mass — Mass of body when fuel tank is empty
`0.5` (default) | scalar

Full mass — Mass of body when fuel tank is full
`3.0` (default) | scalar

Empty inertia body axes — Inertia of body when fuel tank is empty
`0.5` (default) | scalar

Full inertia body axes — Body inertia when fuel tank is full
`3.0` (default) | scalar

Gravity Source — Gravity source
`Internal` (default) | `External`

Acceleration due to gravity — Gravity source
`9.81` (default) | scalar

Include mass flow relative velocity — Mass flow relative velocity port
`off` (default) | `on`

Limit mass flow when mass is empty or full — Limit mass flow
`on` (default) | `off`

Include inertial acceleration — Include inertial acceleration port
`off` (default) | `on`

Velocity: e.g., 'V' — Velocity state name
`''` (default) | character vector

Position: e.g., {'Xe', 'Ze'} — Position state name
`''` (default) | comma-separated list surrounded by braces

Body rotation rate: e.g., 'q' — Body rotation state name
`''` (default) | scalar

Flight path angle: e.g., 'gamma' — Flight path angle state name
`''` (default)

Incidence angle e.g., 'alpha' — Incidence angle state name
`''` (default) | scalar

Mass: e.g., 'mass' — Mass state name
`''` (default) | scalar

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.