RectangularPatchProbe#

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

Manages a rectangular patch antenna with a coaxial probe.

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

Substrate material. If the material is not defined, a new material, parametrized, is created. The default is "FR4_epoxy".

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".

substrate_heightfloat, optional

Substrate height. The default is 1.575.

parametrizedbool, optional

Whether to create a parametrized antenna. The default is True.

Returns:
aedt.toolkits.antenna.RectangularPatchProbe

Patch antenna object.

Notes

[1]
  1. Balanis, “Microstrip Antennas,” Antenna Theory, 2nd Ed. New York: Wiley, 1997.

Examples

>>> from ansys.aedt.toolkits.antenna.backend.antenna_models.patch import RectangularPatchProbe
>>> import ansys.aedt.core
>>> app = ansys.aedt.core.Hfss()
>>> oantenna1 = RectangularPatchProbe(app)
>>> oantenna1.frequency = 12.0
>>> oantenna1.model_hfss()
>>> oantenna1.setup_hfss()
>>> app.release_desktop(False, False)

Methods

RectangularPatchProbe.create_3dcomponent([...])

Create a 3D component of the antenna.

RectangularPatchProbe.create_lattice_pair([...])

Create a lattice pair box.

RectangularPatchProbe.duplicate_along_line(vector)

Duplicate the object along a line.

RectangularPatchProbe.init_model()

Create a radiation boundary.

RectangularPatchProbe.model_disco()

Model in PyDiscovery.

RectangularPatchProbe.model_hfss()

Draw rectangular patch antenna with coaxial probe.

RectangularPatchProbe.set_variables_in_hfss([...])

Create HFSS design variables.

RectangularPatchProbe.setup_disco()

Set up the model in PyDiscovery.

RectangularPatchProbe.setup_hfss()

Set up an antenna in HFSS.

RectangularPatchProbe.synthesis()

Antenna synthesis.

RectangularPatchProbe.update_synthesis_parameters(...)

Update the synthesis parameter from the antenna list.

Attributes

RectangularPatchProbe.antenna_type

RectangularPatchProbe.coordinate_system

Reference coordinate system.

RectangularPatchProbe.frequency

Center frequency.

RectangularPatchProbe.frequency_unit

Frequency units.

RectangularPatchProbe.length_unit

Length unit.

RectangularPatchProbe.material

Substrate material.

RectangularPatchProbe.material_properties

Substrate material properties.

RectangularPatchProbe.name

Antenna name.

RectangularPatchProbe.origin

Antenna origin.

RectangularPatchProbe.outer_boundary

Outer boundary.

RectangularPatchProbe.substrate_height

Substrate height.