propagation#

Functionalities and utilities of propagation objects.

This module provides functionalities for propagation settings objects. It also contains some utility functions that extract specific quantities from propagation settings and body objects. Note that the classes in this module are rarely created manually, but are instead created by the functionality in the propagation_setup module.

Functions#

get_state_of_bodies(bodies_to_propagate, ...)

Function to get the states of a set of bodies, with respect to some set of central bodies, at the requested time.

combine_initial_states(...)

Function to retrieve the initial state for a list of propagator settings.
get_state_of_bodies(bodies_to_propagate: List[str], central_bodies: List[str], body_system: tudatpy.kernel.numerical_simulation.environment.SystemOfBodies, initial_time: float) → numpy.ndarray[numpy.float64[m, 1]]#

Function to get the states of a set of bodies, with respect to some set of central bodies, at the requested time.

Function to get the states of a set of bodies, with respect to some set of central bodies, at the requested time.

Parameters

  • bodies_to_propagate (body_system) – List of bodies to be propagated.

  • central_bodies (list[str]) – List of central bodies, each referred to a body being propagated (in the same order).

  • bodies_to_propagate – System of bodies used in the propagation.

  • initial_time (float) – Initial time of the propagation.

Returns

Time at which the states should be retrieved.

Return type

numpy.ndarray

combine_initial_states(propagator_settings_per_type: Dict[tudat::propagators::IntegratedStateType, List[tudat::propagators::SingleArcPropagatorSettings<double>]]) → numpy.ndarray[numpy.float64[m, 1]]#

Function to retrieve the initial state for a list of propagator settings.

Function to retrieve the initial state for a list of propagator settings. This way, the initial state for different quantities to be propagated (e.g., translational state, rotational state, mass) are retrieved and organized in a single container.

Parameters

propagator_settings_per_type (dict) – Propagator settings where the type of propagation is reported as key and the respective list of propagator settings as value.

Returns

Vector of initial states, sorted in order of IntegratedStateType, and then in the order of the vector of SingleArcPropagatorSettings of given type.

Return type

numpy.ndarray

Enumerations#

PropagationTerminationReason

Enumeration of types of termination of propagation.
class PropagationTerminationReason#

Enumeration of types of termination of propagation.

Members:

propagation_never_run

unknown_reason

termination_condition_reached

runtime_error_caught_in_propagation

nan_or_inf_detected_in_state

property name#

Classes#

PropagationTerminationDetails

Object that provides information on the reason for the termination of the propagation.
class PropagationTerminationDetails#

Object that provides information on the reason for the termination of the propagation.

property terminated_on_exact_condition#

Boolean defining whether the propagation was terminated on an exact final condition, or once the propagation went past the determined final condition. The choice of behaviour is defined by the termination settings provided as input to the Simulator object. This variable only has a meaningful definition if the termination_reason has value termination_condition_reached

Type

bool

property termination_reason#

Enum defining the reason the propagation was terminated

Type

PropagationTerminationReason