:orphan:

.. ****************************************************************************
.. CUI
..
.. The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
..
.. The use, dissemination or disclosure of data in this file is subject to
.. limitation or restriction. See accompanying README and LICENSE for details.
.. ****************************************************************************

.. _SixDOF_Landing_Gear_Label:

SixDOF Landing Gear
===================

The landing gear block defines the landing gear on a :command:`rigid_body_vehicle_type`. The main components of landing_gear_ are ground_reaction_point_ objects.


.. command:: landing_gear ... end_landing_gear

   .. parsed-literal::

    landing_gear
   
      nws_enable_control_name_ ...
      
      nominal_height_above_ground_on_gear_ ...
       
      ground_reaction_point_ NoseGear
        ...
      end_ground_reaction_point

      ground_reaction_point_ LeftMainGear
        ...
      end_ground_reaction_point

      ground_reaction_point_ RightMainGear
        ...
      end_ground_reaction_point
      
    end_landing_gear
    
.. command:: nws_enable_control_name <string>

   This specifies the nose wheel steering (NWS) enable control input.
   
.. command:: nominal_height_above_ground_on_gear <length-value>

   This specifies the height above the ground for the reference point of the aircraft when resting on the landing gear.
       
.. command:: ground_reaction_point ... end_ground_reaction_point

   .. parsed-literal::

    ground_reaction_point <string>
      
      // Retraction Control Name
      control_surface_name_ ...
      
      // Steering Control Name
      steering_control_surface_name_ ...
      nws_angle_control_surface_name_ ...
      
      // Nose Gear Flag
      is_nose_gear_ ...         

      // Braking Control Name
      braking_control_surface_name_ ...         

      // Relative Position
      gear_extended_relative_position_x_ ...
      gear_extended_relative_position_y_ ...
      gear_extended_relative_position_z_ ...
      
      // Compression Vector
      gear_compression_vector_x_ ...
      gear_compression_vector_y_ ...
      gear_compression_vector_z_ ...

      // Rolling Vector
      gear_rolling_vector_x_ ...
      gear_rolling_vector_y_ ...
      gear_rolling_vector_z_ ...         
      
      // Spring/Damper
      spring_constant_lbs_per_ft_ ...
      damper_constant_lbs_per_fps_ ...
      
      // Compression Data
      uncompressed_length_ ...
      max_compression_ ...
      
      // Friction Data
      rolling_coefficient_of_friction_ ...         
      braking_coefficient_of_friction_ ...
      scuffing_coefficient_of_friction_ ...      
      ignore_friction_ ...
      
      // Landing Gear or Contact Point
      is_landing_gear_ ...
      is_contact_point_ ...
       
    end_ground_reaction_point


.. command:: control_surface_name <string>

   This specifies the name of the retraction control surface.

.. command:: steering_control_surface_name <string>

   This specifies the name of the steering control surface (when NWS is not engaged/active).

.. command:: nws_angle_control_surface_name <string>

   This specifies the name of the steering control surface (when NWS is engaged/active).

.. command:: is_nose_gear <boolean-value>

   This indicates whether or not this ground_reaction_point_ is a nose gear.

.. command:: braking_control_surface_name <string>   

   This specifies the name of the braking control surface. If unspecified, no braking is provided for this ground_reaction_point_.

.. command:: gear_extended_relative_position_x <length-value>

   This is the x-location (in object coordinates) of the bottom of the landing gear (or contact point) when extended.

.. command:: gear_extended_relative_position_y <length-value>

   This is the y-location (in object coordinates) of the bottom of the landing gear (or contact point) when extended.

.. command:: gear_extended_relative_position_z <length-value>

   This is the z-location (in object coordinates) of the bottom of the landing gear (or contact point) when extended.

.. command:: gear_compression_vector_x <real-value>

   This is the x-direction (in object coordinates) of the compression vector.

.. command:: gear_compression_vector_y <real-value>

   This is the y-direction (in object coordinates) of the compression vector.

.. command:: gear_compression_vector_z <real-value>

   This is the z-direction (in object coordinates) of the compression vector.

.. command:: gear_rolling_vector_x <real-value>

   This is the x-direction (in object coordinates) of the rolling vector.

.. command:: gear_rolling_vector_y <real-value>

   This is the y-direction (in object coordinates) of the rolling vector.

.. command:: gear_rolling_vector_z <real-value>

   This is the z-direction (in object coordinates) of the rolling vector.

.. command:: spring_constant_lbs_per_ft <real-value>

   This is the spring constant in lbs/ft.

.. command:: damper_constant_lbs_per_fps <real-value>

   This is the damper constant in lbs/(ft/sec).

.. command:: uncompressed_length <length-value>

   This is the uncompressed length of the landing gear.

.. command:: max_compression <length-value>

   This is the maximum length of compression.

.. command:: rolling_coefficient_of_friction <real-value>

   This is the rolling coefficient of friction.

.. command:: braking_coefficient_of_friction <real-value>

   This is the braking coefficient of friction.

.. command:: scuffing_coefficient_of_friction <real-value>

   This is the scuffing coefficient of friction.

.. command:: ignore_friction <boolean-value>

   This indicates if friction should be ignored.

.. command:: is_landing_gear <boolean-value>

   This indicates if the ground_reaction_point_ is a landing gear (true) or a contact point (false).

.. command:: is_contact_point <boolean-value>

   This indicates if the ground_reaction_point_ is a contact point (true) or a landing gear (false).
   
////////////////////////////////////////////////

Return to :doc:`rigid_body_vehicle_type`