Usage

The usage of the VMoveXSubmit script is provided below.

VMoveXSubmit [options] [arguments_file]   (On Windows)
VMoveXSubmit [options] [arguments_file]   (On Linux)

Arguments File

The arguments_file is a text file containing the inputs and controls to the FluentH5toCax translation. Let us consider the following example.

VMoveXSubmit test-data\arg_file.txt

FluentH5toCax distribution consists of a test-data folder containing sample argument and input files. The above command tells the FluentH5toCax to

  • read the arg_file.txt located in the test-data folder,

  • read the Fluent and dat .h5 files specified in this arg_file.txt

  • use the controls specified in this arg_file.txt

  • export to the Cax specified in this arg_file.txt

Let us now look at the contents of the above mentioned arguments file to understand its structure and format.

* FILES
- in\FFF.1-5-6.0.cas.h5, TYPE=FLUENT_H5
- out\fluent_cax.cax, TYPE=VCOLLAB_CAX
* PARTS
- *
* RESULTS
- *Temp
* CUTSECTIONS
- "CS1", EQUATION="1Z=0.47"
* FLOWLINES
- "Fl1", COMPONENT=inlet, TYPE=TUBE, TUBE_DIA=0.0025, RESULT=VELOCITY, NO_OF_LINES=3500

It is observed that,

  • It reads mesh from “FFF.1-5-6.0” located in the “in” folder and results are read from dat.h5 file with same name as mesh file.

  • It then creates the “fluent_cax.cax” file and writes it to the “out” folder.

  • The “in” and “out” folders are relative to the “arg_file.txt”, i.e. they are located in the “test-data” folder.

  • The cax consists of all parts.

  • The generated CAX file will contain results: Temp from the fluent file. Other results will be filtered out and will not be exported.

  • The output CAX file will also contain one cut-sections: 1z=0.47 and a flowline feature for Velocity, starting from inlet component.

Options

In the case of the simplest usage scenario, where the user intends to create a CAX file from the given input Fluent file without additional controls, it is possible to skip the creation of argument file and specify the inputs using command-line options as shown below.

VMoveXSubmit --in-file test-data\in\FFF.1-5-6.0.cax.h5 --out-file test-data\out\FFF.1-5-6.0.cax
VMoveXSubmit -i test-data\in\FFF.1-5-6.0.h5 -o test-data\out\FFF.1-5-6.0.cax
VMoveXSubmit -i test-data\in\FFF.1-5-6.0.h5

All the above commands provide the same functionality. They read the FFF.1-5-6.0.h5 from test-data\in folder and export the mesh and all the results to FFF.1-5-6.0.cax file into the test-data\out folder.

The list of supported command-line options are provided below.

--in-file, -i input_file

Input Fluent .cas.h5 file path

--out-file, -o out_file

Output CAX file path. If not specified, the h5 file path with .cax extension is used.