create_sbr_antenna#

Hfss.create_sbr_antenna(antenna_type='Conical Horn', target_cs=None, units=None, parameters=None, use_current_source_representation=False, is_array=False, name=None)[source]#

Create a parametric beam antennas in SBR+.

Parameters:

antenna_typestr, SbrAntennas.ConicalHorn: Name of the antennas type. The enumerator SbrAntennas can also be used. The default is "SbrAntennas.Conical Horn".
target_csstr, optional: Target coordinate system. The default is None, in which case the active coodiante system is used.
unitsstr, optional: Model units to apply to the object. The default is None, in which case the active modeler units are applied.
parametersdict, optional: Dictionary of parameters. The default is None.
use_current_source_representationbool, optional: Whether to use the current source representation. The default is False.
is_arraybool, optional: Whether to define an array. The default is False.
namestr, optional: Name of the 3D component. The default is None, in which case the name is auto-generated based on the antenna type.

Returns:

pyaedt.modules.Boundary.NativeComponentObject: NativeComponentObject object.

References

>>> oEditor.InsertNativeComponent

Examples

>>> from pyaedt import Hfss
>>> hfss = Hfss(solution_type="SBR+")  
PyAEDT INFO: Added design 'HFSS_IPO' of type HFSS.
>>> parm = {"polarization": "Vertical"}  
>>> par_beam = hfss.create_sbr_antenna(hfss.SbrAntennas.ShortDipole,parameters=parm,name="TX1")