Usage

The usage of the VMoveXSubmit script is provided below.

VMoveXSubmit [options] [arguments_file]   (On Windows)
vmovex -submit [options] [arguments_file]   (On Linux)

Arguments File

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

VMoveXSubmit.bat test-data\argfiles\Converge\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\post000160_+1.50000e+02.h5, TYPE=CONVERGE_H5
- out\post000160.cax, TYPE=VCOLLAB_CAX
* PARTS
- *, STREAM=0, IDREG=0
- PARCEL
* 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 "post000160_+1.50000e+02" located in the "in" folder.

  • It then creates the "post000160.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.

  • To load multiple .h5 files, the input file can be specified as post00016*.h5 in the FILES section. This will read all the .h5 files with name starting with post00016 and export to CAX file. The user can specify the dat.h5 file as inpost00016*.dat.h5 in the argument file or list of all .h5 files in the arguement file as shown below.

    * FILES
- in\post00016*.h5, TYPE=CONVERGE_H5
- out\post00016.cax, TYPE=VCOLLAB_CAX

or

* FILES
- in\post000160_+1.50000e+02.h5, TYPE=CONVERGE_H5
- in\post000160_+1.60000e+02.h5, TYPE=CONVERGE_H5
- out\post00016.cax, TYPE=VCOLLAB_CAX

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 --in-file test-data\in\post000160*.h5 --out-file test-data\out\post000160.cax
VMoveXSubmit -i test-data\in\post000160_+1.50000e+02.h5 -o test-data\out\post000160_+1.50000e+02.cax
VMoveXSubmit -i test-data\in\post00016*.h5

(On Linux)
vmovex -submit --in-file test-data\in\post000160*.h5 --out-file test-data\out\post000160.cax
vmovex -submit -i test-data\in\post000160_+1.50000e+02.h5 -o test-data\out\post000160_+1.50000e+02.cax
vmovex -submit -i test-data\in\post00016*.h5

All the above commands provide the same functionality. They read the post000160*.h5 from test-data\in folder and export the mesh and all the results to post000160.cax file into the test-data\out folder. In the second command, the input and output file names are explicitly specified. Hence, Only one file with name post000160_+1.50000e+02.h5 will be read and exported to CAX file with name post000160_+1.50000e+02.cax. In the last command, the input file is specified as post00016*.h5. Here, * acts as a wild card and allows to specify multiple files with similar names. All .h5 files with name starting with post00016 will be read and exported to CAX file.

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

--in-file, -i input_file

Input Converge h5 file path

--out-file, -o out_file

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