.. _wt_rhino_plugin_man:

Rhino Tdyn Wind Tunnel plugin
=============================

The purpose of this plugin is to make it easier for users who typically use Rhinoceros 
as a design application to export geometry created using this CAD application to the Tdyn Wind Tunnel application.

How to get and install this plugin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The `Rhino Tdyn Wind Tunnel` plugin is currently available on `food4Rhino <https://www.food4rhino.com/en/app/rhino-tdyn-wind-tunnel?lang=en>`_.

A registered user in food4Rhino can download the `Rhino Tdyn Wind Tunnel` plugin from the website.

.. figure:: img/food4rhino_download.png
  :align: center
  :scale: 85%

  The button directs to the `Downloads` section of the website, where the latest version of the plugin can be downloaded.

.. figure:: img/f4r_wt_download.png
  :align: center
  :scale: 85%

  The `Install` button is only available for registered users. 
  When it is pressed, Rhinoceros application is started if it had been installed previously and `Package Manager` window is opened showing the `Rhino Tdyn Wind Tunnel`plugin.

It is also possible to open the `Package Manager` window with :guilabel:`Tools > Package Manager` menu option of Rhinoceros and search the plugin.

.. figure:: img/Rhino_PackageManager.png
  :align: center
  :scale: 85%

  Pressing `Install` button in the `Package Manager` window, the plugin will be installed and ready to be used.

How to get contextual help
^^^^^^^^^^^^^^^^^^^^^^^^^^

When the following menu option in Rhinoceros is executed, then a contextual help panel is opened
and help about this plugin and Tdyn Wind Tunnel application is shown:

Menu option: :guilabel:`Panels > Help`

.. figure:: img/wt_rhino_contextual_help.png
  :scale: 80%
  :align: center

  Contextual help about Rhino Tdyn Wind Tunnel plugin available executing the :guilabel:`Panels > Help` Rhinoceros menu 

How to run this plugin
^^^^^^^^^^^^^^^^^^^^^^

The plugin includes a command called `TdynWindTunnel` which can be executed from 
the button contained in the plugin's built-in toolbar or by entering the command in the command line.

.. figure:: img/wt_rhino_run_plugin.png
  :scale: 80%
  :align: center

The first time the command is run, if Tdyn Wind Tunnel is not installed, 
then a dialog box allows to download Tdyn Wind Tunnel from 
`Compass website <https://www.compassis.com/wt_download>`_.

.. figure:: img/wt_rhino_tdyn_not_installed.png
  :scale: 60%
  :align: center

The second time the command is run, it is necessary to enter passwords for GID and FULL_WINDTUNNEL modules 
according to the :ref:`Getting Started manual <wt_getting_started>` of Tdyn Wind Tunnel.

Afterwards, each time the `TdynWindTunnel` command is executed, the geometry will be exported to IGES format, 
the Tdyn Wind Tunnel installation will be started, and the geometry will be imported.

.. figure:: img/wt_rhino_units.png
  :scale: 60%
  :align: center

`Tdyn Wind Tunnel` requires the geometry to be expressed in metres. 
Otherwise, a message box will warn that the geometry will be converted to metres if the user presses the OK button. 
However, the user can cancel the execution of the command.

According to the :ref:`Tdyn Wind Tunnel manual<wt_geo_req>`, the geometry must meet other criteria, 
besides the units, in order to be able to run a wind tunnel simulation. 
These criteria are not checked when executing the `TdynWindTunnel` command but are checked by the `Tdyn Wind Tunnel` application.

In case different versions of Tdyn Wind Tunnel are installed, the most recent version shall be run.

After verifying the units and exporting the geometry in IGES format, `Tdyn Wind Tunnel` opens with the imported geometry.

.. figure:: img/wt_rhino_tdyn.png
  :align: center

For more information on how to perform a wind tunnel simulation, please visit the :ref:`Tdyn Wind Tunnel manual<wt_setup_req>`.