computeThrust.py

This analyzer computes the thrust of a kinetic species hitting a surface.. To use this analyzer, the user must set up a Log History called Absorbed Particle Log. Before setting up the history, the user must also set up a Boundary Absorb and Save for at least one species. Once the history is included, right click on your mouse with the mouse hovering over the history name. Then you will have the ability to add the particle data you want to save. To use this analyzer, you must save the particles mass, location, velocity, time, weight, and number of particles in a macroparticle. The collection should be “log per particle”. Note that in 2D, you need to save 2 positions and you need to save all three velocity components.

-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 <HISTORYNAME>, --historyName=<HISTORYNAME>

(string, required)

<HISTORYNAME> is the name of the history that you provide when you create the history. Some default value is created when you make the history. You can also change the name by double clicking on the history name in Composer.

-B <BETA>, --beta=<BETA>

(float, required)

<BETA> is a real number greater than or equal to 0 and less than 1 (not including 1). BETA is used to compute a rolling average of the binned raw data. The finest binning is computed using a bin size equal to the time step of the simulation. A small value of BETA weights the most recent data more and a large value of BETA weights old data more, which provides more smoothing at the expense of losing instantaneous information.

-O <OUTPUTFILENAME>, --outputFileName=<OUTPUTFILENAME>

(string, required)

<OUTPUTFILENAME> is the name of the data set and file that contains the rolling averaged data.

-Z, --compMajorC

(flag)

The indexing order for written datasets. If checked, use “compMajorC”. If unchecked, use the default “compMinorC”

-w, --overwrite

(flag)

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

Output

This analyzer outputs thrust from a species which impacts the specified boundary.

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.