This analyzer writes the gradient of a history into a new history.
-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 gradient operation on.
-O <newhistname>, --newHistoryName=<newhistname>(string, optional)
<newhistname> is the history name to write the results to.
-w, --overwrite(flag)
Whether a dataset or group should be overwritten if it already exists.
An additional history is output of the gradient of the chosen history dataset.
Consider a plasma discharge example where some ionization process is the only source of a particular species. If we measure the number of physical particles in that species, then the gradient gives the rate of creation. That rate might be useful in a different simulation, or a 0D model, or to replace the reaction by a direct loader for the particles, for performance reasons.
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.