create_scattering

Hfss.create_scattering(plot: str | None = 'S Parameter Plot Nominal', sweep: str | None = None, ports: list | None = None, ports_excited: list | None = None, variations: str | None = None) → bool

Create an S-parameter report.

Parameters:

plotstr, optional

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

sweepstr, optional

Name of the sweep. The default is None.

portslist, optional

List of port names. The first index, i, in S[i,j]. The default is None.

ports_excitedlist or str, optional

List of port names. The seconds index, j in S[i,j]. The default is None.

variationsstr, optional

The default is None.

Returns:

bool

True when successful, False when failed.

References

>>> oModule.CreateReport

Examples

Create an S-parameter plot named "S Parameter Plot Nominal" for a 3-port network. plotting S11, S21, S31. The port names are P1, P2, and P3.

>>> hfss.create_scattering(ports=["P1", "P2", "P3"], ports_excited=["P1", "P1", "P1"])
True