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 antennas.
- Parameters:
- ffd_full_path
str
Full path to the FFD file.
- antenna_size
str
,optional
Antenna size with units. The default is
"1mm"
.- antenna_impedance
str
,optional
Antenna impedance with units. The default is
"50ohm"
.- representation_type
str
,optional
Type of the antennas. Options are
"Far Field"
and"Near Field"
. The default is"Far Field"
.- target_cs
str
,optional
Target coordinate system. The default is
None
, in which case the active coordinate system is used.- model_units
str
,optional
Model units to apply to the object. The default is
None
, in which case the active modeler units are applied.- antenna_name
str
,optional
Name of the 3D component. The default is
None
, in which case the name is auto-generated based on the antennas type.
- ffd_full_path
- Returns:
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)