Usage

The usage of the VMoveXSubmit script is provided below.

VMoveXSubmit.bat [options] [arguments_file]   (On Windows)
VMoveXSubmit.sh [options] [arguments_file]   (On Linux)

Arguments File

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

VMoveXSubmit.bat test-data\argfiles\CGNS\arg_file.txt

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

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

  • read the Converge .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\sample.cgns, TYPE=CGNS
- out\sample.cax, TYPE=VCOLLAB_CAX
* PARTS
- *
* RESULTS
- *Temp
* CUTSECTIONS
- "CS1", EQUATION="1Z=0.47"
* FLOWLINES
- "Fl1", SOURCE_COMP=BC-IN, TYPE=TUBE, TUBE_DIA=0.0025, RESULT=VELOCITY, NO_OF_LINES=3500

It is observed that,

  • It reads mesh and results from sample located in the in folder.

  • It then creates the sample.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 parts that belongs to stream 0 and region 0.

  • Since the parts section consists of PARCEL, parcel data is exported to CAX.

  • The generated CAX file will contain results Temp from the Converge 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 BC-IN component.

Options

In the case of the simplest usage scenario, where the user intends to create a CAX file from the given input Converge 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.

(On Windows)
VMoveXSubmit.bat --in-file test-data\in\sample.cgns --out-file test-data\out\sample.cax
VMoveXSubmit.bat -i test-data\in\sample.h5 -o test-data\out\sample.cax
VMoveXSubmit.bat -i test-data\in\sample.h5

(On Linux)
VMoveXSubmit.bat --in-file test-data\in\sample.h5 --out-file test-data\out\sample.cax
VMoveXSubmit.bat -i test-data\in\sample.h5 -o test-data\out\sample.cax
VMoveXSubmit.bat -i test-data\in\sample.h5

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

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

--in-file, -i input_file

Input CGNS .cgns file path

--out-file, -o out_file

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