aerosandbox.weights.mass_properties_of_shapes
=============================================

.. py:module:: aerosandbox.weights.mass_properties_of_shapes


Functions
---------

.. autoapisummary::

   aerosandbox.weights.mass_properties_of_shapes.mass_properties_from_radius_of_gyration
   aerosandbox.weights.mass_properties_of_shapes.mass_properties_of_ellipsoid
   aerosandbox.weights.mass_properties_of_shapes.mass_properties_of_sphere
   aerosandbox.weights.mass_properties_of_shapes.mass_properties_of_rectangular_prism
   aerosandbox.weights.mass_properties_of_shapes.mass_properties_of_cube


Module Contents
---------------

.. py:function:: mass_properties_from_radius_of_gyration(mass, x_cg = 0, y_cg = 0, z_cg = 0, radius_of_gyration_x = 0, radius_of_gyration_y = 0, radius_of_gyration_z = 0)

   Returns the mass properties of an object, given its radius of gyration.

   It's assumed that the principle axes of the inertia tensor are aligned with the coordinate axes.

   This is a shorthand convenience function for common usage of the MassProperties constructor. For more detailed
   use, use the MassProperties object directly.

   :param mass: Mass [kg]
   :param x_cg: x-position of the center of gravity
   :param y_cg: y-position of the center of gravity
   :param z_cg: z-position of the center of gravity
   :param radius_of_gyration_x: Radius of gyration along the x-axis, about the center of gravity [m]
   :param radius_of_gyration_y: Radius of gyration along the y-axis, about the center of gravity [m]
   :param radius_of_gyration_z: Radius of gyration along the z-axis, about the center of gravity [m]

   Returns: MassProperties object.



.. py:function:: mass_properties_of_ellipsoid(mass, radius_x, radius_y, radius_z)

   Returns the mass properties of an ellipsoid centered on the origin.

   :param mass: Mass [kg]
   :param radius_x: Radius along the x-axis [m]
   :param radius_y: Radius along the y-axis [m]
   :param radius_z: Radius along the z-axis [m]

   Returns: MassProperties object.



.. py:function:: mass_properties_of_sphere(mass, radius)

   Returns the mass properties of a sphere centered on the origin.

   :param mass: Mass [kg]
   :param radius: Radius [m]

   Returns: MassProperties object.



.. py:function:: mass_properties_of_rectangular_prism(mass, length_x, length_y, length_z)

   Returns the mass properties of a rectangular prism centered on the origin.

   :param mass: Mass [kg]
   :param length_x: Side length along the x-axis [m]
   :param length_y: Side length along the y-axis [m]
   :param length_z: Side length along the z-axis [m]

   Returns: MassProperties object.



.. py:function:: mass_properties_of_cube(mass, side_length)

   Returns the mass properties of a cube centered on the origin.

   :param mass: Mass [kg]
   :param side_length: Side length of the cube [m]

   Returns: MassProperties object.