`dependent_variable`¶

None

Functions¶

`create`(dependent_variable_list, …)	Function to create settings for a generic dependent variable.
`mach_number`(body, central_body)	Function to add the Mach number to the dependent variables to save.
`altitude`(body, central_body)	Function to add the altitude to the dependent variables to save.
`airspeed`(body, body_with_atmosphere)	Function to add the airspeed to the dependent variables to save.
`density`(body, body_with_atmosphere)	Function to add the local density to the dependent variables to save.
`relative_speed`(body, relative_body)	Function to add the relative speed (norm of the velocity vector) to the dependent variables to save.
`relative_speed`(body, relative_body)	Function to add the relative speed (norm of the velocity vector) to the dependent variables to save.
`relative_distance`(body, relative_body)	Function to add the relative distance (norm of the position vector) to the dependent variables to save.
`relative_velocity`(body, relative_body)	Function to add the relative velocity vector to the dependent variables to save.
`keplerian_state`(body, central_body)	Function to add the Keplerian state to the dependent variables to save.
`modified_equinoctial_state`(body, central_body)	Function to add the modified equinoctial state to the dependent variables to save.
`single_acceleration`(acceleration_type, …)	Function to add an acceleration vector to the dependent variables to save.
`single_acceleration_norm`(acceleration_type, …)	Function to add a scalar acceleration (norm of the acceleration vector) to the dependent variables to save.
`total_acceleration_norm`(body)	Function to add the total scalar acceleration (norm of the vector) acting on a body to the dependent variables to save.
`total_acceleration`(body)	Function to add the total acceleration vector acting on a body to the dependent variables to save.
`single_torque_norm`(torque_type, …)	Function to add a single torque (norm of the torque vector) to the dependent variables to save.
`single_torque`(torque_type, …)	Function to add a single torque vector to the dependent variables to save.
`total_torque_norm`(body)	Function to add the total torque (norm of the torque vector) to the dependent variables to save.
`total_torque`(body)	Function to add the total torque vector to the dependent variables to save.
`spherical_harmonic_terms_acceleration`(…)	Function to add a single term of the spherical harmonic acceleration vector to the dependent variables to save.
`spherical_harmonic_terms_acceleration_norm`(…)	Function to add a single term of the spherical harmonic acceleration (norm of the vector) to the dependent variables to save.
`aerodynamic_force_coefficients`(body)	Function to add the aerodynamic force coefficients to the dependent variables to save.
`aerodynamic_moment_coefficients`(body)	Function to add the aerodynamic moment coefficients to the dependent variables to save.
`latitude`(body, central_body)	Function to add the latitude to the dependent variables to save.
`geodetic_latitude`(body, central_body)	Function to add the geodetic latitude to the dependent variables to save.
`longitude`(body, central_body)	Function to add the longitude to the dependent variables to save.
`heading_angle`(body, central_body)	Function to add the heading angle to the dependent variables to save.
`flight_path_angle`(body, central_body)	Function to add the flight path angle to the dependent variables to save.
`angle_of_attack`(body, central_body)	Function to add the angle of attack to the dependent variables to save.
`sideslip_angle`(body, central_body)	Function to add the sideslip angle to the dependent variables to save.
`bank_angle`(body, central_body)	Function to add the bank angle to the dependent variables to save.
`radiation_pressure`(body, radiating_body)	Function to add the radiation pressure to the dependent variables to save.
`total_gravity_field_variation_acceleration`(…)	Function to add the total gravity field variation acceleration to the dependent variables to save.
`single_gravity_field_variation_acceleration`(…)	Function to add a single gravity field variation acceleration to the dependent variables to save.
`body_fixed_airspeed_velocity`(body, central_body)	Function to add the airspeed velocity vector to the dependent variables to save.
`body_fixed_groundspeed_velocity`(body, …)	Function to add the groundspeed velocity vector to the dependent variables to save.
`inertial_to_body_fixed_rotation_frame`(body)	Function to add the rotation matrix from the inertial RF to the body-fixed RF to the dependent variables to save.
`lvlh_to_inertial_rotation_matrix`(body, …)	Function to add the rotation matrix from the Local Vertical, Local Horizontal (LVLH) RF to the inertial RF to the dependent variables to save.
`inertial_to_body_fixed_313_euler_angles`(body)	Function to add the rotation matrix from the inertial RF to the body-fixed RF to the dependent variables to save.
`intermediate_aerodynamic_rotation_matrix_variable`(…)	Function to add the rotation matrix from the a base aerodynamic RF to a target aerodynamic RF to the dependent variables to save.
`periapsis_altitude`(body, central_body)	Function to add the altitude of periapsis to the dependent variables to save.
`control_surface_deflection`(body, control_surface)	Function to add the altitude of periapsis to the dependent variables to save.
`central_body_fixed_spherical_position`(body, …)	Function to add the spherical, body-fixed position to the dependent variables to save.
`central_body_fixed_cartesian_position`(body, …)	Function to add the cartesian, body-fixed position to the dependent variables to save.
`body_mass`(body)	Function to add the body mass to the dependent variables to save.
`radiation_pressure_coefficient`(body, …)	Function to add the radiation pressure coefficient to the dependent variables to save.
`local_temperature`(body)	Function to add the local temperature to the dependent variables to save.
`local_dynamic_pressure`(body)	Function to add the local temperature to the dependent variables to save.
`local_aerodynamic_heat_rate`(body)	Function to add the local aerodynamic heat rate to the dependent variables to save.
`local_aerodynamic_g_load`(body)	Function to add the total aerodynamic G-load to the dependent variables to save.
`stagnation_point_heat_flux`(body)	Function to add the heat flux at the stagnation point to the dependent variables to save.
`total_mass_rate`(body)	Function to add the total mass rate to the dependent variables to save.
`aerodynamic_g_load`(body, central_body)	Function to add the aerodynamic g-load to the dependent variables to save.
`dynamic_pressure`(body, central_body)	Function to add the dynamic pressure to the dependent variables to save.
`atmospheric_temperature`(body, central_body)	Function to add the atmospheric temperature to the dependent variables to save.

