`aerodynamic_coefficients`¶

This module contains the factory functions for setting up the aerodynamic coefficient models of (artificial and natural) bodies in an environment.

The main interfaces with Tudat is the aerodynamic_coefficient_settings attribute of the body settings, which defines settings for the aerodynamic coefficients of a body. The functions in this submodule are used to create this settings objects.

The coefficient models create from the settings defined by these settings are used by the aerodynamic() acceleration model and aerodynamic() torque model.

The functions in this module can be used to define force and/or moment coefficients. The frame in which the coefficients are to be provided can be defined by the user through the appropriate AerodynamicCoefficientFrames input. For instance, when wanting to provide \(C_{D},C_{S},C_{L}\), positive_body_fixed_frame_coefficients is used. When wanting to provide \(C_{X},C_{Y},C_{Z}\), negative_aerodynamic_frame_coefficients is used.

In the definition of moment coefficients, a reference point w.r.t. which aerodynamic moment coefficients are defined must be provided. This moment_reference_point`1 variable is used to calculate the contribution of the aerodynamic force coefficients to the effective moment coefficients See the ``add_force_contribution_to_moments attribute of the AerodynamicCoefficientSettings for more details. If the present input is set to NaN (as is the default), the reference point is left undefined, and the aerodynamic moments are computed without computing any force coefficient contribution to the moment coefficients.

Within the aerodynamic coefficient settings that are created, the user may also add settings for control surface aerodynamic coefficient settings. These settings must use the same reference area, reference length and reference point as the vehicle coefficient settings. See custom_control_surface() for an example of how to create and set control surface coefficients. If control surface coefficient are set, the control surface deflection set through set_control_surface_deflection can be used during every time step to control the surface deflection \(\delta\). The coefficients (\(C_{L}\) shown for example) used during the propagation then become

\[C_{L}(...)=C_{L,0}(...)+\sum_{i}^{N}\Delta C_{L,i}(..., \delta_{i})\]

where \(C_{L,0}\) are the nominal coefficients (with control surfaces) defined by the coefficient settings, \(...\) denote the independent variables (except control surface deflection) as a function of which the coefficients are calculated, \(\Delta C_{L,i}\) denotes the control surface coefficient increment due to control surface \(i\) (for \(N\) control surfaces), and \(\delta_{i}\) is the current deflection of this surface.

Functions¶

`constant`(reference_area, ...)	Function for creating aerodynamic interface model settings entirely from constant coefficients.
`constant_force_and_moment`(reference_length, ...)	Function for creating aerodynamic interface model settings entirely from constant coefficients.
`custom_aerodynamic_force_coefficients`(...)	Function for creating aerodynamic interface model settings from custom coefficients.
`custom_aerodynamic_force_and_moment_coefficients`(...)	Function for creating aerodynamic interface model settings from custom coefficients.
`tabulated`(independent_variables, ...)	Function for creating aerodynamic interface model settings from user-defined, 1-d tabulated coefficients.
`tabulated_force_only`(independent_variables, ...)	Function for creating aerodynamic interface model settings from user-defined, 1-d tabulated force coefficients.
`tabulated_from_files`(...)	Function for creating aerodynamic interface model settings from tabulated coefficients from files.
`tabulated_force_only_from_files`(...)	Function for creating aerodynamic interface model settings from tabulated force coefficients from files.
`scaled_by_constant`(...[, is_scaling_absolute])	Function for creating aerodynamic interface model settings by applying one constant scaling factor/value to all coefficients of an existing model settings object.
`scaled_by_vector`(...[, is_scaling_absolute])	Function for creating aerodynamic interface model settings by applying constant scaling factors/values to the coefficients of an existing model settings object.
`scaled_by_vector_function`(...[, ...])	Function for creating aerodynamic interface model settings by applying custom scaling factors/values to the coefficients of an existing model settings object.
`custom_control_surface`(...)	Function for creating control surface aerodynamic model settings from custom coefficients.
`tabulated_from_files_control_surface`(...)	Function for creating control surface aerodynamic model settings from tabulated coefficients from files.

constant(reference_area: float, constant_force_coefficient: numpy.ndarray[numpy.float64[3, 1]], force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings entirely from constant coefficients.

Function for settings object, defining aerodynamic interface model entirely from constant aerodynamic force coefficients, i.e. coefficients are not a function of any independent variables.

Note that this function does not define any moment coefficients.

Parameters:

reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
constant_force_coefficient (numpy.ndarray) – Constant force coefficients.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) –

Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic
frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))

Returns:

Instance of the AerodynamicCoefficientSettings derived ConstantAerodynamicCoefficientSettings class

Return type:

ConstantAerodynamicCoefficientSettings

Examples

In this example, we create AerodynamicCoefficientSettings for the artificial body “Vehicle”, using only constant aerodynamic coefficients:

# Define the reference area and constant aerodynamic coefficients
reference_area = 20.0
drag_coefficient = 1.5
lift_coefficient = 0.3
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.constant(
    reference_area,
    constant_force_coefficient=[drag_coefficient, 0, lift_coefficient],
    force_coefficients_frame=environment.negative_aerodynamic_frame_coefficients,
)
# Assign aerodynamic coefficient settings to the vehicle settings
body_settings.get( "Vehicle" ).aerodynamic_coefficient_settings = aero_coefficient_settings

constant_force_and_moment(reference_length: float, reference_area: float, moment_reference_point: numpy.ndarray[numpy.float64[3, 1]], constant_force_coefficient: numpy.ndarray[numpy.float64[3, 1]], constant_moment_coefficient: numpy.ndarray[numpy.float64[3, 1]], force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>, moment_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.positive_body_fixed_frame_coefficients: 0>) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings entirely from constant coefficients.

Function for settings object, defining aerodynamic interface model entirely from constant aerodynamic force and moment coefficients, i.e. coefficients are not a function of any independent variables.

Parameters:

reference_length (float) – Reference length with which aerodynamic moments are non-dimensionalized.
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
moment_reference_point (numpy.ndarray[numpy.float64[3, 1]] = np.full([3, 1], np.nan)) – Point w.r.t. aerodynamic moment coefficients are defined. This variable is used to calculate the contribution of the aerodynamic force coefficients to the effective moment coefficients. See the add_force_contribution_to_moments attribute of the AerodynamicCoefficientSettings for more details. If the present input is set to NaN (as is the default), the reference point is left undefined, and the aerodynamic moments are computed without computing any force coefficient contribution to the moment coefficients.
constant_force_coefficient (numpy.ndarray) – Constant force coefficients.
constant_moment_coefficient (numpy.ndarray) – Constant moment coefficients.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))
moment_coefficients_frame (AerodynamicCoefficientFrames, default = positive_body_frame_coefficients) – Variable defining the frame in which the moment coefficients are defined. By default, this is the positive body frame, so that the coefficients are roll, pitch and yaw (\(C_{l}, C_{m}, C_{n}\))

Returns:

Instance of the AerodynamicCoefficientSettings derived ConstantAerodynamicCoefficientSettings class

Return type:

ConstantAerodynamicCoefficientSettings

Examples

In this example, we create AerodynamicCoefficientSettings for the artificial body “Vehicle”, using only constant aerodynamic coefficients:

# Define the reference area and constant aerodynamic coefficients
reference_area = 20.0
drag_coefficient = 1.5
lift_coefficient = 0.3
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.constant(
    reference_area,
    constant_force_coefficient=[drag_coefficient, 0, lift_coefficient],
    force_coefficients_frame=environment.negative_aerodynamic_frame_coefficients,
)
# Assign aerodynamic coefficient settings to the vehicle settings
body_settings.get( "Vehicle" ).aerodynamic_coefficient_settings = aero_coefficient_settings

custom_aerodynamic_force_coefficients(force_coefficient_function: Callable[[list[float]], numpy.ndarray[numpy.float64[3, 1]]], reference_area: float, independent_variable_names: list[tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables], force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings from custom coefficients.

Function for settings object, defining aerodynamic interface model via a custom force coefficient function (function of independent variable).

See custom models for more details on how to create custom models in Tudat.

Note that this function does not define any moment coefficients.

Parameters:

force_coefficient_function (callable[[list[float]], numpy.ndarray[numpy.float64[3, 1]]]) – Function that is defining the aerodynamic coefficients as function of an independent variable (see arg independent_variable_names).
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
independent_variable_name (list[AerodynamicCoefficientsIndependentVariables]) – Vector with identifiers for the independent variable w.r.t. which the aerodynamic coefficients are defined.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))

Returns:

Instance of the AerodynamicCoefficientSettings derived CustomAerodynamicCoefficientSettings class

Return type:

CustomAerodynamicCoefficientSettings

Examples

In this example, we create AerodynamicCoefficientSettings for the artificial body “Vehicle”, using a function based on the mach number:

def force_coefficients(variables_list):
  # Extract the mach number
  mach_number = variables_list[0]
  # If the mach number is below 3, use fixed coefficients
  if mach_number <= 3:
      return [0.99, 0, 1.08]
  # Same if the mach number is above 10
  elif mach_number >= 10:
      return [0.82, 0, 0.88]
  # Otherwise, vary linearly between the ones at M=3 and M=10
  CD = 1.0667-0.02457*mach_number
  CL = 1.1636-0.02786*mach_number
  return [CD, 0, CL]
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.custom(
    force_coefficients,
    reference_area=1.50,
    independent_variable_names=[AerodynamicCoefficientsIndependentVariables.mach_number_dependent]
)
# Assign the aerodynamic coefficient interface to the vehicle
body_settings.get( "Vehicle" ).aerodynamic_coefficient_settings = aero_coefficient_settings

custom_aerodynamic_force_and_moment_coefficients(force_coefficient_function: Callable[[list[float]], numpy.ndarray[numpy.float64[3, 1]]], moment_coefficient_function: Callable[[list[float]], numpy.ndarray[numpy.float64[3, 1]]], reference_length: float, reference_area: float, independent_variable_names: list[tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables], force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>, moment_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.positive_body_fixed_frame_coefficients: 0>, moment_reference_point: numpy.ndarray[numpy.float64[3, 1]] = array([nan, nan, nan])) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings from custom coefficients.

Function for settings object, defining aerodynamic interface model via a custom force and moment coefficient function (function of independent variable).

See custom models for more details on how to create custom models in Tudat.

Parameters:

force_coefficient_function (callable[[list[float]], numpy.ndarray[numpy.float64[3, 1]]]) – Function that is defining the aerodynamic force coefficients as function of an independent variable (see arg independent_variable_names).
moment_coefficient_function (callable[[list[float]], numpy.ndarray[numpy.float64[3, 1]]]) – Function that is defining the aerodynamic moment coefficients as function of an independent variable (see arg independent_variable_names).
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
reference_length (float) – Reference length with which aerodynamic moments are non-dimensionalized.
independent_variable_name (list[AerodynamicCoefficientsIndependentVariables]) – Vector with identifiers for the independent variable w.r.t. which the aerodynamic coefficients are defined.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))
moment_coefficients_frame (AerodynamicCoefficientFrames, default = positive_body_frame_coefficients) – Variable defining the frame in which the moment coefficients are defined. By default, this is the positive body frame, so that the coefficients are roll, pitch and yaw (\(C_{l}, C_{m}, C_{n}\))
moment_reference_point (numpy.ndarray[numpy.float64[3, 1]] = np.full([3, 1], np.nan)) – Point w.r.t. aerodynamic moment coefficients are defined. This variable is used to calculate the contribution of the aerodynamic force coefficients to the effective moment coefficients. See the add_force_contribution_to_moments attribute of the AerodynamicCoefficientSettings for more details. If the present input is set to NaN (as is the default), the reference point is left undefined, and the aerodynamic moments are computed without computing any force coefficient contribution to the moment coefficients.

Returns:

Instance of the AerodynamicCoefficientSettings derived CustomAerodynamicCoefficientSettings class

Return type:

CustomAerodynamicCoefficientSettings

tabulated(independent_variables: list[float], force_coefficients: list[numpy.ndarray[numpy.float64[3, 1]]], moment_coefficients: list[numpy.ndarray[numpy.float64[3, 1]]], reference_length: float, reference_area: float, independent_variable_name: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables, force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>, moment_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.positive_body_fixed_frame_coefficients: 0>, moment_reference_point: numpy.ndarray[numpy.float64[3, 1]] = array([nan, nan, nan]), interpolator_settings: tudatpy.kernel.math.interpolators.InterpolatorSettings = None) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings from user-defined, 1-d tabulated coefficients.

Function for settings object, defining aerodynamic interface model via user-defined, 1-dimensional, tabulated aerodynamic force and moment coefficients (tabulated w.r.t. independent variable).

Parameters:

independent_variables (list[float]) – Values of independent variables at which the coefficients in the input multi vector are defined (size 1).
force_coefficients (list[numpy.ndarray[numpy.float64[3, 1]]]) – Values of force coefficients at independent variables defined by independent_variables.
moment_coefficients (list[numpy.ndarray[numpy.float64[3, 1]]]) – Values of moment coefficients at independent variables defined by independent_variables.
reference_length (float) – Reference length with which aerodynamic moments about x- and z- axes are non-dimensionalized.
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
independent_variable_name (list[AerodynamicCoefficientsIndependentVariables]) – Vector with identifiers for the independent variable w.r.t. which the aerodynamic coefficients are defined.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))
moment_coefficients_frame (AerodynamicCoefficientFrames, default = positive_body_frame_coefficients) – Variable defining the frame in which the moment coefficients are defined. By default, this is the positive body frame, so that the coefficients are roll, pitch yaw (\(C_{l}, C_{m}, C_{n}\))
moment_reference_point (numpy.ndarray[numpy.float64[3, 1]] = np.full([3, 1], np.nan)) – Point w.r.t. aerodynamic moment coefficients are defined. This variable is used to calculate the contribution of the aerodynamic force coefficients to the effective moment coefficients. See the add_force_contribution_to_moments attribute of the AerodynamicCoefficientSettings for more details. If the present input is set to NaN (as is the default), the reference point is left undefined, and the aerodynamic moments are computed without computing any force coefficient contribution to the moment coefficients.
interpolator_settings (math.interpolators.InterpolatorSettings, default = None) – Interpolator settings object, where the conditions for interpolation of tabulated inputs are saved.

Returns:

Instance of the AerodynamicCoefficientSettings derived TabulatedAerodynamicCoefficientSettings class (via TabulatedAerodynamicCoefficientSettingsBase class)

Return type:

TabulatedAerodynamicCoefficientSettings

Examples

In this example, aerodynamic force and moment coefficients are defined as multi-dimensional arrays. The values for the aerodynamic coefficients vary with Mach number, and are defined for Mach numbers of 3, 5, 10, and 15. This example also shows how to set the required reference point, lengths, and area.

# Define the aerodynamic force coefficients [CD, CS, CL] for different mach numbers
aero_coefficients_array_force = [
    [0.7647, 0, 0.9722],
    [0.6729, 0, 0.8461],
    [0.6240, 0, 0.7838],
    [0.6246, 0, 0.7841]
]
# Define the aerodynamic moment coefficients for different mach numbers
aero_coefficients_array_moment = [
    [0.45, 0, 0],
    [0.50, 0, 0],
    [0.53, 0, 0],
    [0.55, 0, 0]
]
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.tabulated(
    independent_variables=[3, 5, 10, 15],       # Mach number at which the coefficients are defined
    force_coefficients=aero_coefficients_array_force,
    moment_coefficients=aero_coefficients_array_moment,
    reference_length=0.25,
    reference_area=1.50,
    independent_variable_name=AerodynamicCoefficientsIndependentVariables.mach_number_dependent
)
# Assign the aerodynamic coefficient interface to the vehicle
body_settings.get( "Vehicle" ).aerodynamic_coefficient_settings = aero_coefficient_settings

tabulated_force_only(independent_variables: list[float], force_coefficients: list[numpy.ndarray[numpy.float64[3, 1]]], reference_area: float, independent_variable_name: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables, force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>, interpolator_settings: tudatpy.kernel.math.interpolators.InterpolatorSettings = <tudatpy.kernel.math.interpolators.InterpolatorSettings object at 0x741f02ef06f0>) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings from user-defined, 1-d tabulated force coefficients.

Function for settings object, defining aerodynamic interface model via user-defined, 1-dimensional, tabulated aerodynamic force coefficients (tabulated w.r.t. independent variable). This function is the same as tabulated(), except it does not provide moment coefficients

Parameters:

independent_variables (list[float]) – Values of independent variables at which the coefficients in the input multi vector are defined (size 1)
force_coefficients (list[numpy.ndarray[numpy.float64[3, 1]]]) – Values of force coefficients at independent variables defined by independent_variables.
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
independent_variable_name (AerodynamicCoefficientsIndependentVariables) – Identifier of the independent variable w.r.t. which the aerodynamic coefficients are defined.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))
interpolator_settings (math.interpolators.InterpolatorSettings, default = tudatpy.math.interpolators.linear_interpolation()) – Interpolator settings object, where the conditions for interpolation of tabulated inputs are saved. Pointer to an interpolator settings object where the conditions for interpolation of tabulated inputs are saved.

Returns:

Instance of the AerodynamicCoefficientSettings derived TabulatedAerodynamicCoefficientSettings class

Return type:

TabulatedAerodynamicCoefficientSettings

Examples

In this example, aerodynamic force coefficients are defined as a multi-dimensional array. The values for the force coefficients vary with Mach number, and are defined for Mach numbers of 3, 5, 10, and 15.

# Define the aerodynamic coefficients [CD, CS, CL] for different mach numbers
aero_coefficients_array = [
    [0.7647, 0, 0.9722],
    [0.6729, 0, 0.8461],
    [0.6240, 0, 0.7838],
    [0.6246, 0, 0.7841]
]
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.tabulated_force_only(
    independent_variables=[3.0, 5.0, 10.0, 15.0],       # Mach number at which the coefficients are defined
    force_coefficients=aero_coefficients_array,
    reference_area=1.50,
    independent_variable_name=AerodynamicCoefficientsIndependentVariables.mach_number_dependent
)
# Assign the aerodynamic coefficient interface to the vehicle
body_settings.get( "Vehicle" ).aerodynamic_coefficient_settings = aero_coefficient_settings

tabulated_from_files(force_coefficient_files: dict[int, str], moment_coefficient_files: dict[int, str], reference_length: float, reference_area: float, independent_variable_names: list[tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables], force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>, moment_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.positive_body_fixed_frame_coefficients: 0>, moment_reference_point: numpy.ndarray[numpy.float64[3, 1]] = array([nan, nan, nan]), interpolator_settings: tudatpy.kernel.math.interpolators.InterpolatorSettings = None) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings from tabulated coefficients from files.

Function for settings object, defining aerodynamic interface model via user-defined, tabulated aerodynamic force and moment coefficients (tabulated w.r.t. independent variable), obtained from data files.

Parameters:

force_coefficient_files (Dict[int, str]) – Path of the aerodynamic coefficient files corresponding to the force coefficient of the given dict key (0, 1 and 2 a are x-, y- and z-axis of force frame, respectively).
moment_coefficient_files (Dict[int, str]) – Path of the aerodynamic coefficient files corresponding to the moment coefficient of the given dict key (0, 1 and 2 a are x-, y- and z-axis of moment frame, respectively).
reference_length (float) – Reference length with which aerodynamic moments about x- and z- axes are non-dimensionalized.
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
independent_variable_names (list[AerodynamicCoefficientsIndependentVariables]) – Vector with identifiers for the independent variable w.r.t. which the aerodynamic coefficients are defined.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))
moment_coefficients_frame (AerodynamicCoefficientFrames, default = positive_body_frame_coefficients) – Variable defining the frame in which the moment coefficients are defined. By default, this is the positive body frame, so that the coefficients are roll, pitch yaw (\(C_{l}, C_{m}, C_{n}\))
moment_reference_point (numpy.ndarray[numpy.float64[3, 1]] = np.full([3, 1], np.nan)) – Point w.r.t. aerodynamic moment coefficients are defined. This variable is used to calculate the contribution of the aerodynamic force coefficients to the effective moment coefficients. See the add_force_contribution_to_moments attribute of the AerodynamicCoefficientSettings for more details. If the present input is set to NaN (as is the default), the reference point is left undefined, and the aerodynamic moments are computed without computing any force coefficient contribution to the moment coefficients.
interpolator_settings (math.interpolators.InterpolatorSettings, default = None) – Interpolator settings object, where the conditions for interpolation of tabulated inputs are saved.

Returns:

Instance of the AerodynamicCoefficientSettings derived TabulatedAerodynamicCoefficientSettings class

Return type:

TabulatedAerodynamicCoefficientSettings

Examples

This example is very similar to the one for tabulated_force_only_from_files, with the distinction that a pitching moment coefficient is added.

# Define the force coefficient files (leave C_S empty)
force_coefficients_files = {0: "input/STS_CD.dat", 2:"input/STS_CL.dat"}
# Define the moment coefficient files (leave C_S empty)
moment_coefficients_files = {0: "input/STS_CM.dat"}
# Setup the aerodynamic coefficients settings tabulated from the files
coefficient_settings = environment_setup.aerodynamic_coefficients.tabulated_from_files(
    force_coefficient_files=force_coefficients_files,
    moment_coefficient_files=moment_coefficients_files,
    reference_length=11.9,
    reference_area=2690.0*0.3048*0.3048,
    independent_variable_names=[environment.angle_of_attack_dependent, environment.mach_number_dependent]
)
# Add predefined aerodynamic coefficients database to the body settings
body_settings.get( "STS" ).aerodynamic_coefficient_settings = aero_coefficient_settings

tabulated_force_only_from_files(force_coefficient_files: dict[int, str], reference_area: float, independent_variable_names: list[tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables], force_coefficients_frame: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientFrames = <AerodynamicCoefficientFrames.negative_aerodynamic_frame_coefficients: 2>, interpolator_settings: tudatpy.kernel.math.interpolators.InterpolatorSettings = None) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings from tabulated force coefficients from files.

Function for settings object, defining aerodynamic interface model via user-defined, tabulated aerodynamic force coefficients (tabulated w.r.t. independent variable), obtained from data files. This function is the same as tabulated_from_files(), except it does not provide moment coefficients

Parameters:

force_coefficient_files (Dict[int, str]) – Path of the aerodynamic coefficient files corresponding to the force coefficient of the given dict key.
reference_area (float) – Reference area with which aerodynamic forces and moments are non-dimensionalized.
independent_variable_names (list[AerodynamicCoefficientsIndependentVariables]) – Vector with identifiers for the independent variable w.r.t. which the aerodynamic coefficients are defined.
force_coefficients_frame (AerodynamicCoefficientFrames, default = negative_aerodynamic_frame_coefficients) – Variable defining the frame in which the force coefficients are defined. By default, this is the negative aerodynamic frame, so that the coefficients are for drag, side force and lift (\(C_{D}, C_{S}, C_{L}\))
interpolator_settings (math.interpolators.InterpolatorSettings, default = None) – Interpolator settings object, where the conditions for interpolation of tabulated inputs are saved.

Returns:

Instance of the AerodynamicCoefficientSettings derived TabulatedAerodynamicCoefficientSettings class

Return type:

TabulatedAerodynamicCoefficientSettings

Examples

In this example, the drag and lift coefficients of the Space Transport System are defined from two data files. Both of these data files contain coefficient values dependent on both the angle of attack and the mach number, as shown in the example in the independent_variable_names input. This example is taken from the reentry trajectory example.

# Define the aerodynamic coefficient files (leave C_S empty)
aero_coefficients_files = {0: "input/STS_CD.dat", 2:"input/STS_CL.dat"}
# Setup the aerodynamic coefficients settings tabulated from the files
coefficient_settings = environment_setup.aerodynamic_coefficients.tabulated_force_only_from_files(
    force_coefficient_files=aero_coefficients_files,
    reference_area=2690.0*0.3048*0.3048,
    independent_variable_names=[environment.angle_of_attack_dependent, environment.mach_number_dependent]
)
# Add predefined aerodynamic coefficients database to the body settings
body_settings.get( "STS" ).aerodynamic_coefficient_settings = aero_coefficient_settings

scaled_by_constant(unscaled_coefficient_settings: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings, force_scaling_constant: float, moment_scaling_constant: float, is_scaling_absolute: bool = False) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings by applying one constant scaling factor/value to all coefficients of an existing model settings object.

Function for settings object, defining aerodynamic interface based on scaling the coefficients of an existing model settings object by one constant factor or value. Via the is_scaling_absolute boolean, the user can apply a constant scaling factor or an absolute value to the resulting force and moment coefficients (for instance for an uncertainty analysis).

For a set of unscaled 3x1 vector of coefficients \(\bar{\mathbf{C}}\), and a scaling value \(K\), the scaled coefficients \({\mathbf{C}}\) (which are used in the propagation and environment) are set to (if is_scaling_absolute is false):

\[{\mathbf{C}} = K \bar{\mathbf{C}}\]

and (if is_scaling_absolute is false):

\[{\mathbf{C}} = \bar{\mathbf{C}} + K\mathbf{1}_{3\times 1}\]

Parameters:

unscaled_coefficient_settings (AerodynamicCoefficientSettings) – Existing aerodynamic interface model settings object that is used as the base for the scaled settings object.
force_scaling_constant (float) – Constant scaling factor to be applied to all aerodynamic force coefficients.
moment_scaling_constant (float) – Constant scaling factor to be applied to all aerodynamic moment coefficients.
is_scaling_absolute (bool, default = False) – Boolean indicating whether aerodynamic coefficient scaling is absolute. Setting this boolean to true will add the scaling value to the base value, instead of the default behaviour of multiplying the base value by the scaling factor.

Returns:

Instance of the AerodynamicCoefficientSettings derived ScaledAerodynamicCoefficientInterfaceSettings class

Return type:

ScaledAerodynamicCoefficientInterfaceSettings

Examples

In this example, we first set constant aerodynamic coefficients, like in the earlier example. Then, we use the scaled_by_constant function to scale the force coefficients by 1.1. Since the is_scaling_absolute equals False by default, the force coefficients are then increased by 10%.

# Define the reference area and constant aerodynamic coefficients
reference_area = 20.0
drag_coefficient = 1.5
lift_coefficient = 0.3
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.constant(
    reference_area,
    constant_force_coefficient=[drag_coefficient, 0, lift_coefficient]
)
# Define scaled aerodynamic coefficient to increase the force coefficients by 10%
scaled_aero_coefficient_settings = environment_setup.aerodynamic_coefficients.scaled_by_constant(
    unscaled_coefficient_settings=aero_coefficient_settings,
    force_scaling_constant=1.1,
    moment_scaling_constant=1.0
)
# Add predefined aerodynamic coefficients database to the body settings
body_settings.get( "STS" ).aerodynamic_coefficient_settings = aero_coefficient_settings

scaled_by_vector(unscaled_coefficient_settings: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings, force_scaling_vector: numpy.ndarray[numpy.float64[3, 1]], moment_scaling_vector: numpy.ndarray[numpy.float64[3, 1]], is_scaling_absolute: bool = False) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings by applying constant scaling factors/values to the coefficients of an existing model settings object.

Function for settings object, defining aerodynamic interface based on scaling the coefficients of an existing model settings object by constant factors or values. Via the is_scaling_absolute boolean, the user can apply one constant scaling factor or an absolute value to each resulting force and moment coefficient (for instance for an uncertainty analysis).

For a set of unscaled 3x1 vector of coefficients \(\bar{\mathbf{C}}\), and a 3x1 scaling vector \(\mathbf{K}\), the scaled coefficients \({\mathbf{C}}\) (which are used in the propagation and environment) are set to (if is_scaling_absolute is false):

\[{\mathbf{C}} = \mathbf{K}\odot\bar{\mathbf{C}}\]

with \(\odot\) denoting the component-wise multiplication (Hadamard product).And (if is_scaling_absolute is false):

\[{\mathbf{C}} = \bar{\mathbf{C}} + \mathbf{K}\]

Parameters:

unscaled_coefficient_settings (AerodynamicCoefficientSettings) – Existing aerodynamic interface model settings object that is used as the base for the scaled settings object.
force_scaling_vector (numpy.ndarray[numpy.float64[3, 1]]) – Constant scaling factors to be applied to each aerodynamic force coefficient.
moment_scaling_vector (numpy.ndarray[numpy.float64[3, 1]]) – Constant scaling factors to be applied to each aerodynamic moment coefficient.
is_scaling_absolute (bool, default = False) – Boolean indicating whether aerodynamic coefficient scaling is absolute. Setting this boolean to true will add the scaling value to the base value, instead of the default behaviour of multiplying the base value by the scaling factor.

Returns:

Instance of the AerodynamicCoefficientSettings derived ScaledAerodynamicCoefficientInterfaceSettings class

Return type:

ScaledAerodynamicCoefficientInterfaceSettings

Examples

In this example, we first set constant aerodynamic coefficients, like in the earlier example. Then, we use the scaled_by_vector function to scale the drag coefficient by 2.

# Define the reference area and constant aerodynamic coefficients
reference_area = 20.0
drag_coefficient = 1.5
lift_coefficient = 0.3
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.constant(
    reference_area,
    constant_force_coefficient=[drag_coefficient, 0, lift_coefficient]
)
# Define scaled aerodynamic coefficient to increase CD by a factor of 2
scaled_aero_coefficient_settings = environment_setup.aerodynamic_coefficients.scaled_by_vector(
    unscaled_coefficient_settings=aero_coefficient_settings,
    force_scaling_vector=[2.0, 1.0, 1.0],
    moment_scaling_vector=[1.0, 1.0, 1.0]
)
# Add predefined aerodynamic coefficients database to the body settings
body_settings.get( "STS" ).aerodynamic_coefficient_settings = aero_coefficient_settings

scaled_by_vector_function(unscaled_coefficient_settings: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings, force_scaling_vector_function: Callable[[float], numpy.ndarray[numpy.float64[3, 1]]], moment_scaling_vector_function: Callable[[float], numpy.ndarray[numpy.float64[3, 1]]], is_scaling_absolute: bool = False) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings¶

Function for creating aerodynamic interface model settings by applying custom scaling factors/values to the coefficients of an existing model settings object.

Same as scaled_by_vector(), except that \(\mathbf{K}\) is a function of time \(\mathbf{K}(t)\). See custom models for more details on how to create custom models in Tudat (and how to use implicit dependencies on other variables than time).

Parameters:

unscaled_coefficient_settings (AerodynamicCoefficientSettings) – Existing aerodynamic interface model settings object that is used as the base for the scaled settings object.
force_scaling_vector_function (callable[[float], numpy.ndarray[numpy.float64[3, 1]]]) – Custom scaling factors to be applied to each aerodynamic force coefficient.
moment_scaling_vector_function (callable[[float], numpy.ndarray[numpy.float64[3, 1]]]) – Custom scaling factors to be applied to each aerodynamic moment coefficient.
is_scaling_absolute (bool, default = False) – Boolean indicating whether aerodynamic coefficient scaling is absolute. Setting this boolean to true will add the scaling value to the base value, instead of the default behaviour of multiplying the base value by the scaling factor.

Returns:

Instance of the AerodynamicCoefficientSettings derived ScaledAerodynamicCoefficientInterfaceSettings class

Return type:

ScaledAerodynamicCoefficientInterfaceSettings

Examples

In this example, we first set constant aerodynamic coefficients, like in the earlier example. Then, we use the scaled_by_vector_function function to scale the drag and lift coefficients according to a function that varies with time. This scaling function essentially adds noise to the CD and CL following as a sin or cos function.

# Define the reference area and constant aerodynamic coefficients
reference_area = 20.0
drag_coefficient = 1.5
lift_coefficient = 0.3
# Create the aerodynamic interface settings
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.constant(
    reference_area,
    constant_force_coefficient=[drag_coefficient, 0, lift_coefficient]
)
# Define the aerodynamic coefficient scaling as a function of time
def aero_coefficient_scaling(time):
    CD_scale = 1 + 0.25*np.sin(time/10)
    CL_scale = 1 + 0.25*np.cos(time/15)
    return [CD_scale, 1.0, CL_scale]
# Define scaled aerodynamic coefficient to increase CD by a factor of 2
scaled_aero_coefficient_settings = environment_setup.aerodynamic_coefficients.scaled_by_vector_function(
    unscaled_coefficient_settings=aero_coefficient_settings,
    force_scaling_vector_function=aero_coefficient_scaling,
    moment_scaling_vector_function=lambda x: [1.0, 1.0, 1.0]
)
# Add predefined aerodynamic coefficients database to the body settings
body_settings.get( "STS" ).aerodynamic_coefficient_settings = aero_coefficient_settings

custom_control_surface(force_and_moment_coefficient_function: Callable[[list[float]], numpy.ndarray[numpy.float64[6, 1]]], independent_variable_names: list[tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables]) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.CustomControlSurfaceIncrementAerodynamicCoefficientSettings¶

Function for creating control surface aerodynamic model settings from custom coefficients.

Function for create a settings object that defines control surface aerodynamic coefficients via a custom force and moment coefficient function This function is essentially the control-surface equivalent of the custom_aerodynamic_force_and_moment_coefficients() function for body coefficient settings.

Parameters:

force_and_moment_coefficient_function (callable[[list[float]], numpy.ndarray[numpy.float64[6, 1]]]) – Function that is defining the aerodynamic force (first three entries) and moment (last three entries) coefficients as function of an independent variables (see independent_variable_names).
independent_variable_names (list[AerodynamicCoefficientsIndependentVariables]) – Vector with identifiers for the independent variable w.r.t. which the control surface aerodynamic coefficients are defined. Typically, one entry from this list will be control_surface_deflection_dependent

Returns:

Instance of the ControlSurfaceIncrementAerodynamicCoefficientSettings derived class

Return type:

ControlSurfaceIncrementAerodynamicCoefficientSettings

Examples

In this example, we create ControlSurfaceIncrementAerodynamicCoefficientSettings for the artificial body “Vehicle”, using a function based on the mach number:

# Create the aerodynamic coefficient settings for the body
aero_coefficient_settings = environment_setup.aerodynamic_coefficients.constant_force_and_moment( ... )
# Define list of independent variables that control surface coefficients depend on (Mach number
control_surface_independent_variable_names = [mach_number_dependent, angle_of_attack_dependent, control_surface_deflection_dependent]
# Define function that computes the control surface coefficient increments as a function of the independet variables
control_surface_increment_function = ...
# Create coefficient settings for the elevon control surface
elevon_aero_coefficient_settings = environment_setup.aerodynamic_coefficients.custom_control_surface(
    control_surface_increment_function,
    control_surface_independent_variable_names
)
# Add control surfaces to coefficient settings for control surface named "Elevon"
aero_coefficient_settings.add_single_control_surface(
     elevon_aero_coefficient_settings, "Elevon" )

tabulated_from_files_control_surface(force_coefficient_files: dict[int, str], moment_coefficient_files: dict[int, str], independent_variable_names: list[tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientsIndependentVariables]) → tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.ControlSurfaceIncrementAerodynamicCoefficientSettings¶

Function for creating control surface aerodynamic model settings from tabulated coefficients from files.

Function for settings object, defining control surface aerodynamic interface model via user-defined, tabulated aerodynamic force and moment coefficients (tabulated w.r.t. independent variable), obtained from data files.. This function is essentially the control-surface equivalent of the tabulated_from_files() function for body coefficient settings.

Returns:: Instance of the ControlSurfaceIncrementAerodynamicCoefficientSettings derived class
Return type:: ControlSurfaceIncrementAerodynamicCoefficientSettings

Enumerations¶

`AerodynamicsReferenceFrameAngles`	Enumeration of angles typical for (atmospheric) flight dynamics and aerodynamic calculations.
`AerodynamicsReferenceFrames`	Enumeration of reference frame identifiers typical for aerodynamic calculations.
`AerodynamicCoefficientFrames`	Enumeration of reference frames used for definition of aerodynamic coefficients.
`AerodynamicCoefficientsIndependentVariables`	Enumeration of the independent variables that can be used to compute aerodynamic coefficients.
`AtmosphericCompositionSpecies`	No documentation found.

class AerodynamicsReferenceFrameAngles¶

Enumeration of angles typical for (atmospheric) flight dynamics and aerodynamic calculations.

Enumeration of angles typical for (atmospheric) flight dynamics and aerodynamic calculation. They define angles between frames of a body (see AerodynamicsReferenceFrames) and its central body with the details given by Mooij (1994).

Members:

latitude_angle :

Geocentric latitude angle in the central body-fixed frame where the body is located

longitude_angle :

Longitude angle in the central body-fixed frame where the body is located

heading_angle :

Heading angle: between north direction and the local horizontal (in xy-plane of the vertical frame) component of the airspeed-based velocity vector

flight_path_angle :

Flight path angle: between the local horizontal plane (xy-plane of the vertical frame) and the airspeed-based velocity vector

angle_of_attack :

Angle of attack: rotation angle about the body-fixed y-axis w.r.t. the xy-plane of the aerodynamic frame

angle_of_sideslip :

Sideslip angle: rotation angle about the body-fixed z-axis w.r.t. the xz-plane of the aerodynamic frame

bank_angle :

Bank angle: between the horizontal (xy-plane) of the vertical frame and the xy-plane of the vertical frame

property name¶

class AerodynamicsReferenceFrames¶

Enumeration of reference frame identifiers typical for aerodynamic calculations.

Enumeration of reference frame identifiers typical for aerodynamic calculations. Note that the frames are also defined in the absence of any aerodynamic forces and/or atmosphere. They define frames of a body w.r.t. a central body, with the details given by Mooij (1994). The chain of frames starts from the inertial frame, to the frame fixed to the central body (corotating), to the vertical frame (defined by the body’s relative position), the trajectory and aerodynamic frames (defined by the body’s relative velocity) and finally the body’s own body-fixed frame.

Members:

inertial_frame :

The global orientation (which is by definition inertial).

corotating_frame :

The body-fixed frame of the central body.

vertical_frame :

Frame with z-axis pointing towards origin of central body, the x-axis lies in the meridian plane and points towards the central-body-fixed z-axis (the y-axis completes the frame).

trajectory_frame :

The (airspeed-based) trajectory frame has the x-axis in the direction of the velocity vector relative to the atmosphere (airspeed-based velocity vector), z-axis lies in the vertical plane and points downwards (the y-axis completes the frame).

aerodynamic_frame :

The (airspeed-based) aerodynamic frame has the x-axis in the direction of the velocity vector relative to the atmosphere (airspeed-based velocity vector), z-axis co-linear with the aerodynamic lift vector, pointing in the opposite direction (the y-axis completes the frame)..

body_frame :

The body-fixed frame of the body itself.

property name¶

class AerodynamicCoefficientFrames¶

Enumeration of reference frames used for definition of aerodynamic coefficients.

Enumeration of reference frames used for definition of aerodynamic coefficients. There is a partial overlap between this enum and the AerodynamicsReferenceFrames. This enum combines a subset of those frames (which are typically used for aerodynamic coefficient definition), and a swap in sign. For instance, aerodynamic force coefficients are often defined positive along negative axes of the aerodynamic frame (drag, side force and lift coefficients)

Members:

positive_body_fixed_frame_coefficients :

The coefficients are defined in the body-fixed frame, with the directions the same as the body-fixed axes. For aerodynamic forces and moments, this results in the typical \(C_{x}, C_{y}, C_{y}\) (force) and \(C_{l}, C_{m}, C_{n}\) (moment) coefficients

negative_body_fixed_frame_coefficients :

Same as positive_body_fixed_frame_coefficients, but opposite in direction (so axes along negative body-fixed frame axes)

positive_aerodynamic_frame_coefficients :

Same as negative_aerodynamic_frame_coefficients, but opposite in direction (so axes along positive aerodynamic frame axes)

negative_aerodynamic_frame_coefficients :

The coefficients are defined in aerodynamic frame, with the directions the same as the negative axes. For aerodynamic forces, this results in the typical \(C_{D}, C_{S}, C_{D}\) force coefficients

property name¶

class AerodynamicCoefficientsIndependentVariables¶

Enumeration of the independent variables that can be used to compute aerodynamic coefficients. Each aerodynamic coefficient model is a function of any number of independent variables (for some models: of zero independent variables, e.g. constant coefficients). During propagation, the value of the independent variables at the current epoch and state is automaticallt retrieved from the environment, and used to compute the aerodynamic coefficients. The user need not provide them manually. The user only needs to provide (for coefficient models that provide this freedom) the physical type of independent variables, from the present list of enums.

Members:

mach_number_dependent :

angle_of_attack_dependent :

sideslip_angle_dependent :

altitude_dependent :

time_dependent :

temperature_dependent :

velocity_dependent :

he_number_density_dependent :

o_number_density_dependent :

n2_number_density_dependent :

o2_number_density_dependent :

ar_number_density_dependent :

h_number_density_dependent :

n_number_density_dependent :

anomalous_o_number_density_dependent :

control_surface_deflection_dependent :

undefined_independent_variable :

Can be used for a custom coefficient interface with other variables, at the expense of being able to use the FlightConditions class to automatically updates the aerodynamic coefficients during propagation.

property name¶

class AtmosphericCompositionSpecies¶

No documentation found.

Members:

o_species : No documentation found.

o2_species : No documentation found.

n2_species : No documentation found.

he_species : No documentation found.

h_species : No documentation found.

ar_species : No documentation found.

n_species : No documentation found.

anomalous_o_species : No documentation found.

property name¶

Classes¶

`AerodynamicCoefficientSettings`	Base class for providing settings for aerodynamic interface model.
`ConstantAerodynamicCoefficientSettings`	Class for defining model settings from constant aerodynamic coefficients.

class AerodynamicCoefficientSettings¶

Base class for providing settings for aerodynamic interface model.

Functional (base) class for settings of aerodynamic interface models that require no information in addition to their type. Aerodynamic interface model settings requiring additional information must be defined using an object derived from this class.

add_single_control_surface(self: tudatpy.kernel.numerical_simulation.environment_setup.aerodynamic_coefficients.AerodynamicCoefficientSettings, control_surface_settings: tudat::simulation_setup::ControlSurfaceIncrementAerodynamicCoefficientSettings, control_surface_name: str) → None¶

Function to add settings for a single control surface to the coefficient settings. Note that, in Tudat, the control surface aerodynamic database inherits the reference properties (length, area, moment reference point) from the AerodynamicCoefficientSettings to which it is assigned.

Parameters:

control_surface_settings (ControlSurfaceIncrementAerodynamicCoefficientSettings) – Settings for aerodynamic coefficients of a control surface
control_surface_name (str) – Name by which the control surface will be identified

property add_force_contribution_to_moments¶

Variable that toggles whether to add the force contribution to the moment coefficients as:

\[\Delta \mathbf{C}_{M} = (\mathbf{r}_{ref}-\mathbf{r}_{com})\times \Delta \mathbf{C}_{F}\]

where \((\mathbf{r}_{ref}-\mathbf{r}_{com})\) is the vector from the center of mass to the moment reference point, and \(\mathbf{C}_{F}\) and \(\mathbf{C}_{M}\) is the vector of force and moment coefficients. Note that, if the force and moment coefficients are defined in different frames, the relevant frame conversions are automatically performed. By default, his boolean is set to false, implicitly assuming that the moment coefficients are provided w.r.t. the (constant) center of mass. Models to define and vary the body center of mass are given in rigid_body.

Type:: bool

property moment_reference_point¶

Point w.r.t. aerodynamic moment coefficients are defined. This variable is used to calculate the contribution of the aerodynamic force coefficients to the effective moment coefficients. See the add_force_contribution_to_moments attribute of the AerodynamicCoefficientSettings for more details. If the present input is set to NaN (as is the default), the reference point is left undefined, and the aerodynamic moments are computed without computing any force coefficient contribution to the moment coefficients.

Type:: np.ndarray

class ConstantAerodynamicCoefficientSettings¶

Class for defining model settings from constant aerodynamic coefficients.

AerodynamicCoefficientSettings derived class for aerodynamic interface model settings using only constant aerodynamic coefficients.

aerodynamic_coefficients¶

Functions¶

Enumerations¶

Classes¶

`aerodynamic_coefficients`¶