"""Defines the StochasticFlight class."""
from rocketpy.simulation import Flight
from .stochastic_model import StochasticModel
[docs]
class StochasticFlight(StochasticModel):
"""A Stochastic Flight class that inherits from StochasticModel.
See Also
--------
:ref:`stochastic_model` and :class:`Flight <rocketpy.simulation.Flight>`
Attributes
----------
flight : Flight
The Flight object to be used as a base for the Stochastic flight.
rail_length : int, float, tuple, list
The rail length of the flight.
inclination : int, float, tuple, list
The inclination of the launch rail.
heading : int, float, tuple, list
The heading of the launch rail.
initial_solution : tuple, list
The initial solution of the flight. This is a tuple of 14 elements that
represent the initial conditions of the flight. This attribute can not
be randomized.
terminate_on_apogee : bool
Whether or not the flight should terminate on apogee. This attribute
can not be randomized.
time_overshoot : bool
If False, the simulation will run at the time step defined by the controller
sampling rate. Be aware that this will make the simulation run much slower.
"""
[docs]
def __init__(
self,
flight,
rail_length=None,
inclination=None,
heading=None,
initial_solution=None,
terminate_on_apogee=None,
time_overshoot=None,
):
"""Initializes the Stochastic Flight class.
See Also
--------
:ref:`stochastic_model` and :class:`Flight <rocketpy.simulation.Flight>`
Parameters
----------
flight : Flight
The Flight object to be used as a base for the Stochastic flight.
rail_length : int, float, tuple, list, optional
The rail length of the flight.
inclination : int, float, tuple, list, optional
The inclination of the launch rail.
heading : int, float, tuple, list, optional
The heading of the launch rail.
initial_solution : tuple, list, optional
The initial solution of the flight. This is a tuple of 14 elements
that represent the initial conditions of the flight. This attribute
can not be randomized.
terminate_on_apogee : bool, optional
Whether or not the flight should terminate on apogee. This attribute
can not be randomized.
time_overshoot : bool
If False, the simulation will run at the time step defined by the controller
sampling rate. Be aware that this will make the simulation run much slower.
"""
if terminate_on_apogee is not None:
assert isinstance(terminate_on_apogee, bool), (
"`terminate_on_apogee` must be a boolean"
)
if time_overshoot is not None:
if not isinstance(time_overshoot, bool):
raise TypeError("`time_overshoot` must be a boolean")
super().__init__(
flight,
rail_length=rail_length,
inclination=inclination,
heading=heading,
)
self.initial_solution = initial_solution
self.terminate_on_apogee = terminate_on_apogee
if time_overshoot is None:
self.time_overshoot = flight.time_overshoot
else:
self.time_overshoot = time_overshoot
def _validate_initial_solution(self, initial_solution):
if initial_solution is not None:
if isinstance(initial_solution, (tuple, list)):
assert len(initial_solution) == 14, (
"`initial_solution` must be a 14 element tuple, the "
"elements are:\n t_initial, x_init, y_init, z_init, "
"vx_init, vy_init, vz_init, e0_init, e1_init, e2_init, "
"e3_init, w1Init, w2Init, w3Init"
)
assert all(isinstance(i, (int, float)) for i in initial_solution), (
"`initial_solution` must be a tuple of numbers"
)
else:
raise TypeError("`initial_solution` must be a tuple of numbers")
# TODO: these methods call dict_generator a lot of times unnecessarily
[docs]
def _randomize_rail_length(self):
"""Randomizes the rail length of the flight."""
generated_dict = next(self.dict_generator())
return generated_dict["rail_length"]
[docs]
def _randomize_inclination(self):
"""Randomizes the inclination of the flight."""
generated_dict = next(self.dict_generator())
return generated_dict["inclination"]
[docs]
def _randomize_heading(self):
"""Randomizes the heading of the flight."""
generated_dict = next(self.dict_generator())
return generated_dict["heading"]
[docs]
def create_object(self):
"""Creates and returns a Flight object from the randomly generated input
arguments.
Returns
-------
flight : Flight
Flight object with the randomly generated input arguments.
"""
generated_dict = next(self.dict_generator())
# TODO: maybe we should use generated_dict["rail_length"] instead
return Flight(
environment=self.obj.env,
rail_length=self._randomize_rail_length(),
rocket=self.obj.rocket,
inclination=generated_dict["inclination"],
heading=generated_dict["heading"],
initial_solution=self.initial_solution,
terminate_on_apogee=self.terminate_on_apogee,
time_overshoot=self.time_overshoot,
)