create(dependent_variable_list: List[tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings], print_variable_indices: bool = True) → tudatpy.kernel.simulation.propagation_setup.propagator.DependentVariableSaveSettings¶

Function to create settings for a generic dependent variable.

Function to create settings for a dependent variable. It creates objects that calculate dependent variables from the objects that define their settings. It is usually not relevant nor useful for the user.

Parameters

dependent_variable_list (list[SingleDependentVariableSaveSettings]) – List of dependent variables to be saved.
print_variable_indices (bool, default=True) – Whether the types of dependent variables to be saved should be printed on the terminal.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

mach_number(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the Mach number to the dependent variables to save.

Function to add the Mach number to the dependent variables to save. Requires an aerodynamic acceleration to be acting on the vehicle.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with atmosphere with respect to which the Mach number is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

altitude(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the altitude to the dependent variables to save.

Function to add the altitude to the dependent variables to save. It requires an aerodynamic acceleration to be acting on the vehicle and it depends on the central body’s shape.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with atmosphere with respect to which the altitude is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

airspeed(body: str, body_with_atmosphere: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the airspeed to the dependent variables to save.

Function to add the airspeed to the dependent variables to save. Requires an aerodynamic acceleration to be acting on the vehicle.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with atmosphere with respect to which the airspeed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

density(body: str, body_with_atmosphere: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the local density to the dependent variables to save.

Function to add the density (at position of body undergoing acceleration) to the dependent variables to save. Requires an aerodynamic acceleration to be acting on the vehicle.

Parameters

body (str) – Body whose dependent variable should be saved.
body_with_atmosphere (str) – Body with atmosphere with respect to which the density is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

relative_speed(body: str, relative_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the relative speed (norm of the velocity vector) to the dependent variables to save.

Function to add the relative speed (norm of the velocity vector) with respect to a second body to the dependent variables to save. The relative speed is computed between the bodies’ centers of mass.

Parameters

body (str) – Body whose dependent variable should be saved.
relative_body (str) – Body with respect to which the relative speed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

relative_speed(body: str, relative_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the relative speed (norm of the velocity vector) to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
relative_body (str) – Body with respect to which the relative speed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

relative_distance(body: str, relative_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the relative distance (norm of the position vector) to the dependent variables to save.

Function to add the relative distance (norm of the position vector) with respect to a second body to the dependent variables to save. The relative distance is computed between the bodies’ centers of mass.

Parameters

body (str) – Body whose dependent variable should be saved.
relative_body (str) – Body with respect to which the relative distance is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

relative_velocity(body: str, relative_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the relative velocity vector to the dependent variables to save.

Function to add the relative velocity vector with respect to a second body to the dependent variables to save. The relative distance is computed between the bodies’ centers of mass.

Parameters

body (str) – Body whose dependent variable should be saved.
relative_body (str) – Body with respect to which the relative velocity is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

keplerian_state(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the Keplerian state to the dependent variables to save.

Function to add the Keplerian state to the dependent variables to save. The Keplerian state is returned in this order: 1: Semi-major Axis. 2: Eccentricity. 3: Inclination. 4: Argument of Periapsis. 5. Right Ascension of the Ascending Node. 6: True Anomaly.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the Keplerian state is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

modified_equinoctial_state(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the modified equinoctial state to the dependent variables to save.

Function to add the modified equinoctial state to the dependent variables to save. The value of the parameter I is automatically chosen as +1 or -1, depending on whether the inclination is smaller or larger than 90 degrees.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the modified equinoctial state is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

single_acceleration(acceleration_type: tudatpy.kernel.simulation.propagation_setup.acceleration.AvailableAcceleration, body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add an acceleration vector to the dependent variables to save.

Parameters

acceleration_type (AvailableAcceleration) – Acceleration type to be saved.
body_undergoing_acceleration (str) – Body undergoing acceleration.
body_exerting_acceleration (str) – Body exerting acceleration.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

single_acceleration_norm(acceleration_type: tudatpy.kernel.simulation.propagation_setup.acceleration.AvailableAcceleration, body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add a scalar acceleration (norm of the acceleration vector) to the dependent variables to save.

Parameters

acceleration_type (AvailableAcceleration) – Acceleration type to be saved (see AvailableAcceleration enum).
body_undergoing_acceleration (str) – Body undergoing acceleration.
body_exerting_acceleration (str) – Body exerting acceleration.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

total_acceleration_norm(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total scalar acceleration (norm of the vector) acting on a body to the dependent variables to save.

Parameters: body (str) – Body undergoing acceleration.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

total_acceleration(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total acceleration vector acting on a body to the dependent variables to save.

Parameters: body (str) – Body undergoing acceleration.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

single_torque_norm(torque_type: tudatpy.kernel.simulation.propagation_setup.torque.AvailableTorque, body_undergoing_torque: str, body_exerting_torque: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add a single torque (norm of the torque vector) to the dependent variables to save.

Function to add a single torque (norm of the torque vector) to the dependent variables to save. The altitude depends on the shape of the central body.

Parameters

torque_type (AvailableTorque) – Torque type to be saved.
body_undergoing_torque (str) – Body undergoing torque.
body_exerting_torque (str) – Body exerting torque.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

single_torque(torque_type: tudatpy.kernel.simulation.propagation_setup.torque.AvailableTorque, body_undergoing_torque: str, body_exerting_torque: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add a single torque vector to the dependent variables to save.

Function to add a single torque vector to the dependent variables to save. The altitude depends on the shape of the central body.

Parameters

torque_type (AvailableTorque) – Torque type to be saved.
body_undergoing_torque (str) – Body undergoing torque.
body_exerting_torque (str) – Body exerting torque.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

total_torque_norm(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total torque (norm of the torque vector) to the dependent variables to save.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

total_torque(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total torque vector to the dependent variables to save.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

spherical_harmonic_terms_acceleration(body_undergoing_acceleration: str, body_exerting_acceleration: str, component_indices: List[Tuple[int, int]]) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add a single term of the spherical harmonic acceleration vector to the dependent variables to save.

Function to add single term of the spherical harmonic acceleration vector to the dependent variables to save.

Parameters

body_undergoing_acceleration (str) – Body undergoing acceleration.
body_exerting_acceleration (str) – Body exerting acceleration.
component_indices (list[tuple]) – Tuples of (degree, order) indicating the terms to save.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

spherical_harmonic_terms_acceleration_norm(body_undergoing_acceleration: str, body_exerting_acceleration: str, component_indices: List[Tuple[int, int]]) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add a single term of the spherical harmonic acceleration (norm of the vector) to the dependent variables to save.

Function to add single term of the spherical harmonic acceleration (norm of the vector) to the dependent variables to save.

Parameters

body_undergoing_acceleration (str) – Body undergoing acceleration.
body_exerting_acceleration (str) – Body exerting acceleration.
component_indices (list[tuple]) – Tuples of (degree, order) indicating the terms to save.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

aerodynamic_force_coefficients(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the aerodynamic force coefficients to the dependent variables to save.

Function to add the aerodynamic force coefficients to the dependent variables to save. It requires an aerodynamic acceleration acting on the vehicle. The coefficients are returned in the following order: drag force, side force, lift force.

Parameters: body (str) – Body undergoing acceleration.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

aerodynamic_moment_coefficients(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the aerodynamic moment coefficients to the dependent variables to save.

Function to add the aerodynamic force coefficients to the dependent variables to save. It requires an aerodynamic torque acting on the vehicle. The coefficients are returned in the following order: C_l, C_m, C_n (respectively about the X, Y, Z axes of the body-fixed frame, see Mooij 1994).

Parameters: body (str) – Body undergoing acceleration.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

latitude(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the latitude to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the latitude is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

geodetic_latitude(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the geodetic latitude to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the geodetic latitude is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

longitude(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the longitude to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the longitude is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

heading_angle(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the heading angle to the dependent variables to save.

Function to add the heading angle to the dependent variables to save. The heading angle is the angle between the X-axis of the vertical frame and the XZ-plane in the groundspeed-based trajectory frame (see Mooij, 1994).

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the heading angle is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

flight_path_angle(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the flight path angle to the dependent variables to save.

Function to add the flight path angle to the dependent variables to save. The flight path angle is the angle between the X-axis of the groundspeed-based trajectory frame and the local horizontal plane defined in the vertical reference frame (see Mooij, 1994).

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the flight path angle is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

angle_of_attack(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the angle of attack to the dependent variables to save.

Function to add the angle of attack angle to the dependent variables to save. The angle of attack is the angle between the X-axis of the body-fixed reference frame and the XY plane in the groundspeed-based aerodynamic frame (see Mooij, 1994).

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the angle of attack is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

sideslip_angle(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the sideslip angle to the dependent variables to save.

Function to add the sideslip angle to the dependent variables to save. The sideslip angle is ???

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the sideslip angle is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

bank_angle(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the bank angle to the dependent variables to save.

Function to add the bank angle to the dependent variables to save. The bank angle is ???

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the bank angle is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

radiation_pressure(body: str, radiating_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the radiation pressure to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
radiating_body (str) – Radiating body.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

total_gravity_field_variation_acceleration(body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total gravity field variation acceleration to the dependent variables to save.

Function to add the total gravity field variation acceleration to the dependent variables to save. This function does not distinguish between different sources of variations of the gravity field. To select only one contribution, look for the single gravity field variation acceleration.

Parameters

body_undergoing_acceleration (str) – Body whose dependent variable should be saved.
body_exerting_acceleration (str) – Body exerting the acceleration.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

single_gravity_field_variation_acceleration(body_undergoing_acceleration: str, body_exerting_acceleration: str, deformation_type: tudatpy.kernel.simulation.environment_setup.gravity_field_variation.BodyDeformationTypes, identifier: str = '') → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add a single gravity field variation acceleration to the dependent variables to save.

Function to add a single gravity field variation acceleration to the dependent variables to save. This function does distinguish between different sources of variations of the gravity field, but not between terms of the spherical harmonic expansion. To select specific combinations of order and degree, look for the single per term gravity field variation acceleration.

Parameters

body_undergoing_acceleration (str) – Body whose dependent variable should be saved.
body_exerting_acceleration (str) – Body exerting the acceleration.
deformation_type (str) – Deformation type (see BodyDeformationTypes).
identifier (str, default="") – Identifier for the deformation type.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

body_fixed_airspeed_velocity(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the airspeed velocity vector to the dependent variables to save.

Function to add the airspeed velocity vector to the dependent variables to save. The airspeed velocity is expressed with respect to a central body and returned in a frame fixed to the same central body. It requires the central body to have an atmosphere.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the airspeed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

body_fixed_groundspeed_velocity(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the groundspeed velocity vector to the dependent variables to save.

Function to add the groundspeed velocity vector to the dependent variables to save. The groundspeed velocity is expressed with respect to a central body and returned in a frame fixed to the same central body.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the groundspeed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

inertial_to_body_fixed_rotation_frame(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the rotation matrix from the inertial RF to the body-fixed RF to the dependent variables to save.

Parameters: body (str) – Body of interest.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

lvlh_to_inertial_rotation_matrix(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the rotation matrix from the Local Vertical, Local Horizontal (LVLH) RF to the inertial RF to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the groundspeed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

inertial_to_body_fixed_313_euler_angles(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the rotation matrix from the inertial RF to the body-fixed RF to the dependent variables to save.

Function to add the rotation matrix from the inertial RF to the body-fixed RF to the dependent variables to save. It uses a 313-Euler angles representation.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

intermediate_aerodynamic_rotation_matrix_variable(body: str, base_frame: tudatpy.kernel.astro.frames.AerodynamicsReferenceFrames, target_frame: tudatpy.kernel.astro.frames.AerodynamicsReferenceFrames) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the rotation matrix from the a base aerodynamic RF to a target aerodynamic RF to the dependent variables to save.

Function to add the rotation matrix from the a base aerodynamic RF to a target aerodynamic RF to the dependent variables to save. The aerodynamic RFs are collected in the AerodynamicsReferenceFrames enum.

Parameters

body (str) – Body whose dependent variable should be saved.
base_frame (str) – Base reference frame for the transformation.
target_frame (str) – Target reference frame for the transformation.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

periapsis_altitude(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the altitude of periapsis to the dependent variables to save.

Function to add the altitude of periapsis to the dependent variables to save. The altitude depends on the shape of the central body.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the altitude of periapsis is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

control_surface_deflection(body: str, control_surface: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the altitude of periapsis to the dependent variables to save.

Function to add the altitude of periapsis to the dependent variables to save. The altitude depends on the shape of the central body.

Parameters

body (str) – Body whose dependent variable should be saved.
control_surface (str) – Control surface whose deflection should be saved.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

central_body_fixed_spherical_position(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the spherical, body-fixed position to the dependent variables to save.

Function to add the spherical position to the dependent variables to save. The spherical position is expressed in the central body’s body-fixed RF.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the spherical, body-fixed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

central_body_fixed_cartesian_position(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the cartesian, body-fixed position to the dependent variables to save.

Function to add the cartesian position to the dependent variables to save. The cartesian position is expressed in the central body’s body-fixed RF.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the cartesian, body-fixed is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

body_mass(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the body mass to the dependent variables to save.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

radiation_pressure_coefficient(body: str, emitting_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the radiation pressure coefficient to the dependent variables to save.

Parameters

body (str) – Body whose dependent variable should be saved.
emitting_body (str) – Emitting body.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

local_temperature(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the local temperature to the dependent variables to save.

Function to add the local temperature to the dependent variables to save (at position of body undergoing acceleration). It requires an aerodynamic acceleration to be acting on the body.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

local_dynamic_pressure(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the local temperature to the dependent variables to save.

Function to add the local temperature to the dependent variables to save (at position of body undergoing acceleration). It requires an aerodynamic acceleration to be acting on the body.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

local_aerodynamic_heat_rate(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the local aerodynamic heat rate to the dependent variables to save.

Function to add the local aerodynamic heat rate felt by the vehicle based on the current velocity and atmospheric conditions to the dependent variables to save (at position of body undergoing acceleration). It requires an aerodynamic acceleration to be acting on the body.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

local_aerodynamic_g_load(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total aerodynamic G-load to the dependent variables to save.

Function to add the total aerodynamic G-load induced by the aerodynamic acceleration to the dependent variables to save (at position of body undergoing acceleration). It requires an aerodynamic acceleration to be acting on the body.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

stagnation_point_heat_flux(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the heat flux at the stagnation point to the dependent variables to save.

Function to add the heat flux induced by atmospheric friction at the stagnation point to the dependent variables to save. It requires an aerodynamic acceleration to be acting on the body and a vehicle nose radius to be defined.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

total_mass_rate(body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the total mass rate to the dependent variables to save.

Function to add the total mass rate to the dependent variables to save. It requires the body mass to be numerically propagated.

Parameters: body (str) – Body whose dependent variable should be saved.
Returns: Dependent variable settings object.
Return type: SingleDependentVariableSaveSettings

aerodynamic_g_load(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the aerodynamic g-load to the dependent variables to save.

Function to add the aerodynamic g-load to the dependent variables to save (at position of body undergoing acceleration). It requires an aerodynamic acceleration to be acting on the body.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the aerodynamic g-load is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

dynamic_pressure(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the dynamic pressure to the dependent variables to save.

Function to add the dynamic pressure to the dependent variables to save. It requires the central body to have an atmosphere.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the dynamic pressure is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

atmospheric_temperature(body: str, central_body: str) → tudatpy.kernel.simulation.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings¶

Function to add the atmospheric temperature to the dependent variables to save.

Function to add the atmospheric temperature to the dependent variables to save. It requires the central body to have an atmosphere.

Parameters

body (str) – Body whose dependent variable should be saved.
central_body (str) – Body with respect to which the atmospheric temperature is computed.

Returns

Dependent variable settings object.

Return type

SingleDependentVariableSaveSettings

Classes¶

class VariableSettings¶: Functional base class to define settings for variables.

class SingleDependentVariableSaveSettings¶: VariableSettings-derived class to define settings for dependent variables that are to be saved during propagation.

class SingleAccelerationDependentVariableSaveSettings¶: SingleDependentVariableSaveSettings-derived class to save a single acceleration (norm or vector) during propagation.

dependent_variable¶

Functions¶

Classes¶

`dependent_variable`¶