dependent_variable

This module provides the functionality for creating dependent variable settings. Dependent variables are quantities other than the propagated states that are saved when doing a propagation.

Each dependent variable is created via a dedicated function, the settings for each of which is defined by an object of type SingleDependentVariableSaveSettings. The functions in this submodule are used to create these settings objects. After propagation, the computed dependent variables can be extracted from the dependent_variable_history attribute of the SingleArcSimulationResults. AN object of this type (which saves all propagation results) is extracted from the dynamics simulator using the propagation_results attribute.

See the example below for the definition of four separate dependent variables:

dependent_variables_to_save = [
    propagation_setup.dependent_variable.total_acceleration( "Delfi-C3" ),
    propagation_setup.dependent_variable.keplerian_state( "Delfi-C3", "Earth" ),
    propagation_setup.dependent_variable.latitude( "Delfi-C3", "Earth" ),
    propagation_setup.dependent_variable.longitude( "Delfi-C3", "Earth" )
]

This list can then be added to the propagation settings by adding them as input argument to the propagator settings functions in the propagator module (such as translational(), rotational() and multitype()).

Note that all dependent variables output is in SI units (meters, radians, seconds). All epochs are provided in seconds since J2000.

Functions

get_dependent_variable_id(...)

Function to return a string representation of the dependent variable.

get_dependent_variable_size(...)

Function to get the size of a dependent variable.

get_dependent_variable_shape(...)

Function to get the shape of a 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.

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.

local_wind_velocity(body, ...)

Function to add the local wind velocity vector to the dependent variables to save.

density(body, body_with_atmosphere)

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

number_density(body, body_with_atmosphere)

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

temperature(body, body_with_atmosphere)

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

dynamic_pressure(body, body_with_atmosphere)

Function to add the local freestream dynamic pressure 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.

relative_position(body, relative_body)

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

relative_distance(body, relative_body)

Function to add the relative distance to the dependent variables to save.

relative_velocity(body, relative_body)

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

relative_speed(body, relative_body)

Function to add the relative speed 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 a single acceleration to the dependent variables to save.

single_acceleration_norm(acceleration_type, ...)

Function to add a single scalar acceleration 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.

acceleration_partial_wrt_body_translational_state(...)

Function to add the partial derivative of a single acceleration model with respect to a body's translational state to the dependent variables to save.

total_acceleration_partial_wrt_body_translational_state(...)

Function to add the partial derivative of the total acceleration with respect to a body's translational state to the dependent variables to save.

acceleration_derivative_partial_wrt_parameter(...)

Function to add the partial derivative of a single acceleration derivative model with respect to an estimatable parameter to the dependent variables to save.

total_acceleration_derivative_partial_wrt_parameter(...)

Function to add the partial derivative of the total acceleration derivative with respect to an estimatable parameter 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 single degree/order contributions of a 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.

solar_longitude(body)

Function to add the solar 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, as defined by Mooij [25].

bank_angle(body, central_body)

Function to add the bank angle to the dependent variables to save, as defined by Mooij [25].

radiation_pressure(target_body, source_body)

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

total_gravity_field_variation_acceleration(...)

Function to add the acceleration induced by the total time-variability of a gravity field to the dependent variables to save.

single_gravity_field_variation_acceleration(...)

Function to add the acceleration induced by a single time-variability of a gravity field to the dependent variables to save.

single_per_term_gravity_field_variation_acceleration(...)

Function to add the acceleration induced by a single time-variability of a gravity field, at a given list of degrees/orders, to the dependent variables to save.

inertial_to_body_fixed_rotation_frame(body)

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

tnw_to_inertial_rotation_matrix(body, ...)

Function to add the rotation matrix from the TNW to the inertial frame to the dependent variables to save.

rsw_to_inertial_rotation_matrix(body, ...)

Function to add the rotation matrix from the RSW to the inertial frame to the dependent variables to save.

inertial_to_body_fixed_313_euler_angles(body)

Function to add the 3-1-3 Euler angles for the rotation from inertial to body-fixed frame to the dependent variables to save.

intermediate_aerodynamic_rotation_matrix_variable(...)

Function to add the rotation matrix between any two reference frames used in aerodynamic calculations.

periapsis_altitude(body, central_body)

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

apoapsis_altitude(body, central_body)

Function to add the altitude of apoapsis 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 relative Cartesian position, in the central body's fixed frame, to the dependent variables to save.

body_mass(body)

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

radiation_pressure_coefficient(body, ...)

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

total_mass_rate(body)

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

gravity_field_potential(...)

Function to add the gravitational potential to the dependent variables to save.

gravity_field_laplacian_of_potential(...)

Function to add the laplacian of the gravitational potential to the dependent variables to save.

minimum_body_distance(body_name, bodies_to_check)

Function to compute the minimum distance between a given body, and a set of other bodies.

minimum_visible_station_body_distances(...)

Function to compute the minimum distance between a ground station, and a set of other bodies visible from that station.

custom_dependent_variable(custom_function, ...)

Function to compute a custom dependent variable.

received_irradiance(target_body, source_body)

Function to save the received irradiance from a give source.

received_irradiance_shadow_function(...)

Function to save the shadow function that reduces the received irradiance from a given source.

actual_cross_section(target_name, ...[, ...])

Create settings to save the actual cross section of target_name with respect to central_body_name for acceleration_type.

aerodynamic_coefficients(target_name, ...)

Create settings to save the aerodynamic coefficients of target_name in the environment of central_body_name.

aerodynamic_force_coefficients_control_surface_increment(...)

Create settings to save the three force-coefficient increments of control_surface_name on body.

aerodynamic_force_coefficients_control_surface_free(body)

Create settings to save the three aerodynamic force coefficients excluding control-surface increments for body.

aerodynamic_moment_coefficients_control_surface_increment(...)

Create settings to save the three moment-coefficient increments of control_surface_name on body.

aerodynamic_moment_coefficients_control_surface_free(body)

Create settings to save the three aerodynamic moment coefficients excluding control-surface increments for body.

center_of_mass(body)

Create settings to save the three-component body-fixed centre of mass of body, in metres.

control_surface_deflection(body, control_surface)

Create settings to save the deflection angle of control_surface on body, in radians.

cross_section_change(target_name, source_name)

Create settings to save the change in effective cross section of target_name for source_name and the selected acceleration_type.

full_body_paneled_geometry(target_name)

Create settings to save the full panel geometry of target_name.

illuminated_panel_fraction(target_name, ...)

Create settings to save the illuminated fraction of panels on target_name due to source_name.

