computeWaveguideModes.py

This analyzer computes the profiles & effective indices of guided modes based on the dielectric & PEC cross-section by directly solving an eigenvalue equation. Use on dielectric & PEC waveguides with a constant cross-section. Find any desired mode & then use the output mode profile to launch the mode in the full simulation. The cross-section must be normal to x.

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

-Tx <sliceX>, --transverseSliceX=<sliceX>

(string, required, default = 0.0)

<sliceX> is the X coordinate of where to take the slice of invEps field to analyze. Example of use: -Tx 0.0

-Tly <sliceLY>, --transverseSliceLY=<sliceLY>

(string, required, default = -250.0e-9)

<sliceLY> is the lower Y coordinate of where the slice of the invEps field is taken to analyze. Example of use: -Tly -250.0e-9

-Tuy <sliceUY>, --transverseSliceUY=<sliceUY>

(string, required, default = 250.0e-9)

<sliceUY> is the upper Y coordinate of where the slice of the invEps field is taken to analyze. Example of use: -Tuy 250.0e-9

-Tlz <sliceLZ>, --transverseSliceLZ=<sliceLZ>

(string, required, default = -100.0e-9)

<sliceLZ> is the lower Z coordinate of where the slice of the invEps field is taken to analyze. Example of use: -Tlz -100.0e-9

-Tuz <sliceUZ>, --transverseSliceUZ=<sliceUZ>

(string, required, default = 100.0e-9)

<sliceUZ> is the upper Z coordinate of where the slice of the invEps field is taken to analyze. Example of use: -Tuz 100.0e-9

-L <vacwave>, --vacWavelength=<vacwave>

(float, required, default = 1.55)

<vacwave> is the vacuum wavelength of source. Example of use: -L 1.55

-m <maxnodes>, --nModes=<maxnodes>

(int, optional, default = 10)

<maxnodes> is the maximum number of modes to find. Includes degenerate modes.

-N <fileName>, --modeFileName=<fileName>

(string, optional, default is port1)

<fileName> is the secondary filename to write mode files to. This name should be reused when launching a mode in the same simulation as it is calculate in to prevent the mode file being deleted at runtime. Example of use: -N port

-F <field>, --writeFieldProfile=<field>

(string, optional, default is H)

<field> is which field(s) (H,E, and/or D) to write for the modes. Example of use: -F H,E,D

-w, --overwrite

(flag)

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

Output

This analyzer outputs a table with a list of the modes and effective indices. Export your choice of the H, E, and/or D field profiles. The profile of each mode is output to a separate H5 file. This file includes the real and imaginary parts. These modes can be imported and launched in a simulation.

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.