: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.
.. ****************************************************************************

WSF_SUBSURFACE_MOVER
--------------------

.. model:: mover WSF_SUBSURFACE_MOVER

    .. inputs::

     mover :model:`WSF_SURFACE_MOVER`

        :ref:`Platform_Part_Commands` ...

        // `Mover Commands`_

        update_interval_ ...
        update_time_tolerance_ ...

        :ref:`WSF_SUBSURFACE_MOVER.Route_Mover_Commands`

        angle_of_attack_table_
        bank_angle_limit_
        body_g_limit_
        heading_pursuit_gain_
        maximum_climb_rate_
        maximum_flight_path_angle_
        maximum_linear_acceleration_
        maximum_radial_acceleration_
        maximum_altitude_
        minimum_altitude_
        maximum_speed_
        minimum_speed_
        path_variance_radius_
        roll_rate_limit_
        speed_variance_percent_
        turn_rate_limit_

     end_mover

Overview
========

WSF_SUBSURFACE_MOVER implements a mover for submersible vehicles.  WSF_SUBSURFACE_MOVER is a :ref:`Route_Mover`.

Commands
========

.. command:: update_interval <time-value>

   If non-zero, specifies a periodic time interval at which the simulation will call the mover.  If zero then the mover
   will be called only when it is necessary to determine the position of the containing platform.

   Default: 0 seconds unless overridden by the specific mover implementation.

.. command:: update_time_tolerance <time-value>

   When a position update is requested by the simulation, if the time since the previous update is less than or equal to
   this value then the mover will ignore the update.

   Default: Most mover implementations define this as the time it takes to travel 1 meter at some nominal velocity that is
   appropriate for the implementation.

   .. note:: A mover implementation may choose to ignore this command.

.. _WSF_SUBSURFACE_MOVER.Route_Mover_Commands:

Route Mover Commands
====================

.. include:: route_mover_commands.txt