plane_wave#

Hfss.plane_wave(vector_format='Spherical', origin=None, polarization=None, propagation_vector=None, wave_type='Propagating', wave_type_properties=None, name=None)[source]#

Create a plane wave excitation.

Parameters:

vector_formatstr, optional: Vector input format. Options are "Spherical" or "Cartesian". The default is "Spherical".
originlist, optional: Excitation location and zero phase position. The default is ["0mm", "0mm", "0mm"].
polarizationstr or list, optional: Electric field polarization vector. If "Vertical" or "Horizontal" is passed, the method computes the electric polarization vector. If a list is passed, the user can customize the input vector. If vector_format is "Cartesian", the vector has three coordinates which corresponds to ["Ex", "Ey", "Ez"]. If vector_format is "Spherical", the vector has two coordinates which corresponds to ["Ephi", "Etheta"]. The default is "Vertical".
propagation_vectorlist, optional: Propagation vector. If vector_format is "Cartesian" the type must be a list with three elements. If vector_format is "Spherical" the type must be a list with two elements. The first element corresponds to the phi sweep, which must be a list of three elements: start, stop, and number of points. The second element has the same format, it corresponds to the theta sweep. The default is [0.0, 0.0, 1.0] for "Cartesian" and [["0.0deg", "0.0deg", 1], ["0.0deg", "0.0deg", 1]] for "Spherical".
wave_typestr, optional: Type of plane wave. Options are "Propagating", "Evanescent", or "Elliptical". The default is "Propagating".
wave_type_propertieslist, optional: Properties of the plane wave type. If "Propagating" is used, no additional properties are needed. The default is None. If "Evanescent" is selected, the propagation constant is expressed as both real and imaginary components. The default is [0.0, 1.0]. If "Elliptical" is used, the polarization angle and ratio are defined. The default is ["0deg", 1.0].
namestr, optional: Name of the excitation. The default is None, in which case a name is automatically assigned.

Returns:

pyaedt.modules.Boundary.BoundaryObject: Port object.

References

>>> oModule.AssignPlaneWave

Examples

Create a plane wave excitation.

>>> port1 = hfss.plane_wave(vector_format="Spherical",
 ...                        polarization="Vertical",
 ...                        propagation_vector=[["0deg","90deg", 25], ["0deg","0deg", 1]])
>>> port2 = hfss.plane_wave(vector_format="Cartesian",
 ...                        polarization=[1, 1, 0], propagation_vector=[0, 0, 1])