far_field_wave#

Hfss.far_field_wave(assignment: str | Hfss, setup: str | None = None, simulate_source: bool = True, preserve_source_solution: bool = True, coordinate_system: str = 'Global', name: str | None = None) → BoundaryObject#

Create a far field wave excitation.

Parameters:

assignmentansys.aedt.core.Hfss or str: Source HFSS object from which to link the far field data, or path to an external far field data file (.ffd file).
setupoptional: Name of the setup. The default is None, in which case a name is automatically assigned. This parameter is only used when assignment is an HFSS object.
simulate_sourcebool, optional: Whether to force the source design to solve. The default is True. This parameter is only used when assignment is an HFSS object.
preserve_source_solutionbool, optional: Whether to preserve the source solution. The default is True. This parameter is only used when assignment is an HFSS object.
coordinate_systemstr, optional: Coordinate system to use for the source. The default is "Global".
namestr, optional: Name of the excitation. The default is None, in which case a name is automatically assigned.

Returns:

ansys.aedt.core.modules.boundary.common.BoundaryObject: Far field boundary object.

References

>>> oModule.AssignFarFieldWave

Examples

Create a far field wave excitation from another design in the same project.

>>> from ansys.aedt.core import Hfss
>>> target = Hfss(project="target_project.aedt")
>>> source = Hfss(project="target_project.aedt", design="Source_Design")
>>> setup = source.create_setup("Setup1", Frequency="10GHz")
>>> far_field_wave_src = target.far_field_wave(assignment=source, setup=setup)

Create a far field wave excitation from an external project.

>>> target = Hfss(project="target_project.aedt")
>>> source = Hfss(project="source_project.aedt", design="Array_Design")
>>> setup = source.create_setup("Setup1", Frequency="10GHz")
>>> far_field_wave_src = target.far_field_wave(assignment=source, setup=setup)

Create a far field wave excitation from an external data file.

>>> target = Hfss(project="target_project.aedt")
>>> far_field_wave_src = target.far_field_wave(assignment="/path/to/farfield.ffd")