hertzian_dipole_wave

Hfss.hertzian_dipole_wave(assignment=None, origin=None, polarization=None, is_electric=True, radius='10mm', name=None) → BoundaryObject

Create a hertzian dipole wave excitation.

The excitation is assigned in the assigned sphere. Inside this sphere, the field magnitude is equal to the field magnitude calculated on the surface of the sphere.

Parameters:

assignmentstr or list, optional

One or more objects or faces to assign finite conductivity to. The default is None, in which case the excitation is assigned to anything.

originlist, optional

Excitation location. The default is ["0mm", "0mm", "0mm"].

polarizationlist, optional

Electric field polarization vector. The default is [0, 0, 1].

is_electricbool, optional

Type of dipole. Electric dipole if True, magnetic dipole if False. The default is True.

radiusstr or float, optional

Radius of surrounding sphere. The default is “10mm”.

namestr, optional

Name of the boundary.

Returns:

pyaedt.modules.Boundary.BoundaryObject

Port object.

References

>>> oModule.AssignHertzianDipoleWave

Examples

Create a hertzian dipole wave excitation. >>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> sphere = hfss.modeler.primitives.create_sphere([0, 0, 0], 10) >>> port1 = hfss.hertzian_dipole_wave(assignment=sphere, radius=10)