Source code for aerosandbox.dynamics.point_mass.point_1D.vertical

from aerosandbox.dynamics.point_mass.point_3D.cartesian import (
    DynamicsPointMass3DCartesian,
)
from aerosandbox.weights.mass_properties import MassProperties
import aerosandbox.numpy as np
from typing import Union, Dict


[docs]class DynamicsPointMass1DVertical(DynamicsPointMass3DCartesian):
    """
    Dynamics instance:
    * simulating a point mass
    * in 1D, oriented vertically (i.e., the .add_gravity() method will have an effect)

    State variables:
        z_e: z-position, in Earth axes. [meters]
        w_e: z-velocity, in Earth axes. [m/s]

    Control variables:
        Fz_e: Force along the Earth-x axis. [N]

    """

    def __init__(
        self,
        mass_props: MassProperties = None,
        z_e: Union[float, np.ndarray] = 0,
        w_e: Union[float, np.ndarray] = 0,
    ):
        # Initialize state variables
[docs]        self.mass_props = MassProperties() if mass_props is None else mass_props
[docs]        self.x_e = 0
[docs]        self.y_e = 0
[docs]        self.z_e = z_e
[docs]        self.u_e = 0
[docs]        self.v_e = 0
[docs]        self.w_e = w_e

        # Initialize indirect control variables
[docs]        self.alpha = 0
[docs]        self.beta = 0
[docs]        self.bank = 0

        # Initialize control variables
[docs]        self.Fx_e = 0
[docs]        self.Fy_e = 0
[docs]        self.Fz_e = 0

    @property
[docs]    def state(self) -> Dict[str, Union[float, np.ndarray]]:
        return {
            "z_e": self.z_e,
            "w_e": self.w_e,
        }

    @property
[docs]    def control_variables(self) -> Dict[str, Union[float, np.ndarray]]:
        return {
            "Fz_e": self.Fz_e,
        }

[docs]    def state_derivatives(self) -> Dict[str, Union[float, np.ndarray]]:
        derivatives = super().state_derivatives()
        return {k: derivatives[k] for k in self.state.keys()}


if __name__ == "__main__":
[docs]    dyn = DynamicsPointMass1DVertical()