computeCumulativeSumHistory.py

This analyzer computes the cumulative sum of a history and writes it to a new history. It can be used, for example, to get a total charge from a current measurement.

-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 history name to perform the cumulative sum on.

-o <newhistname>, --newHistoryName=<newhistname>

(string, required)

<newhistname> is the history name to write the resulting cumulative sum/integral to.

-m <M>, --multiplier=<M>

(float, required, default = 1.0)

<M> is the factor, variable of integration, eg dt, that you can multiply your history by, if you choose.

-w, --overwrite

(flag)

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

Output

An additional history is output to a new vizschema history file containing the cumulative sum/integral for the chosen history dataset. The text output displays the average and standard deviation for both input and output datasets, so this analyzer also produces a convenient way of computing the average.

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.

Example of Usage

Consider our 2D magnetron example, which measures the current to the anode, in Amps. Running this analyzer on that history will return the total charge deposited on that surface.