annotateFieldOnLine.py

This analyzer enables the raw h5 data recorded in a fieldonLine history to be available as a 2D field containing spatial cell index on the ordinate and time on the abcissa. For fieldOnLine histories containing multiple components, there is an option to choose the index to test.

-s <simname>, --simulationName=<simname>

(string, required)

<simname> is the name of the simulation to be analyzed. The file extension should NOT be included in this text field.

-H <histname>, --historyName=<histname>

(string, required)

<histname> is the name of the history dataset to analyze, eg E1.

-C <comp>, --component=<comp>

(integer, required)

<comp> is the component to analyze, eg 0,1,2. If set, this chooses a specific index of the history.

-x <multiplier>, --positionMultiplier=<multiplier>

(float, optional)

If set, multiplies the cell index by <multiplier> for the fieldOnLine history, eg by DX to determine the position.

-a <offset>, --positionOffset=<offset>

(float, optional)

If set, offsets the position by the value <offset>. Adjusts the minimum value to use for cell index when plotting, eg XSTART. If used without positionMultiplier then this could be used for the minimum cell index so that the plot shows actual cell index, rather than containing cells numbered from zero.

-w, --overwrite

(flag)

Whether a dataset or group should be overwritten if it already exists.

Output

This analysis script outputs a VizSchema file containing 2D data on a uniform Cartesian mesh, spatial cell index (along the line specified in the history) on the ordinate, time on the abscissa.

If you are running this analyzer from the UI, and the output dataset file already exists, then it will be overwritten each time the analyzer is run, unless you uncheck the Overwrite Existing Files box near the bottom of the Analysis Results pane.

If you are running the analyzer from the command line, the dataset will not be overwritten unless the -w, or --overwrite flag is specified on the command line.

The results of your analyzer may not be written into the output file if you have not specified the overwrite option to be True.