"""
Defines the StochasticNoseCone, StochasticTrapezoidalFins,
StochasticEllipticalFins, StochasticTail and StochasticRailButtons classes.
"""
from rocketpy.rocket.aero_surface import (
AirBrakes,
EllipticalFins,
NoseCone,
RailButtons,
Tail,
TrapezoidalFins,
)
from .stochastic_model import StochasticModel
[docs]
class StochasticNoseCone(StochasticModel):
"""The ``StochasticNoseCone`` class inherits from the StochasticModel. This
class is used to store a ``NoseCone`` object along with the uncertainty
of its parameters.
See Also
--------
:ref:`stochastic_model` and
:class:`NoseCone <rocketpy.rocket.aero_surface.NoseCone>`
Attributes
----------
object : NoseCone
NoseCone object to be used as a base for the Stochastic nose cone.
length : tuple, list, int, float
Length of the nose cone in meters.
kind : list[str]
List with a string representing the kind of nose cone.
base_radius : tuple, list, int, float
Nose cone base radius in meters.
bluffness : tuple, list, int, float
Bluffness of the nose cone.
rocket_radius : tuple, list, int, float
The reference rocket radius used for lift coefficient normalization, in
meters.
name : list[str]
List with the name of the NoseCone. This attribute can not be randomized.
"""
# TODO: Never vary the kind of the nose cone. Fixed parameter.
[docs]
def __init__(
self,
nosecone,
length=None,
kind=None, # TODO: Never vary the kind of the nose cone. Fixed parameter.
base_radius=None,
bluffness=None,
rocket_radius=None,
power=None,
):
"""Initializes the Stochastic Nose Cone class.
See Also
--------
See the :ref:`stochastic_model` and :ref:`nose_cone_class` for further
information.
Parameters
----------
nosecone : NoseCone
NoseCone object to be used as a base for the Stochastic nose cone.
length : tuple, list, int, float
Length of the nose cone in meters.
base_radius : tuple, list, int, float
Nose cone base radius in meters.
bluffness : tuple, list, int, float
Bluffness of the nose cone.
rocket_radius : tuple, list, int, float
The reference rocket radius used for lift coefficient normalization,
in meters.
"""
self._validate_kind(kind)
super().__init__(
nosecone,
length=length,
kind=kind,
base_radius=base_radius,
bluffness=bluffness,
rocket_radius=rocket_radius,
power=power,
name=None,
)
[docs]
def _validate_kind(self, kind):
"""Validates the kind input. If the kind input argument is not None, it
must be a list of strings."""
if kind is not None:
# TODO: Never vary the kind of the nose cone. It is a fixed parameter.
assert isinstance(kind, list) and all(
isinstance(member, str) for member in kind
), "`kind` must be a list of strings"
[docs]
def create_object(self):
"""Creates and returns a NoseCone object from the randomly generated
input arguments.
Returns
-------
nosecone : NoseCone
NoseCone object with the randomly generated input arguments.
"""
generated_dict = next(self.dict_generator())
return NoseCone(**generated_dict)
[docs]
class StochasticTrapezoidalFins(StochasticModel):
"""A Stochastic Trapezoidal Fins class that inherits from StochasticModel.
See Also
--------
:ref:`stochastic_model` and
:class:`TrapezoidalFins <rocketpy.TrapezoidalFins>`
Attributes
----------
object : TrapezoidalFins
TrapezoidalFins object to be used for validation.
n : list[int]
List with an integer representing the number of fins. This attribute
can be randomized.
root_chord : tuple, list, int, float
Root chord of the fins in meters.
tip_chord : tuple, list, int, float
Tip chord of the fins in meters.
span : tuple, list, int, float
Span of the fins in meters.
rocket_radius : tuple, list, int, float
Rocket radius of the fins in meters.
cant_angle : tuple, list, int, float
Cant angle of the fins in degrees.
sweep_length : tuple, list, int, float
Sweep length of the fins in meters.
sweep_angle : tuple, list, int, float
Sweep angle of the fins in degrees.
airfoil : list
List of tuples in the form of (airfoil file path, airfoil name).
name : list[str]
List with the object name. This attribute can not be randomized.
"""
[docs]
def __init__(
self,
trapezoidal_fins,
n=None, # TODO: Never vary the number of fins. It is a fixed parameter.
root_chord=None,
tip_chord=None,
span=None,
rocket_radius=None,
cant_angle=None,
sweep_length=None,
sweep_angle=None,
airfoil=None,
):
"""Initializes the Stochastic Trapezoidal Fins class.
See Also
--------
:ref:`stochastic_model`
Parameters
----------
trapezoidal_fins : TrapezoidalFins
TrapezoidalFins object to be used for validation.
root_chord : tuple, list, int, float
Root chord of the fins in meters.
tip_chord : tuple, list, int, float
Tip chord of the fins in meters.
span : tuple, list, int, float
Span of the fins in meters.
rocket_radius : tuple, list, int, float
Rocket radius of the fins in meters.
cant_angle : tuple, list, int, float
Cant angle of the fins in degrees.
sweep_length : tuple, list, int, float
Sweep length of the fins in meters.
sweep_angle : tuple, list, int, float
Sweep angle of the fins in degrees.
airfoil : list[tuple]
List of tuples in the form of (airfoil file path, airfoil name).
"""
# TODO: never vary the number of fins. It is a fixed parameter.
self._validate_positive_int_list("n", n)
self._validate_airfoil(airfoil)
super().__init__(
trapezoidal_fins,
n=n,
root_chord=root_chord,
tip_chord=tip_chord,
span=span,
rocket_radius=rocket_radius,
cant_angle=cant_angle,
sweep_length=sweep_length,
sweep_angle=sweep_angle,
airfoil=airfoil,
name=None,
)
[docs]
def create_object(self):
"""Creates and returns a TrapezoidalFins object from the randomly
generated input arguments.
Returns
-------
fins : TrapezoidalFins
TrapezoidalFins object with the randomly generated input arguments.
"""
generated_dict = next(self.dict_generator())
return TrapezoidalFins(**generated_dict)
[docs]
class StochasticEllipticalFins(StochasticModel):
"""A Stochastic Elliptical Fins class that inherits from StochasticModel.
See Also
--------
:ref:`stochastic_model` and
:class:`EllipticalFins <rocketpy.EllipticalFins>`
Attributes
----------
object : EllipticalFins
EllipticalFins object to be used for validation.
n : list[int]
List with an integer representing the number of fins. This attribute
can be randomized.
root_chord : tuple, list, int, float
Root chord of the fins in meters.
span : tuple, list, int, float
Span of the fins in meters.
rocket_radius : tuple, list, int, float
Rocket radius of the fins in meters.
cant_angle : tuple, list, int, float
Cant angle of the fins in degrees.
airfoil : list
List of tuples in the form of (airfoil file path, airfoil name).
name : list[str]
List with the fins object name. This attribute can not be randomized.
"""
[docs]
def __init__(
self,
elliptical_fins=None,
n=None,
root_chord=None,
span=None,
rocket_radius=None,
cant_angle=None,
airfoil=None,
):
"""Initializes the Stochastic Elliptical Fins class.
See Also
--------
:ref:`stochastic_model`
Parameters
----------
elliptical_fins : EllipticalFins
EllipticalFins object to be used for validation.
root_chord : tuple, list, int, float
Root chord of the fins in meters.
span : tuple, list, int, float
Span of the fins in meters.
rocket_radius : tuple, list, int, float
Rocket radius of the fins in meters.
cant_angle : tuple, list, int, float
Cant angle of the fins in degrees.
airfoil : list[tuple]
List of tuples in the form of (airfoil file path, airfoil name).
"""
# TODO: never vary the number of fins. It is a fixed parameter.
self._validate_positive_int_list("n", n)
self._validate_airfoil(airfoil)
super().__init__(
elliptical_fins,
n=n,
root_chord=root_chord,
span=span,
rocket_radius=rocket_radius,
cant_angle=cant_angle,
airfoil=airfoil,
name=None,
)
[docs]
def create_object(self):
"""Creates and returns a EllipticalFins object from the randomly
generated input arguments.
Returns
-------
fins : EllipticalFins
EllipticalFins object with the randomly generated input arguments.
"""
generated_dict = next(self.dict_generator())
return EllipticalFins(**generated_dict)
[docs]
class StochasticTail(StochasticModel):
"""A Stochastic Tail class that inherits from StochasticModel.
See Also
--------
:ref:`stochastic_model` and :class:`Tail <rocketpy.Tail>`
Attributes
----------
object : Tail
Tail object to be used for validation.
top_radius : tuple, list, int, float
Top radius of the tail in meters.
bottom_radius : tuple, list, int, float
Bottom radius of the tail in meters.
length : tuple, list, int, float
Length of the tail in meters.
rocket_radius : tuple, list, int, float
Rocket radius of the tail in meters.
name : list[str]
List with the name of the tail object. This cannot be randomized.
"""
[docs]
def __init__(
self,
tail,
top_radius=None,
bottom_radius=None,
length=None,
rocket_radius=None,
):
"""Initializes the Stochastic Tail class.
See Also
--------
:ref:`stochastic_model` and :class:`Tail <rocketpy.Tail>`
Parameters
----------
tail : Tail
Tail object to be used for validation.
top_radius : tuple, list, int, float
Top radius of the tail in meters.
bottom_radius : tuple, list, int, float
Bottom radius of the tail in meters.
length : tuple, list, int, float
Length of the tail in meters.
rocket_radius : tuple, list, int, float
Rocket radius of the tail in meters.
"""
super().__init__(
tail,
top_radius=top_radius,
bottom_radius=bottom_radius,
length=length,
rocket_radius=rocket_radius,
name=None,
)
[docs]
def create_object(self):
"""Creates and returns a Tail object from the randomly generated input
arguments.
Returns
-------
Tail
Tail object with the randomly generated input arguments.
"""
generated_dict = next(self.dict_generator())
return Tail(**generated_dict)
class StochasticAirBrakes(StochasticModel):
"""A Stochastic Air Brakes class that inherits from StochasticModel.
See Also
--------
:ref:`stochastic_model` and
:class:`AirBrakes <rocketpy.AirBrakes>`
Attributes
----------
object : AirBrakes
AirBrakes object to be used for validation.
drag_coefficient_curve : list, str
The drag coefficient curve of the air brakes can account for
either the air brakes' drag alone or the combined drag of both
the rocket and the air brakes.
drag_coefficient_curve_factor : tuple, list, int, float
The drag curve factor of the air brakes. This value scales the
drag coefficient curve to introduce stochastic variability.
reference_area : tuple, list, int, float
Reference area used to non-dimensionalize the drag coefficients.
clamp : bool
If True, the simulation will clamp the deployment level to 0 or 1 if
the deployment level is out of bounds. If False, the simulation will
not clamp the deployment level and will instead raise a warning if
the deployment level is out of bounds.
override_rocket_drag : bool
If False, the air brakes drag coefficient will be added to the
rocket's power off drag coefficient curve. If True, during the
simulation, the rocket's power off drag will be ignored and the air
brakes drag coefficient will be used for the entire rocket instead.
deployment_level : tuple, list, int, float
Initial deployment level, ranging from 0 to 1.
name : list[str]
List with the air brakes object name. This attribute can't be randomized.
"""
def __init__(
self,
air_brakes,
drag_coefficient_curve=None,
drag_coefficient_curve_factor=(1, 0),
reference_area=None,
clamp=None,
override_rocket_drag=None,
deployment_level=(0, 0),
):
"""Initializes the Stochastic AirBrakes class.
See Also
--------
:ref:`stochastic_model`
Parameters
----------
air_brakes : AirBrakes
AirBrakes object to be used for validation.
drag_coefficient_curve : list, str, optional
The drag coefficient curve of the air brakes can account for
either the air brakes' drag alone or the combined drag of both
the rocket and the air brakes.
drag_coefficient_curve_factor : tuple, list, int, float, optional
The drag curve factor of the air brakes. This value scales the
drag coefficient curve to introduce stochastic variability.
reference_area : tuple, list, int, float, optional
Reference area used to non-dimensionalize the drag coefficients.
clamp : bool, optional
If True, the simulation will clamp the deployment level to 0 or 1 if
the deployment level is out of bounds. If False, the simulation will
not clamp the deployment level and will instead raise a warning if
the deployment level is out of bounds.
override_rocket_drag : bool, optional
If False, the air brakes drag coefficient will be added to the
rocket's power off drag coefficient curve. If True, during the
simulation, the rocket's power off drag will be ignored and the air
brakes drag coefficient will be used for the entire rocket instead.
deployment_level : tuple, list, int, float, optional
Initial deployment level, ranging from 0 to 1.
"""
super().__init__(
air_brakes,
drag_coefficient_curve=drag_coefficient_curve,
drag_coefficient_curve_factor=drag_coefficient_curve_factor,
reference_area=reference_area,
clamp=clamp,
override_rocket_drag=override_rocket_drag,
deployment_level=deployment_level,
name=None,
)
def create_object(self):
"""Creates and returns an AirBrakes object from the randomly generated
input arguments.
Returns
-------
air_brake : AirBrakes
AirBrakes object with the randomly generated input arguments.
"""
generated_dict = next(self.dict_generator())
air_brakes = AirBrakes(
drag_coefficient_curve=generated_dict["drag_coefficient_curve"],
reference_area=generated_dict["reference_area"],
clamp=generated_dict["clamp"],
override_rocket_drag=generated_dict["override_rocket_drag"],
deployment_level=generated_dict["deployment_level"],
)
air_brakes.drag_coefficient *= generated_dict["drag_coefficient_curve_factor"]
return air_brakes
