.. highlight:: us

.. index:: Import of CONVERGE output files
.. index:: CONVERGE
.. index:: CONVERGE CFD software
.. index:: *.out files

.. _import-of-converge-files:

Import of CONVERGE files
========================

Introduction
------------

The addin rs_converge is an import filter that enable UniPlots to import
CONVERGE CFD software (https://convergecfd.com/) simulation results (:file:`*.out`).
Optionally, it also allows the users to import input (:file:`*.in`) and echo
(:file:`*.echo`) files.

There are five types of output files: echo (:file:`*.echo`), restart (:file:`*.rst`),
map (:file:`map_*.h5`), cellaveraged output (:file:`*.out`), and cell-by-cell
post (:file:`post_*.h5`).

CONVERGE creates output directories for these files within the Case Directory,
as shown below.

.. image:: S:/uniplot-obj/images/converge-folder-structure.*
	:width: 100%

For additional information and resources, CONVERGE users can visit the 
`CONVERGE download hub <https://hub.convergecfd.com/downloads/category/311-uniplot_for_converge>`_

Compatibility
-------------

The add-in is known to be compatible with the following CONVERGE versions:

	* CONVERGE 3
	* CONVERGE 4
	* CONVERGE 5

If you encounter any issues while importing a specific file, please contact us.

Installation
------------

* Choose :ref:`tools-add-in-manager`.

* Check the :guilabel:`CONVERGE` addin.

The installed files are located in the
:file:`[UniPlot User Directory]\\UniPlot\\AddIn\\rs_converge` directory.

.. list-table::
   :header-rows: 0
   
   * - rs_converge.ic
     - AddIN UniScript File
   * - OUT_import_filter.ic
     - Import filter UniScript File
   * - IN_import_filter.ic
     - Import filter UniScript File
   * - ECHO_import_filter.ic
     - Import filter UniScript File
   * - rs_converge.icl
     - AddIN in object code

Usage
-----

* Start UniPlot.

* Choose :ref:`file-import-data`.

* Choose the type :guilabel:`CONVERGE (\*.out;\*.in;\*.echo)`.

* Navigate to your simulation "stream" folder. (All the files present in parent
  folders will be eligible for import. So you may want to select out files from
  the "stream" folder.)

* Select any \*.out file and click OK.

* The UniPlot-CONVERGE import window will pop-up.

  .. image:: S:/uniplot-obj/images/converge-folder-selection-window.*
     :width: 100%

  * The window has four main elements, described in the table below.

  .. list-table::
     :header-rows: 1

    * - Section
      - Description  
    * - File Selection type
      - Choose whether, in addition to the \*.out files, you wish to import the
        \*.in and \*.echo files (we recommend working only with \*.out files).
    * - Folder selection
      - Choose the folder from which to import data. UniPlot will search for
        files of the selected type in the chosen folders (non-recursive search).
    * - Project Name
      - Based on the selected folders, but can be overwritten.
    * - File list
      - Displays the list of files and their types in the selected folder.

	
* Fill in the required information and click OK. The import will begin.

Created NC-File
---------------

* Once imported the file is available as usual in the DataBrowser. Channels are 
  organized in the tree structure using the NC2 files group function. The
  structure is as follows :
  
   * Group name: file_type/orginal_file_name
   * Channel name : file_type/original_file_name/channel_name/[extra information] (extra information is taken from the file, such as bound ID etc...)

History
-------

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2025.3
     - First release

:sub:`id-126914`