AxialMode#

class ansys.aedt.toolkits.antenna.backend.antenna_models.helix.AxialMode(*args, **kwargs)[source]#

Manages an axial mode helix antenna.

This class is accessible through the Hfss object [1].

Parameters:

frequencyfloat, optional: Center frequency. The default is 10.0.
frequency_unitstr, optional: Frequency units. The default is "GHz".
materialstr, optional: Helix material. If the material is not defined, a new material, parametrized, is defined. The default is "pec".
outer_boundarystr, optional: Boundary type to use. The default is None. Options are "FEBI", "PML", "Radiation", and None.
length_unitstr, optional: Length units. The default is "mm".
parametrizedbool, optional: Whether to create a parametrized antenna. The default is True.

Returns:

aedt.toolkits.antenna.AxialMode: Antenna object.

Notes

[1]

C. Balanis, “Wideband and Travelling-Wave Antennas,” Modern Antenna Handbook, New York, 2008.

Examples

>>> from ansys.aedt.toolkits.antenna.backend.antenna_models.helix import AxialMode
>>> import ansys.aedt.core
>>> app = ansys.aedt.core.Hfss()
>>> oantenna1 = AxialMode(app)
>>> oantenna1.frequency = 12.0
>>> oantenna1.model_hfss()
>>> oantenna1.setup_hfss()
>>> oantenna2 = AxialMode(app, origin=[200, 50, 0])
>>> oantenna2.model_hfss()
>>> oantenna2.setup_hfss()
>>> app.release_desktop(False, False)

Methods

`AxialMode.create_3dcomponent`([...])	Create a 3D component of the antenna.
`AxialMode.create_lattice_pair`([...])	Create a lattice pair box.
`AxialMode.duplicate_along_line`(vector[, ...])	Duplicate the object along a line.
`AxialMode.init_model`()	Create a radiation boundary.
`AxialMode.model_disco`()	Model in PyDiscovery.
`AxialMode.model_hfss`()	Draw an axial mode antenna.
`AxialMode.set_variables_in_hfss`([not_used])	Create HFSS design variables.
`AxialMode.setup_disco`()	Set up model in PyDiscovery.
`AxialMode.setup_hfss`()	Set up an antenna in HFSS.
`AxialMode.synthesis`()	Antenna synthesis.
`AxialMode.update_synthesis_parameters`(new_params)	Update the synthesis parameter from the antenna list.

Attributes

`AxialMode.antenna_type`
`AxialMode.coordinate_system`	Reference coordinate system.
`AxialMode.direction`	Helix direction.
`AxialMode.feeder_length`	Helix feeder length.
`AxialMode.frequency`	Center frequency.
`AxialMode.frequency_unit`	Frequency units.
`AxialMode.gain`	Helix expected gain.
`AxialMode.length_unit`	Length unit.
`AxialMode.material`	Helix material.
`AxialMode.name`	Antenna name.
`AxialMode.origin`	Antenna origin.
`AxialMode.outer_boundary`	Outer boundary.