Pyramidal#

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

Manages a pyramidal horn antenna.

This class is accessible through the app hfss object [1].

Parameters:
frequencyfloat, optional

Center frequency. The default is 10.0.

frequency_unitstr, optional

Frequency units. The default is "GHz".

materialstr, optional

Horn material. If a 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.Pyramidal

Pyramidal horn object.

Notes

[1]

C. Balanis, “Aperture Antennas: Analysis, Design, and Applications,” Modern Antenna Handbook, New York, 2008.

Examples

>>> from ansys.aedt.toolkits.antenna.backend.antenna_models.horn import Pyramidal
>>> import ansys.aedt.core
>>> app = ansys.aedt.core.Hfss()
>>> oantenna1 = Pyramidal(app)
>>> oantenna1.frequency = 12.0
>>> oantenna1.model_hfss()
>>> oantenna1.setup_hfss()
>>> oantenna2 = Pyramidal(app, origin=[0.2, 0.5, 0])
>>> oantenna2.model_hfss()
>>> oantenna2.setup_hfss()
>>> app.release_desktop(False, False)

Methods

Pyramidal.create_3dcomponent([...])

Create a 3D component of the antenna.

Pyramidal.create_lattice_pair([...])

Create a lattice pair box.

Pyramidal.duplicate_along_line(vector[, ...])

Duplicate the object along a line.

Pyramidal.init_model()

Create a radiation boundary.

Pyramidal.model_disco()

Model in PyDiscovery.

Pyramidal.model_hfss()

Draw pyramidal horn antenna.

Pyramidal.set_variables_in_hfss([not_used])

Create HFSS design variables.

Pyramidal.setup_disco()

Set up model in PyDiscovery.

Pyramidal.setup_hfss()

Set up an antenna in HFSS.

Pyramidal.synthesis()

Antenna synthesis.

Pyramidal.update_synthesis_parameters(new_params)

Update the synthesis parameter from the antenna list.

Attributes

Pyramidal.antenna_type

Pyramidal.coordinate_system

Reference coordinate system.

Pyramidal.frequency

Center frequency.

Pyramidal.frequency_unit

Frequency units.

Pyramidal.length_unit

Length unit.

Pyramidal.material

Horn material.

Pyramidal.material_properties

Substrate material properties.

Pyramidal.name

Antenna name.

Pyramidal.origin

Antenna origin.

Pyramidal.outer_boundary

Outer boundary.