create_sbr_file_based_antenna#

Hfss.create_sbr_file_based_antenna(far_field_data, antenna_size='1mm', antenna_impedance='50ohm', representation_type='Far Field', target_cs=None, units=None, is_array=False, custom_array=None, name=None)#

Create a linked antenna.

Parameters:

far_field_datastr: Full path to the FFD file.
antenna_sizestr, optional: Antenna size with units. The default is "1mm".
antenna_impedancestr, optional: Antenna impedance with units. The default is "50ohm".
representation_typestr, optional: Type of the antennas. Options are "Far Field" and "Near Field". The default is "Far Field".
target_csstr, optional: Target coordinate system. The default is None, in which case the active coordinate 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.
is_arraybool, optional: Whether to define a parametric array. The default is False.
custom_arraystr, optional: Custom array file. The extensions supported are ".sarr". The default is None, in which case parametric array is created.
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:

ansys.aedt.core.modules.boundary.layout_boundary.NativeComponentObject

References

>>> oEditor.InsertNativeComponent

Examples

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss(solution_type="SBR+")  
>>> ffd_file = "full_path/to/ffdfile.ffd"
>>> par_beam = hfss.create_sbr_file_based_antenna(ffd_file)  