create_sbr_file_based_antenna

Hfss.create_sbr_file_based_antenna(ffd_full_path, antenna_size='1mm', antenna_impedance='50ohm', representation_type='Far Field', target_cs=None, model_units=None, antenna_name=None)[source]

Create a linked antenna.

Parameters
ffd_full_pathstr

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 antenna type. Options are "Far Field" or "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.

model_unitsstr, optional

Model units to apply to the object. The default is None, in which case the active modeler units are applied.

antenna_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

References

>>> oEditor.InsertNativeComponent

Examples

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