create_scattering

Hfss.create_scattering(plot_name='S Parameter Plot Nominal', sweep_name=None, port_names=None, port_excited=None, variations=None)[source]

Create a scattering report.

Parameters
PlotNamestr, optional

Name of the plot. The default is "S Parameter Plot Nominal".

sweep_namestr, optional

Name of the sweep. The default is None.

port_nameslist, optional

List of port names. The default is None.

port_excitedlist or str, optional

The default is None.

variationsstr, optional

The default is None.

Returns
bool

True when successful, False when failed.

References

>>> oModule.CreateReport

Examples

Create a scattering named "S Parameter Plot Nominal" using the default parameters.

>>> hfss.create_scattering()
True