inertia_tensor(body)

Create settings to save the body-fixed inertia tensor of body, in kilograms times square metres.

per_target_panel_radiation_pressure_force(...)

Create panel surface-normal output settings through the current compatibility binding.

radiation_pressure_source_panel_geometry(...)

Create settings to save the panel geometry of source_name as seen from target_name.

radiation_pressure_source_panel_irradiance(...)

Create settings to save irradiance contributions from individual panels of source_name at target_name.

total_spherical_harmonic_cosine_coefficient_variations(...)

Create settings to save total time-dependent variations of the cosine gravity coefficients of body.

total_spherical_harmonic_sine_coefficient_variations(...)

Create settings to save total time-dependent variations of the sine gravity coefficients of body.

vehicle_panel_surface_normals_body_fixed_frame(...)

Create panel surface-normal output settings for body_name and optional part_name.

vehicle_panel_surface_normals_inertial_frame(...)

Create settings to save inertial-frame unit surface normals for the panels of body_name.

visible_radiation_source_area(target_body, ...)

Function to save the shadow function that reduces the received irradiance from a given source.

get_dependent_variable_id(dependent_variable_settings: tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings) → str

Function to return a string representation of the dependent variable.

Parameters:

dependent_variable_settings (SingleDependentVariableSaveSettings) – Dependent variable settings for which the representation is to be returned.

Returns:

String representation of the dependent variable.

Return type:

str

Examples

from tudatpy.dynamics import propagation_setup

dep_var_settings = propagation_setup.dependent_variable.single_acceleration(propagation_setup.acceleration.point_mass_gravity_type, "SC", "Earth")

print(propagation_setup.dependent_variable.get_dependent_variable_id(dep_var_settings))
# prints "Single acceleration in inertial frame of type central gravity , acting on SC, exerted by Earth"
get_dependent_variable_size(dependent_variable_settings: tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings, bodies: tudatpy.kernel.dynamics.environment.SystemOfBodies) → int

Function to get the size of a dependent variable.

Parameters:
Returns:

Size of the dependent variable.

Return type:

int

Examples

from tudatpy.dynamics import propagation_setup

bodies = ...

dep_var_settings = propagation_setup.dependent_variable.single_acceleration(propagation_setup.acceleration.point_mass_gravity_type, "SC", "Earth")

print(propagation_setup.dependent_variable.get_dependent_variable_size(dep_var_settings, bodies))
# prints 3
get_dependent_variable_shape(dependent_variable_settings: tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings, bodies: tudatpy.kernel.dynamics.environment.SystemOfBodies) → tuple[int, int]

Function to get the shape of a dependent variable.

Parameters:
Returns:

Shape of the dependent variable.

Return type:

tuple[int, int]

Examples

from tudatpy.dynamics import propagation_setup

bodies = ...

dep_var_settings = propagation_setup.dependent_variable.single_acceleration(propagation_setup.acceleration.point_mass_gravity_type, "SC", "Earth")

print(propagation_setup.dependent_variable.get_dependent_variable_shape(dep_var_settings, bodies))
# prints (3, 1)
mach_number(body: str, central_body: str) → tudatpy.kernel.dynamics.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. The calculation of the altitude uses the atmosphere model of the central body and the current state of the body for which the Mach number is to be calculated.

Parameters:
  • body (str) – Body whose Mach number is to 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

Variable Size:

1

Examples

To create settings for saving of a Mach number of a body name ‘Spacecraft’ w.r.t. the atmosphere of body ‘Earth’, use:

# Define save settings for Mach number
propagation_setup.dependent_variable.mach_number( "Spacecraft", "Earth" )
altitude(body: str, central_body: str) → tudatpy.kernel.dynamics.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. The calculation of the altitude uses the shape model of the central body and the current state of the body for which the altitude is to be calculated.

Parameters:
  • body (str) – Body whose altitude is to be saved.

  • central_body (str) – Body with respect to which the altitude is computed (requires this body to have a shape model defined).

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

airspeed(body: str, body_with_atmosphere: str) → tudatpy.kernel.dynamics.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. The calculation of the airspeed uses the rotation and wind models of the central body (to determine the motion of the atmosphere in inertial space), and the current state of the body for which the airspeed is to be calculated.

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

Variable Size:

1

body_fixed_airspeed_velocity(body: str, central_body: str) → tudatpy.kernel.dynamics.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 vector is not provided in an inertial frame, but instead a frame centered on, and fixed to, the central body. It defines the velocity vector of a body w.r.t. the relative atmosphere 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

Variable Size:

3

body_fixed_groundspeed_velocity(body: str, central_body: str) → tudatpy.kernel.dynamics.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 vector is not provided in an inertial frame, but instead a frame centered on, and fixed to, the central body. It defines the velocity vector of a body w.r.t. ‘the ground’ or (alternatively and identically) the relative atmosphere in the case the atmosphere would be perfectly co-rotating with the 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

Variable Size:

3

local_wind_velocity(body: str, body_with_atmosphere: str, target_frame: tudatpy.kernel.dynamics.environment_setup.aerodynamic_coefficients.AerodynamicsReferenceFrames = <AerodynamicsReferenceFrames.corotating_frame: 0>) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the local wind velocity vector to the dependent variables to save.

Function to add the local wind velocity vector to the dependent variables to save. The wind velocity represents the atmospheric wind removed from the groundspeed when deriving the airspeed. The calculation uses the wind model of the body with atmosphere, and the current state of the body for which the wind velocity is to be calculated. The wind velocity can be expressed in any aerodynamic reference frame.

Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • body_with_atmosphere (str) – Body with atmosphere with respect to which the local wind velocity is computed.

  • target_frame (AerodynamicsReferenceFrames, default=corotating_frame) – Reference frame in which the wind velocity should be expressed. Available frames: - corotating_frame: Body-fixed corotating frame (default) - vertical_frame: Local vertical frame - trajectory_frame: Velocity-aligned trajectory frame - aerodynamic_frame: Aerodynamic frame - body_frame: Vehicle body frame - inertial_frame: Inertial frame

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

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

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

Function to add the freestream density (at a body’s position) to the dependent variables to save. The calculation of the density uses the atmosphere model of the central body, and the current state of the body for which the density is to be calculated.

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

Variable Size:

1

