MeshConv command line parameters

Contents

This page documents the command line parameters of MeshConv (Mesh format converter).

List of all command line parameters

                   -h, --help                          Display one-liner help on all command-line arguments
                 -H, --helpkw                   string Display verbose help on a single keyword
                  -i, --input                   string Specify the input file
                -L, --license                          Show license information
                 -o, --output                   string Specify the output file
             -q, --quiescence                          Enable quiescence detection
                -r, --reorder                   string Reorder mesh nodes
                 -O, --screen                   string Specify the screen output file
                  -S, --state                          Enable verbose chare state screen output
                  -t, --trace                          Disable call and stack trace
                -v, --verbose                          Select verbose screen output
                -V, --version                          Show version information

Detailed description of command line parameters

Keyword -h, --help

Display one-liner help on all command-line arguments

Get a short one-liner help on all command-line arguments from an executable. It also triggers the help from the Charm++ runtime system and in addition to that of the executable, it also lists command-line arguments from Converse Machine, Tracing, Load Balancer, Record/Replay, and Charm++ command-line parameters.

Keyword -H, --helpkw

Display verbose help on a single keyword

This keyword can be used to get a verbose help on a single command-line argument or control-file keyword (i.e., help on keyword) from an executable.

Expected type: string

Keyword -i, --input

Specify the input file

This option is used to define the name of input file.

Expected type: string

Keyword -L, --license

Show license information

This keyword is used to display license information for the executable/tool on the standard output and exit successfully.

Keyword -o, --output

Specify the output file

This option is used to define the output file name. In MeshConv, this is used to specify the output mesh file name. In Inciter this is used to specify the output base filename. The base filename is appended by ".e-s.\<meshid\>.\<numchares\>.\<chareid\>", where 'e-s' probably stands for ExodusII sequence (the output file format), <meshid> counts the number of new meshes (this is incremented whenever the mesh is new compared to the previous iteration, due to, e.g., mesh refinement), <numchares> is the total number of mesh partitions, and <chareid> is the work unit (or mesh partition) id.

Expected type: string

Keyword -q, --quiescence

Enable quiescence detection

This keyword is used to enable the quiescence detection feature of Charm++, used to catch logic errors in the asynchronous control flow, resulting in deadlocks. This is useful for automated testing and debugging and does have some overhead, so it is off by default.

Keyword -r, --reorder

Reorder mesh nodes

This keyword is used as a command line argument to instruct the mesh converter to not only convert but also reorder the mesh nodes using the advancing front technique. Reordering is optional in meshconv and inciter.

Expected type: string

Keyword -O, --screen

Specify the screen output file

This option is used to set the screen output file name. The default is "\<executable\>_screen.log".

Expected type: string

Keyword -S, --state

Enable verbose chare state screen output

This keyword is used to enable verbose Charm++ chare state collection and screen output. The chare state is displayed after a run is finished and the data collected is grouped by chare id (thisIndex), and within groups data is ordered by the time-stamp when a given chare member function is called. See src/Base/ChareState.hpp for details on what is collected. Note that to collect chare state, the given chare must be instrumented. Note that if quescence detection is enabled, chare state collection is also automatically enabled, but the chare state is only output if quiescence is detected (which also triggers an error).

Keyword -t, --trace

Disable call and stack trace

This keyword can be used to disable the on-screen call trace and stack trace after an exception is thrown. Trace output is on by default and in some cases, the call and stack trace can be huge and not very helpful, hence this command line option.

Keyword -v, --verbose

Select verbose screen output

This keyword is used to select verbose screen-output as opposed to the default quiet output. With quiet output only the most important messages are echoed to screen.

Keyword -V, --version

Show version information

This keyword is used to display version information for the executable/tool on the standard output and exit successfully.