:py:mod:`BladeAD.utils.define_rotor_analysis`
=============================================

.. py:module:: BladeAD.utils.define_rotor_analysis


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


Functions
~~~~~~~~~

.. autoapisummary::

   BladeAD.utils.define_rotor_analysis.run_rotor_analysis



.. py:function:: run_rotor_analysis(model: str, radius: Union[float, csdl_alpha.Variable], chord_profile: Union[numpy.ndarray, csdl_alpha.Variable], twist_profile: Union[numpy.ndarray, csdl_alpha.Variable], rpm: Union[float, csdl_alpha.Variable], mesh_velocity: Union[numpy.ndarray, csdl_alpha.Variable], thrust_vector: Union[numpy.ndarray, csdl_alpha.Variable] = np.array([1, 0, 0]), thrust_origin: Union[numpy.ndarray, csdl_alpha.Variable] = np.array([0.0, 0.0, 0.0]), num_nodes: int = 1, num_radial: int = 35, num_azimuthal: int = 50, num_blades: int = 4, norm_hub_radius: float = 0.2, theta_0: Union[float, csdl_alpha.Variable] = 0.0, theta_1_c: Union[float, csdl_alpha.Variable] = 0.0, theta_1_s: Union[float, csdl_alpha.Variable] = 0.0, xi_0: Union[float, csdl_alpha.Variable] = 0.0, xi_1_c: Union[float, csdl_alpha.Variable] = 0.0, xi_1_s: Union[float, csdl_alpha.Variable] = 0.0, Q: int = 3, M: int = 3, tip_loss: bool = True, airfoil_model=NACA4412MLAirfoilModel(), integration_scheme='trapezoidal') -> BladeAD.utils.var_groups.RotorAnalysisOutputs

   
   Run rotor analysis using either BEM, Pitt-Peters, and Peters-He models.


   :Parameters:

       **model** : str
           Model to run. Options are "bem", "pitt_peters", or "peters_he"

       **radius** : Union[float, csdl.Variable]
           Radius of the rotor

       **chord_profile** : Union[np.ndarray, csdl.Variable]
           Chord profile of the rotor

       **twist_profile** : Union[np.ndarray, csdl.Variable]
           Twist profile of the rotor

       **rpm** : Union[float, csdl.Variable]
           Rotor speed in RPM

       **mesh_velocity** : Union[np.ndarray, csdl.Variable]
           Mesh velocity

       **thrust_vector** : Union[np.ndarray, csdl.Variable], optional
           Thrust vector, by default np.array([1, 0, 0])

       **thrust_origin** : Union[np.ndarray, csdl.Variable], optional
           Thrust origin, by default np.array([0., 0., 0.])

       **num_nodes** : int, optional
           Number of evaluation points, by default 1

       **num_radial** : int, optional
           Number of radial sections, by default 35

       **num_azimuthal** : int, optional
           Number of azimuthal sections, by default 50

       **num_blades** : int, optional
           Number of blades, by default 4

       **norm_hub_radius** : float, optional
           Normalized hub radius, by default 0.2

       **Q** : int, optional
           Highest power of r/R in Peters-He model, by default 3
           only used if model is "peters_he"

       **M** : int, optional
           Highest harmonic number in Peters-He model, by default 3
           only used if model is "peters_he"

       **airfoil_model** : NACA4412MLAirfoilModel, optional
           Airfoil model, by default NACA4412MLAirfoilModel()  

   :Returns:

       RotorAnalysisOutputs
           Rotor analysis outputs. Data class that stores rotor analysis
           outputs such as total thrust, total torque, etc.













   ..
       !! processed by numpydoc !!