number_density(body: str, body_with_atmosphere: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add the freestream number density (at a body’s position) to the dependent variables to save. The calculation of the number density uses the atmosphere model of the central body, and the current state of the body for which the number density is to be calculated.

Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • body_with_atmosphere (str) – Body with atmosphere with respect to which the number density is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

temperature(body: str, body_with_atmosphere: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add the freestream temperature (at a body’s position) to the dependent variables to save. The calculation of the temperature uses the atmosphere model of the central body, and the current state of the body for which the temperature is to be calculated.

Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • body_with_atmosphere (str) – Body with atmosphere with respect to which the temperature is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

dynamic_pressure(body: str, body_with_atmosphere: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add the freestream dynamic pressure (at a body’s position) to the dependent variables to save. The calculation of the temperature uses the atmosphere model of the central body, and the current state of the body for which the temperature is to be calculated.

Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • body_with_atmosphere (str) – Body with atmosphere with respect to which the dynamic pressure is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

local_aerodynamic_g_load(body: str, body_with_atmosphere: str) → tudatpy.kernel.dynamics.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 of a body to the dependent variables to save. The calculation uses the atmosphere model of the central body, and the current state of the body for which the temperature is to be calculated.

Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • body_with_atmosphere (str) – Body with atmosphere exerting the aerodynamic acceleration for which the g-load is to be computed

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

relative_position(body: str, relative_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add a body’s relative position vector with respect to a second body to the dependent variables to save. The relative position 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 position is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

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

Function to add the relative distance to the dependent variables to save.

Function to add a body’s 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

Variable Size:

1

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

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

Function to add a body’s relative velocity vector with respect to a second body to the dependent variables to save. The relative velocity 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

Variable Size:

3

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

Function to add the relative speed to the dependent variables to save.

Function to add a body’s relative speed (norm of the relative 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

Variable Size:

1

keplerian_state(body: str, central_body: str) → tudatpy.kernel.dynamics.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

Variable Size:

6

modified_equinoctial_state(body: str, central_body: str) → tudatpy.kernel.dynamics.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. The elements are returned in the order \(p\), \(f\), \(g\), \(h\), \(k\), \(L\)

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

Variable Size:

6

single_acceleration(acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration, body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleAccelerationDependentVariableSaveSettings

Function to add a single acceleration to the dependent variables to save.

Function to add a single acceleration vector to the dependent variables to save. The requested acceleration is defined by its type, and the bodies undergoing and exerting the acceleration. This acceleration vector represents the acceleration in 3D in the inertial reference frame. NOTE: When requesting a third-body perturbation be saved, you may use either the direct acceleration type, or the third body type. For instance, for saving a point-mass third-body perturbation, you may specify either point_mass_gravity_type or third_body_point_mass_gravity_type as acceleration type.

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:

SingleAccelerationDependentVariableSaveSettings

Variable Size:

3

Examples

To create settings for saving a point mass acceleration acting on body called ‘Spacecraft’, exerted by a body named ‘Earth’, use:

# Define save settings for point-mass acceleration on Spacecraft by Earth
propagation_setup.dependent_variable.single_acceleration(
        propagation_setup.acceleration.point_mass_gravity_type, 'Spacecraft', 'Earth' )
single_acceleration_norm(acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration, body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleAccelerationDependentVariableSaveSettings

Function to add a single scalar acceleration to the dependent variables to save.

Function to add a single scalar acceleration (norm of the acceleration vector) to the dependent variables to save. The requested acceleration is defined by its type, and the bodies undergoing and exerting the acceleration. NOTE: When requesting a third-body perturbation be saved, you may use either the direct acceleration type, or the third body type. For instance, for saving a point-mass third-body perturbation, you may specify either point_mass_gravity_type or third_body_point_mass_gravity_type as acceleration type.

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:

SingleAccelerationDependentVariableSaveSettings

Variable Size:

1

Examples

To create settings for saving norm of a point mass acceleration acting on body called ‘Spacecraft’, exerted by a body named ‘Earth’, use:

# Define save settings for point-mass acceleration on Spacecraft by Earth
propagation_setup.dependent_variable.single_acceleration_norm(
        propagation_setup.acceleration.point_mass_gravity_type, 'Spacecraft', 'Earth' )
total_acceleration_norm(body: str) → tudatpy.kernel.dynamics.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

Variable Size:

1

total_acceleration(body: str) → tudatpy.kernel.dynamics.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

Variable Size:

3

acceleration_partial_wrt_body_translational_state(acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration, body_undergoing_acceleration: str, body_exerting_acceleration: str, body_wrt_state: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the partial derivative of a single acceleration model with respect to a body’s translational state to the dependent variables to save.

Function to add the partial derivative of a single acceleration model acting on a body, exerted by another body, with respect to the Cartesian translational state of a selected body. The returned dependent variable is the flattened 3x6 matrix containing the acceleration partial with respect to position and velocity.

Parameters:
  • acceleration_type (AvailableAcceleration) – Acceleration type for which the partial is to be saved.

  • body_undergoing_acceleration (str) – Body undergoing acceleration.

  • body_exerting_acceleration (str) – Body exerting acceleration.

  • body_wrt_state (str) – Body with respect to whose translational state the partial derivative is taken.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

18

total_acceleration_partial_wrt_body_translational_state(body_undergoing_acceleration: str, body_wrt_state: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the partial derivative of the total acceleration with respect to a body’s translational state to the dependent variables to save.

Function to add the partial derivative of the total acceleration acting on a body with respect to the Cartesian translational state of a selected body. The returned dependent variable is the flattened 3x6 matrix containing the total acceleration partial with respect to position and velocity.

Parameters:
  • body_undergoing_acceleration (str) – Body undergoing acceleration.

  • body_wrt_state (str) – Body with respect to whose translational state the partial derivative is taken.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

18

acceleration_derivative_partial_wrt_parameter(acceleration_type: tudatpy.kernel.dynamics.propagation_setup.acceleration.AvailableAcceleration, body_undergoing_acceleration: str, body_exerting_acceleration: str, parameter_settings: tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the partial derivative of a single acceleration derivative model with respect to an estimatable parameter to the dependent variables to save.

Function to add the partial derivative of a single acceleration derivative model acting on a body, exerted by another body, with respect to an estimatable parameter. The parameter must be included in the estimatable parameter set used to create the variational-equation solver. The returned dependent variable is the flattened matrix containing the acceleration partial with respect to the selected parameter.

Parameters:
  • acceleration_type (AvailableAcceleration) – Acceleration type for which the partial is to be saved.

  • body_undergoing_acceleration (str) – Body undergoing acceleration.

  • body_exerting_acceleration (str) – Body exerting acceleration.

  • parameter_settings (EstimatableParameterSettings) – Settings identifying the estimatable parameter with respect to which the partial derivative is taken.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

total_acceleration_derivative_partial_wrt_parameter(body_undergoing_acceleration: str, parameter_settings: tudatpy.kernel.dynamics.parameters_setup.EstimatableParameterSettings) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the partial derivative of the total acceleration derivative with respect to an estimatable parameter to the dependent variables to save.

Function to add the summed partial derivative of all acceleration derivative models acting on a body with respect to an estimatable parameter. The parameter must be included in the estimatable parameter set used to create the variational-equation solver. The returned dependent variable is the flattened matrix containing the total acceleration partial with respect to the selected parameter.

Parameters:
  • body_undergoing_acceleration (str) – Body undergoing acceleration.

  • parameter_settings (EstimatableParameterSettings) – Settings identifying the estimatable parameter with respect to which the partial derivative is taken.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

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

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

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

Variable Size:

1

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

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

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

Variable Size:

3

total_torque_norm(body: str) → tudatpy.kernel.dynamics.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

Variable Size:

1

total_torque(body: str) → tudatpy.kernel.dynamics.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

Variable Size:

3

spherical_harmonic_terms_acceleration(body_undergoing_acceleration: str, body_exerting_acceleration: str, component_indices: list[tuple[int, int]]) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add single degree/order contributions of a spherical harmonic acceleration vector to the dependent variables to save.

Function to add single degree/order contributions of a spherical harmonic acceleration vector to the dependent variables to save. The spherical harmonic acceleration consists of a (truncated) summation of contributions at degree \(l\) and order \(m\). Using this function, you can save the contributions of separate \(l,m\) entries to the total acceleration. For instance, when requesting dependent variables for \(l,m=2,2\), the contribution due to the combined influence of \(\bar{C}_{22}\) and bar{S}_{22} are provided

Parameters:
  • body_undergoing_acceleration (str) – Body undergoing acceleration.

  • body_exerting_acceleration (str) – Body exerting acceleration.

  • component_indices (list[tuple[int, int]]) – Tuples of (degree, order) indicating the terms to save.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3*``len(component_indices)``

Examples

To create settings for saving spherical harmonic acceleration contributions of degree/order 2/0, 2/1 and 2/2, acting on a body names ‘Spacecraft’, exerted by a body named ‘Earth’, use the following for the acceleration. The resulting dependent variable will contain nine entries (three acceleration components for 2/0, 2/1 and 2/2, respectively).

# Define degree/order combinations for which to save acceleration contributions
spherical_harmonic_terms = [ (2,0), (2,1), (2,2) ]

# Define save settings for separate spherical harmonic contributions
propagation_setup.dependent_variable.spherical_harmonic_terms_acceleration( "Spacecraft", "Earth", spherical_harmonic_terms )
spherical_harmonic_terms_acceleration_norm(body_undergoing_acceleration: str, body_exerting_acceleration: str, component_indices: list[tuple[int, int]]) → tudatpy.kernel.dynamics.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[int, int]]) – Tuples of (degree, order) indicating the terms to save.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

``len(component_indices)``

Examples

To create settings for saving spherical harmonic acceleration contributions of degree/order 2/0, 2/1 and 2/2, acting on a body names ‘Spacecraft’, exerted by a body named ‘Earth’, use the following for the acceleration. The resulting dependent variable will contain three entries (one acceleration norm for 2/0, 2/1 and 2/2, respectively).

# Define degree/order combinations for which to save acceleration contributions
spherical_harmonic_terms = [ (2,0), (2,1), (2,2) ]

# Define save settings for separate spherical harmonic contributions
propagation_setup.dependent_variable.spherical_harmonic_terms_acceleration_norm( "Spacecraft", "Earth", spherical_harmonic_terms )
aerodynamic_force_coefficients(body: str, central_body: str = '') → tudatpy.kernel.dynamics.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 coefficient interface to be defined for the vehicle. The coefficients are returned in the following order: C_D, C_S, C_l (if coefficient interface defined in aerodynamic frame), or C_X, C_Y, C_Z (if coefficient interface defined in body frame).

Parameters:
  • body (str) – Body undergoing acceleration.

  • central_body (str) – Body exerting acceleration (e.g. body with atmosphere).

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

aerodynamic_moment_coefficients(body: str, central_body: str = '') → tudatpy.kernel.dynamics.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 coefficient interface to be defined for 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 (see Mooij [25])

Parameters:
  • body (str) – Body undergoing acceleration.

  • central_body (str) – Body exerting acceleration (e.g. body with atmosphere).

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

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

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

Function to add the latitude of a body, in the body-fixed frame of a central body, 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

Variable Size:

1

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

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

Function to add the geodetic latitude, in the body-fixed frame of a central body, to the dependent variables to save. If the central body has a spherical shape model, this value is identical to the latitude. If the central body has an oblate spheroid shape model, the calculation of the geodetic latitude uses the flattening of the this shape model to determine the geodetic latitude

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

Variable Size:

1

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

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

Function to add the longitude of a body, in the body-fixed frame of a central body, 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

Variable Size:

1

solar_longitude(body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add the solar longitude (angle from body-fixed X-axis to Sun direction in the XY plane) to the dependent variables to save. This dependent variable is available for bodies with a ComaModel or MarsDtmAtmosphereModel atmosphere. For ComaModel, the solar longitude is computed from the Sun-comet direction in the comet body-fixed frame. The value is cached during atmosphere density computations for efficiency.

Parameters:

body (str) – Body whose solar longitude is to be saved (must have ComaModel or MarsDtmAtmosphereModel atmosphere).

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

Examples

To create settings for saving the solar longitude of a comet with a coma model:

# Define save settings for solar longitude
propagation_setup.dependent_variable.solar_longitude( "Comet" )
heading_angle(body: str, central_body: str) → tudatpy.kernel.dynamics.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, as defined by Mooij [25].

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

Variable Size:

1

flight_path_angle(body: str, central_body: str) → tudatpy.kernel.dynamics.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, as defined by Mooij [25].

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

Variable Size:

1

angle_of_attack(body: str, central_body: str) → tudatpy.kernel.dynamics.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, as defined by Mooij [25].

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

Variable Size:

1

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

Function to add the sideslip angle to the dependent variables to save, as defined by Mooij [25].

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

Variable Size:

1

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

Function to add the bank angle to the dependent variables to save, as defined by Mooij [25].

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

Variable Size:

1

radiation_pressure(target_body: str, source_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add the local radiation pressure, in N/m^2, to the dependent variables to save. It requires a radiation source model to be defined for the radiating body.

Parameters:
  • target_body (str) – Name of body at the location of which the radiation pressure is to be returned

  • source_body (str) – Name of body from which the radiation originates that causes the radiation pressure at the target body

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

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

Function to add the acceleration induced by the total time-variability of a gravity field to the dependent variables to save.

Function to add the acceleration induced by the total time-variability of a gravity field to the dependent variables to save. This function does not distinguish between different sources of variations of the gravity field, and takes the full time-variation when computing the contribution to the acceleration. To select only one contribution, use the single_gravity_field_variation_acceleration() function.

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

Variable Size:

3

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

Function to add the acceleration induced by a single time-variability of a gravity field to the dependent variables to save.

Function to add the acceleration induced by a single time-variability of a gravity field to the dependent variables to save. The user specifies the type of variability for which the induced acceleration is to be saved.

Parameters:
  • body_undergoing_acceleration (str) – Body whose dependent variable should be saved.

  • body_exerting_acceleration (str) – Body exerting the acceleration.

  • deformation_type (BodyDeformationTypes) – Type of gravity field variation for which the acceleration contribution is to be saved

  • identifier (str, default="") – Identifier for the deformation type. To be used in case multiple realizations of a single variation type are present in the given body. Otherwise, this entry can be left empty

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

single_per_term_gravity_field_variation_acceleration(body_undergoing_acceleration: str, body_exerting_acceleration: str, component_indices: list[tuple[int, int]], deformation_type: tudatpy.kernel.dynamics.environment_setup.gravity_field_variation.BodyDeformationTypes, identifier: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the acceleration induced by a single time-variability of a gravity field, at a given list of degrees/orders, to the dependent variables to save. This combines the functionality of the single_gravity_field_variation_acceleration() and spherical_harmonic_terms_acceleration() variables

Parameters:
  • body_undergoing_acceleration (str) – Body whose dependent variable should be saved.

  • body_exerting_acceleration (str) – Body exerting the acceleration.

  • component_indices (list[tuple[int, int]]) – Tuples of (degree, order) indicating the terms to save.

  • deformation_type (BodyDeformationTypes) – Type of gravity field variation for which the acceleration contribution is to be saved

  • identifier (str, default="") – Identifier for the deformation type. To be used in case multiple realizations of a single variation type are present in the given body. Otherwise, this entry can be left empty

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3*``len(component_indices)``

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

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

Function to add the rotation matrix from inertial to body-fixed frame to the dependent variables to save. This requires the rotation of the body to be defined (either in the environment or the state vector).

Note

A rotation matrix is returned as a nine-entry vector in the dependent variable output, where entry \((i,j)\) of the matrix is stored in entry \((3i+j)\) of the vector (with \(i,j=0,1,2\)).

You can convert this vector to a matrix using numpy’s reshape function, e.g.:

import numpy as np

# Index where the rotation matrix starts in the dependent variable history
start_index = ...
rotation_matrix_components = dependent_variable_array[:, start_index : start_index + 9]

rotation_matrix_history = rotation_matrix_components.reshape(
    (rotation_matrix_components.shape[0], 3, 3)
)
Parameters:

body (str) – Body for which the rotation matrix is to be saved.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

9

tnw_to_inertial_rotation_matrix(body: str, central_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the rotation matrix from the TNW to the inertial frame to the dependent variables to save.

Function to add the rotation matrix from the TNW to the inertial frame to the dependent variables to save. It has the x-axis pointing along the velocity vector, the z-axis along the orbital angular momentum vector, and the y-axis completing the right-handed system.

Note

A rotation matrix is returned as a nine-entry vector in the dependent variable output, where entry \((i,j)\) of the matrix is stored in entry \((3i+j)\) of the vector (with \(i,j=0,1,2\)).

You can convert this vector to a matrix using numpy’s reshape function, e.g.:

import numpy as np

# Index where the rotation matrix starts in the dependent variable history
start_index = ...
rotation_matrix_components = dependent_variable_array[:, start_index : start_index + 9]

rotation_matrix_history = rotation_matrix_components.reshape(
    (rotation_matrix_components.shape[0], 3, 3)
)
Parameters:
  • body (str) – Body for which the rotation matrix is to be saved.

  • central_body (str) – Body with respect to which the TNW frame is determined.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

9

rsw_to_inertial_rotation_matrix(body: str, central_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the rotation matrix from the RSW to the inertial frame to the dependent variables to save.

Function to add the rotation matrix from the RSW to the inertial frame to the dependent variables to save. It has the x-axis pointing along the position vector (away from the central body), the z-axis along the orbital angular momentum vector, and the y-axis completing the right-handed system.

Note

A rotation matrix is returned as a nine-entry vector in the dependent variable output, where entry \((i,j)\) of the matrix is stored in entry \((3i+j)\) of the vector (with \(i,j=0,1,2\)).

You can convert this vector to a matrix using numpy’s reshape function, e.g.:

import numpy as np

# Index where the rotation matrix starts in the dependent variable history
start_index = ...
rotation_matrix_components = dependent_variable_array[:, start_index : start_index + 9]

rotation_matrix_history = rotation_matrix_components.reshape(
    (rotation_matrix_components.shape[0], 3, 3)
)
Parameters:
  • body (str) – Body for which the rotation matrix is to be saved.

  • central_body (str) – Body with respect to which the TNW frame is determined.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

9

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

Function to add the 3-1-3 Euler angles for the rotation from inertial to body-fixed frame to the dependent variables to save.

Function to add the 3-1-3 Euler angles for the rotation from inertial to body-fixed frame to the dependent variables to save. This requires the rotation of the body to be defined (either in the environment or the state vector).

Parameters:

body (str) – Body for which the rotation angles are to be saved.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

intermediate_aerodynamic_rotation_matrix_variable(body: str, base_frame: tudatpy.kernel.dynamics.environment_setup.aerodynamic_coefficients.AerodynamicsReferenceFrames, target_frame: tudatpy.kernel.dynamics.environment_setup.aerodynamic_coefficients.AerodynamicsReferenceFrames, central_body: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the rotation matrix between any two reference frames used in aerodynamic calculations.

Function to add the rotation matrix between any two reference frames used in aerodynamic calculations. The list of available frames is defined by the AerodynamicsReferenceFrames enum.

Note

A rotation matrix is returned as a nine-entry vector in the dependent variable output, where entry \((i,j)\) of the matrix is stored in entry \((3i+j)\) of the vector (with \(i,j=0,1,2\)).

You can convert this vector to a matrix using numpy’s reshape function, e.g.:

import numpy as np

# Index where the rotation matrix starts in the dependent variable history
start_index = ...
rotation_matrix_components = dependent_variable_array[:, start_index : start_index + 9]

rotation_matrix_history = rotation_matrix_components.reshape(
    (rotation_matrix_components.shape[0], 3, 3)
)
Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • base_frame (AerodynamicsReferenceFrames) – Base reference frame for the rotation.

  • target_frame (AerodynamicsReferenceFrames) – Target reference frame for the rotation.

  • central_body (str) – Central body w.r.t. which the state of the body is considered.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

9

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

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

Function to add the periapsis altitude of the current osculating orbit to the dependent variables to save. The altitude depends on the shape of the central body. This function takes the current (osculating) orbit of the body w.r.t. the central body, and uses this Kepler orbit to extract the position/altitude of periapsis.

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

Variable Size:

1

apoapsis_altitude(body: str, central_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

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

Function to add the apoapsis altitude of the current osculating orbit to the dependent variables to save. The altitude depends on the shape of the central body. This function takes the current (osculating) orbit of the body w.r.t. the central body, and uses this Kepler orbit to extract the position/altitude of apoapsis.

Parameters:
  • body (str) – Body whose dependent variable should be saved.

  • central_body (str) – Body with respect to which the altitude of apoapsis is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

central_body_fixed_spherical_position(body: str, central_body: str) → tudatpy.kernel.dynamics.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 return as the radius, latitude, longitude, defined in the body-fixed frame of the central body

Parameters:
  • body (str) – Body whose spherical position is to be saved.

  • central_body (str) – Body with respect to which the spherical, body-fixed is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

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

Function to add the relative Cartesian position, in the central body’s fixed frame, to the dependent variables to save.

Parameters:
  • body (str) – Body whose relative cartesian position is to be saved.

  • central_body (str) – Body with respect to which the cartesian, body-fixed is computed.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

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

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

Parameters:

body (str) – Body whose mass should be saved.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

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

Function to add the current 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

Variable Size:

1

total_mass_rate(body: str) → tudatpy.kernel.dynamics.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 mass rate should be saved.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

gravity_field_potential(body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the gravitational potential to the dependent variables to save.

Function to add the gravitational potential to the dependent variables to save. The gravitational potential is defined by the bodies undergoing and exerting the acceleration.

Parameters:
  • body_undergoing_acceleration (str) – Body whose dependent variable should be saved.

  • body_exerting_acceleration (str) – Body exerting acceleration.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

gravity_field_laplacian_of_potential(body_undergoing_acceleration: str, body_exerting_acceleration: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to add the laplacian of the gravitational potential to the dependent variables to save.

Function to add the laplacian of the gravitational potential to the dependent variables to save. The laplacian is defined by the bodies undergoing and exerting the acceleration.

Parameters:
  • body_undergoing_acceleration (str) – Body whose dependent variable should be saved.

  • body_exerting_acceleration (str) – Body exerting acceleration.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

minimum_body_distance(body_name: str, bodies_to_check: list[str]) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to compute the minimum distance between a given body, and a set of other bodies.

Function to compute the minimum distance between a given body, and a set of other bodies. This function takes the instantaneous position of body body_name, and each body in the list bodies_to_check, and computes the body from this list closest to body_name. In this calculation, the positions of the bodies are evaluated at the current propagation time, and therefore light time is ignored. In addition, this functions does not consider visibility requirements (e.g. is a planet between two bodies). The dependent variable is of size 2, and consists of: (0) The distance between the body, and the closest other body; (1) The index from bodies_to_check for which the distance (given by the first index) is closest to body Typically, this function is used to compute the closest body in a constellation of satellites.

Parameters:
  • body_name (str) – Body for which the distance to other bodies is to be computed.

  • bodies_to_check (list[ str ]) – List of bodies for which it is to be checked which of these bodies is closest to body_name.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

2

minimum_visible_station_body_distances(body_name: str, station_name: str, bodies_to_check: list[str], minimum_elevation_angle: float) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to compute the minimum distance between a ground station, and a set of other bodies visible from that station.

Function to compute the minimum distance between a ground station, and a set of other bodies visible from that station This function takes the instantaneous position of the ground station station_name on body_name, and each body in the list bodies_to_check, and computes the body from this list closest to this ground station, only taking into account those bodies from this list which are visible from the ground station. For this function, visibility is defined by a single elevation angle cutoff (at the ground station) below which a body is deemed to not be visible. In this calculation, the positions of the bodies are evaluated at the current propagation time, and therefore light time is ignored. The dependent variable is of size 3, and consists of: (0) The distance between the ground station, and the closest visible body; (1) The index from bodies_to_check for which the distance (given by the first index) is closest to thee ground station, and the body is visible. (2) Elevation angle for closest body. In case, no body is visible from the station, this function returns [NaN, -1, NaN]. Typically, this function is used to compute the closest body between a ground station and a constellation of satellites.

Parameters:
  • body_name (str) – Body on which ground station is located, for which the distance to other bodies is to be computed.

  • station_name (str) – Name of ground station, for which the distance to other bodies is to be computed.

  • bodies_to_check (list[ str ]) – List of bodies for which it is to be checked which of these bodies is closest to station_name on body_name.

  • minimum_elevation_angle (float) – Minimum elevation angle (at ground station) below which the distance to the bodies_to_check is not considered.

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

custom_dependent_variable(custom_function: Callable[[], numpy.ndarray[numpy.float64[m, 1]]], variable_size: int) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to compute a custom dependent variable.

Function to compute a custom dependent variable, which can be implemented by the user as a Python function. The custom dependent variable is typically dependent on the current properties of the environment (e.g. bodies in the environment) or a user-defined guidance class (or similar)

Parameters:
  • custom_function (callable[[], numpy.ndarray].) – Function taking no input, and returning the custom dependent variable (as a numpy Nx1 array).

  • variable_size (int) – Size N of the array returned by the custom_function

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

``variable_size``

received_irradiance(target_body: str, source_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to save the received irradiance from a give source.

Function to save the received irradiance (in W/m^{2}) from a given source, as used in the computation of radiation pressure

Parameters:
  • target_body (str) – Name of body at the location of which the irradiance is to be returned

  • source_body (str) – Name of body from which the radiation originates that causes the irradiance at the target body

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

received_irradiance_shadow_function(target_body: str, source_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to save the shadow function that reduces the received irradiance from a given source.

Function to save the shadow function that reduces the received irradiance from a given source, as a result of occultation of radiation between the source and the target. The shadow function is by definition between 0 (no irradiance is received, total occultation) and 1 (all irradiance is received, no occultation)

Parameters:
  • target_body (str) – Name of body at the location of which the irradiance is to be returned

  • source_body (str) – Name of body from which the radiation originates that causes the irradiance at the target body

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

actual_cross_section(target_name: str, central_body_name: str, acceleration_type: str = 'radiation_pressure') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the actual cross section of target_name with respect to central_body_name for acceleration_type.

Parameters:
  • target_name (str) – Name of the body receiving the radiation or aerodynamic force.

  • central_body_name (str) – Name of the body defining the atmosphere or the source of the selected acceleration.

  • acceleration_type (str, default = "radiation_pressure") – Type of acceleration to which the settings apply.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

aerodynamic_coefficients(target_name: str, central_body_name: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the aerodynamic coefficients of target_name in the environment of central_body_name.

Parameters:
  • target_name (str) – Name of the body receiving the radiation or aerodynamic force.

  • central_body_name (str) – Name of the body defining the atmosphere or the source of the selected acceleration.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

aerodynamic_force_coefficients_control_surface_increment(body: str, control_surface_name: str, central_body: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the three force-coefficient increments of control_surface_name on body.

central_body identifies the atmospheric body when required.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • control_surface_name (str) – Identifier of the control surface whose coefficient increment is saved.

  • central_body (str, default = "") – Name of the body relative to which the state or aerodynamic quantity is defined.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

aerodynamic_force_coefficients_control_surface_free(body: str, central_body: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the three aerodynamic force coefficients excluding control-surface increments for body.

central_body identifies the atmospheric body when required.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • central_body (str, default = "") – Name of the body relative to which the state or aerodynamic quantity is defined.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

aerodynamic_moment_coefficients_control_surface_increment(body: str, control_surface_name: str, central_body: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the three moment-coefficient increments of control_surface_name on body.

central_body identifies the atmospheric body when required.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • control_surface_name (str) – Identifier of the control surface whose coefficient increment is saved.

  • central_body (str, default = "") – Name of the body relative to which the state or aerodynamic quantity is defined.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

aerodynamic_moment_coefficients_control_surface_free(body: str, central_body: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the three aerodynamic moment coefficients excluding control-surface increments for body.

central_body identifies the atmospheric body when required.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • central_body (str, default = "") – Name of the body relative to which the state or aerodynamic quantity is defined.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

center_of_mass(body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the three-component body-fixed centre of mass of body, in metres.

Parameters:

body (str) – Name of the body for which the settings are created.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3

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

Create settings to save the deflection angle of control_surface on body, in radians.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • control_surface (str) – Identifier of the control surface whose deflection is saved.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

cross_section_change(target_name: str, source_name: str, acceleration_type: str = 'radiation_pressure') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the change in effective cross section of target_name for source_name and the selected acceleration_type.

Parameters:
  • target_name (str) – Name of the body receiving the radiation or aerodynamic force.

  • source_name (str) – Name of the radiation source body.

  • acceleration_type (str, default = "radiation_pressure") – Type of acceleration to which the settings apply.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

full_body_paneled_geometry(target_name: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the full panel geometry of target_name.

Parameters:

target_name (str) – Name of the body receiving the radiation or aerodynamic force.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

9 * number of vehicle panels

illuminated_panel_fraction(target_name: str, source_name: str, panel_type: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the illuminated fraction of panels on target_name due to source_name.

panel_type optionally restricts the selected panels.

Parameters:
  • target_name (str) – Name of the body receiving the radiation or aerodynamic force.

  • source_name (str) – Name of the radiation source body.

  • panel_type (str, default = "") – Panel type for which the illuminated fractions are saved; an empty string includes all panel types.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

Number of selected target panels

inertia_tensor(body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the body-fixed inertia tensor of body, in kilograms times square metres.

Parameters:

body (str) – Name of the body for which the settings are created.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

9

per_target_panel_radiation_pressure_force(target_name: str, source_name: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create panel surface-normal output settings through the current compatibility binding.

This binding currently calls the inertial-frame surface-normal factory: target_name is used as the body name and source_name as the vehicle part name. It returns SingleDependentVariableSaveSettings for normals rather than panel radiation forces.

Parameters:
  • target_name (str) – Name of the body whose panel surface normals are saved.

  • source_name (str) – Vehicle part identifier passed to the surface-normal factory by this compatibility binding.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3 * number of selected vehicle panels

radiation_pressure_source_panel_geometry(target_name: str, source_name: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save the panel geometry of source_name as seen from target_name.

Parameters:
  • target_name (str) – Name of the body receiving the radiation or aerodynamic force.

  • source_name (str) – Name of the radiation source body.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

7 * number of panels on the radiation source

radiation_pressure_source_panel_irradiance(target_name: str, source_name: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save irradiance contributions from individual panels of source_name at target_name.

Parameters:
  • target_name (str) – Name of the body receiving the radiation or aerodynamic force.

  • source_name (str) – Name of the radiation source body.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

Number of panels on the radiation source

total_spherical_harmonic_cosine_coefficient_variations(body: str, minimum_degree: int, maximum_degree: int, minimum_order: int, maximum_order: int) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save total time-dependent variations of the cosine gravity coefficients of body.

The inclusive minimum_degree, maximum_degree, minimum_order and maximum_order bounds select the coefficient block.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • minimum_degree (int) – Minimum spherical harmonic degree to include.

  • maximum_degree (int) – Maximum spherical harmonic degree to include in the calculation.

  • minimum_order (int) – Minimum spherical harmonic order to include.

  • maximum_order (int) – Maximum spherical harmonic order to include in the calculation.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

Number of selected coefficients with order no greater than degree

total_spherical_harmonic_sine_coefficient_variations(body: str, minimum_degree: int, maximum_degree: int, minimum_order: int, maximum_order: int) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save total time-dependent variations of the sine gravity coefficients of body.

The inclusive minimum_degree, maximum_degree, minimum_order and maximum_order bounds select the coefficient block.

Parameters:
  • body (str) – Name of the body for which the settings are created.

  • minimum_degree (int) – Minimum spherical harmonic degree to include.

  • maximum_degree (int) – Maximum spherical harmonic degree to include in the calculation.

  • minimum_order (int) – Minimum spherical harmonic order to include.

  • maximum_order (int) – Maximum spherical harmonic order to include in the calculation.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

Number of selected coefficients with order no greater than degree

vehicle_panel_surface_normals_body_fixed_frame(body_name: str, part_name: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create panel surface-normal output settings for body_name and optional part_name.

This binding currently calls the inertial-frame surface-normal factory and therefore produces inertial-frame normals.

Parameters:
  • body_name (str) – Name of the body in the system of bodies.

  • part_name (str, default = "") – Identifier of the vehicle part whose panels are used; an empty string selects all panels.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3 * number of selected vehicle panels

vehicle_panel_surface_normals_inertial_frame(body_name: str, part_name: str = '') → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Create settings to save inertial-frame unit surface normals for the panels of body_name.

part_name optionally selects a vehicle part.

Parameters:
  • body_name (str) – Name of the body in the system of bodies.

  • part_name (str, default = "") – Identifier of the vehicle part whose panels are used; an empty string selects all panels.

Returns:

Settings for saving the requested dependent variable.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

3 * number of selected vehicle panels

visible_radiation_source_area(target_body: str, source_body: str) → tudatpy.kernel.dynamics.propagation_setup.dependent_variable.SingleDependentVariableSaveSettings

Function to save the shadow function that reduces the received irradiance from a given source.

Function to save the shadow function that reduces the received irradiance from a given source, as a result of occultation of radiation between the source and the target. The shadow function is by definition between 0 (no irradiance is received, total occultation) and 1 (all irradiance is received, no occultation)

Parameters:
  • target_body (str) – Name of body at the location of which the irradiance is to be returned

  • source_body (str) – Name of body from which the radiation originates that causes the irradiance at the target body

Returns:

Dependent variable settings object.

Return type:

SingleDependentVariableSaveSettings

Variable Size:

1

Enumerations

PropagationDependentVariables

Enumeration of available propagation dependent variables.

class PropagationDependentVariables

Bases: pybind11_object

Enumeration of available propagation dependent variables.

Enumeration of propagation dependent variables supported by tudat.

Members:

mach_number_type :

altitude_type :

airspeed_type :

local_density_type :

relative_speed_type :

relative_position_type :

relative_distance_type :

relative_velocity_type :

radiation_pressure_type :

total_acceleration_norm_type :

single_acceleration_norm_type :

total_acceleration_type :

single_acceleration_type :

aerodynamic_force_coefficients_type :

aerodynamic_moment_coefficients_type :

rotation_matrix_to_body_fixed_frame_type :

intermediate_aerodynamic_rotation_matrix_type :

relative_body_aerodynamic_orientation_angle_type :

body_fixed_airspeed_based_velocity_type :

total_aerodynamic_g_load_type :

stagnation_point_heat_flux_type : Heat flux at the vehicle stagnation point.

local_temperature_type :

geodetic_latitude_type :

control_surface_deflection_type :

total_mass_rate_type :

tnw_to_inertial_frame_rotation_type :

rsw_to_inertial_frame_rotation_type :

periapsis_altitude_type :

apoapsis_altitude_type :

total_torque_norm_type :

single_torque_norm_type :

total_torque_type :

single_torque_type :

body_fixed_groundspeed_based_velocity_type :

local_wind_velocity_type :

keplerian_state_type :

modified_equinoctial_state_type :

spherical_harmonic_acceleration_terms_type :

spherical_harmonic_acceleration_norm_terms_type :

body_fixed_relative_cartesian_position_type :

body_fixed_relative_spherical_position_type :

total_gravity_field_variation_acceleration_type :

single_gravity_field_variation_acceleration_type :

single_gravity_field_variation_acceleration_terms_type :

acceleration_partial_wrt_body_translational_state_type :

total_acceleration_partial_wrt_body_translational_state_type :

acceleration_derivative_partial_wrt_parameter_type :

total_acceleration_derivative_partial_wrt_parameter_type :

local_dynamic_pressure_type :

euler_angles_to_body_fixed_type :

current_body_mass_type :

radiation_pressure_coefficient_type :

custom_type : Dependent variable evaluated by a user-supplied function.

gravity_field_potential_type :

gravity_field_laplacian_of_potential_type :

vehicle_part_rotation_matrix_type :

solar_longitude_type :

number_density_type :

PropagationDependentVariables.name -> str

read-only

Classes

VariableSettings

Functional base class to define settings for variables.

SingleDependentVariableSaveSettings

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

SingleAccelerationDependentVariableSaveSettings

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

class VariableSettings

Bases: pybind11_object

Functional base class to define settings for variables.

This class is a functional base class for defining settings for variables. Any variable that requires additional information in addition to what can be provided here, should be defined by a dedicated derived class.

static load_from_binary(path: str) → object

Deserialize this object from binary. Python pickle uses the same serialization schema. Compatibility with other builds is not guaranteed. Only load trusted files.

static load_from_json(path: str) → object

Deserialize this object from JSON. Python pickle uses the same serialization schema. Compatibility with other builds is not guaranteed. Only load trusted files.

save_to_binary(self: tudatpy.kernel.dynamics.propagation_setup.dependent_variable.VariableSettings, path: str) → None

Serialize this object in binary form. Python pickle uses the same serialization schema. Compatibility with other builds is not guaranteed.

save_to_json(self: tudatpy.kernel.dynamics.propagation_setup.dependent_variable.VariableSettings, path: str) → None

Serialize this object to JSON. Python pickle uses the same serialization schema. Compatibility with other builds is not guaranteed.

class SingleDependentVariableSaveSettings

Bases: VariableSettings

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

Functional base class for defining settings for dependent variables that are to be computed and saved during propagation. Any dependent variable that requires additional information in addition to what can be provided here, should be defined by a dedicated derived class.

property associated_body

read-only

Body associated with variable.

Type:

str

property component_index

read-only

Index of the component to be saved.

Note

This parameter is only applicable for vectorial dependent variables. If negative, all components of the vector are saved.

Type:

int

property dependent_variable_type

read-only

Type of the dependent variable that is being saved.

Type:

PropagationDependentVariables

property secondary_body

read-only

Secondary body w.r.t. which parameter is defined, e.g. relative position is defined for the associated body w.r.t. secondary body.

Note

This parameter is not necessarily defined. In this case an empty string is returned.

Type:

str

class SingleAccelerationDependentVariableSaveSettings

Bases: SingleDependentVariableSaveSettings

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

Class to define settings for saving a single acceleration (norm or vector) during propagation. Note: this acceleration is returned in the inertial frame!

property acceleration_model_type

read-only

The type of the acceleration that is to be saved.

Type:

AvailableAcceleration