putFieldOnSurfaceMesh.py

This analyzer reads a range of XSim output field dump files and an associated geometry file, and creates field data on an unstructured mesh representing the values of the field components on the surface of the geometry.

Appropriate boundary conditions are inferred depending on the type of field (electric or magnetic). Only those elements of the field projected on the conducting surface will be displayed. A common use of this tool is to view the surface currents on an object.

-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.

-g <geometry>, --geometryName=<geometry>

(string, required)

<geometry> is the name of the conducting geometry.

-f <fldname>, --fieldName=<fldname>

(string, required)

<fldname> is the name of the field to be painted on the grid boundary.

-b <bd>, --beginDump=<bd>

(int, required, default = 0)

<bd> is the first memory dump to process.

-e <ed>, --endDump=<ed>

(int, required, default = 0)

<ed> is the last memory dump to process.

-O <outname>, --outputFieldName=<outname>

(string, optional)

<outname> is the file name of the files into which the surface field data should be written. If specified, then output files will have the form simulationName_outputFieldName_dumpNumber.vsh5. If not specified, then files are created as simulationName_geometryNamefieldName_dumpNumber.vsh5, where geometryNamefieldName is the concatenation of the string values passed for the -g and -f command line options.

Output

VizSchema compatible output dump files are created that contain (possibly multi-dimensional) fields and the surface mesh on which they are defined. Naming conventions are such that the new output files are named simulationName_geometryNamefieldName_dumpNumber.vsh5. Optionally, users can specify the output file names independently if so desired.

The fields can be found in the Visualize tab of XSimComposer and can be visualized in Scalar Data. If the Visualize tab has already been opened the Reload Data button must be clicked in order to load the new files. If the prefile generates a magnitude field, this will be available for the “painted” field.

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.