# -*- coding: utf-8 -*-
#
# Copyright (C) 2023 - 2025 ANSYS, Inc. and/or its affiliates.
# SPDX-License-Identifier: MIT
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from collections import OrderedDict
import math
import ansys.aedt.core.generic.constants as constants
from ansys.aedt.core.generic.general_methods import pyaedt_function_handler
from ansys.aedt.toolkits.common.backend.logger_handler import logger
from ansys.aedt.toolkits.antenna.backend.antenna_models.common import CommonAntenna
class CommonHelix(CommonAntenna):
"""Provides base methods common to horn antenna."""
def __init__(self, _default_input_parameters, *args, **kwargs):
CommonAntenna.antenna_type = "Helix"
CommonAntenna.__init__(self, _default_input_parameters, *args, **kwargs)
@property
def material(self):
"""Helix material.
Returns
-------
str
"""
return self._input_parameters.material
@material.setter
def material(self, value):
if self._app:
if (
value
and value not in self._app.materials.mat_names_aedt
and value not in self._app.materials.mat_names_aedt_lower
):
logger.debug("Material not defined")
else:
if value != self.material and self.object_list:
for antenna_obj in self.object_list:
if (
self.object_list[antenna_obj].material_name == self.material.lower()
and "coax" not in antenna_obj
):
self.object_list[antenna_obj].material_name = value
self._input_parameters.material = value
parameters = self.synthesis()
self.update_synthesis_parameters(parameters)
self.set_variables_in_hfss()
@property
def gain(self):
"""Helix expected gain.
Returns
-------
float
"""
return self._input_parameters.gain
@gain.setter
def gain(self, value):
self._input_parameters.gain = value
if value != self.gain and self.object_list:
parameters = self.synthesis()
self.update_synthesis_parameters(parameters)
self.set_variables_in_hfss()
@property
def direction(self):
"""Helix direction. ``0`` for left, and ``1`` for right.
Returns
-------
int
"""
return self._input_parameters.direction
@direction.setter
def direction(self, value):
self._input_parameters.direction = value
if value != self.direction and self.object_list:
parameters = self.synthesis()
self.update_synthesis_parameters(parameters)
self.set_variables_in_hfss()
@property
def feeder_length(self):
"""Helix feeder length.
Returns
-------
float
"""
return self._input_parameters.feeder_length
@feeder_length.setter
def feeder_length(self, value):
self._input_parameters.feeder_length = value
if value != self.feeder_length and self.object_list:
parameters = self.synthesis()
self.update_synthesis_parameters(parameters)
self.set_variables_in_hfss()
@pyaedt_function_handler()
def synthesis(self):
pass
[docs]
class AxialMode(CommonHelix):
"""Manages an axial mode helix antenna.
This class is accessible through the ``Hfss`` object [1]_.
Parameters
----------
frequency : float, optional
Center frequency. The default is ``10.0``.
frequency_unit : str, optional
Frequency units. The default is ``"GHz"``.
material : str, optional
Helix material. If the material is not defined, a new material,
``parametrized``, is defined. The default is ``"pec"``.
outer_boundary : str, optional
Boundary type to use. The default is ``None``. Options are ``"FEBI"``, ``"PML"``,
``"Radiation"``, and ``None``.
length_unit : str, optional
Length units. The default is ``"mm"``.
parametrized : bool, optional
Whether to create a parametrized antenna. The default is ``True``.
Returns
-------
:class:`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)
"""
_default_input_parameters = {
"name": "",
"origin": [0, 0, 0],
"length_unit": "mm",
"coordinate_system": "Global",
"frequency": 10.0,
"frequency_unit": "GHz",
"gain": 10,
"direction": 0,
"feeder_length": 10,
"outer_boundary": "",
"material": "pec",
}
def __init__(self, *args, **kwargs):
CommonHelix.__init__(self, self._default_input_parameters, *args, **kwargs)
self._parameters = self.synthesis()
self.update_synthesis_parameters(self._parameters)
self.antenna_type = "AxialMode"
[docs]
@pyaedt_function_handler()
def synthesis(self):
"""Antenna synthesis.
Returns
-------
dict
Analytical parameters.
"""
parameters = {}
light_speed = constants.SpeedOfLight # m/s
freq_hz = constants.unit_converter(self.frequency, "Freq", self.frequency_unit, "Hz")
freq_ghz = constants.unit_converter(self.frequency, "Freq", self.frequency_unit, "GHz")
wl_meters = light_speed / freq_hz
gain_value_dB = self.gain
gain_value_mag = math.pow(10.0, gain_value_dB / 10.0)
groundx = constants.unit_converter(4.0 * (3.33 / freq_ghz), "Length", "in", "mm")
groundy = constants.unit_converter(4.0 * (3.33 / freq_ghz), "Length", "in", "mm")
helix_diameter = constants.unit_converter(1.128 * (3.33 / freq_ghz), "Length", "in", "mm")
helix_spacing = constants.unit_converter(0.786 * (3.33 / freq_ghz), "Length", "in", "mm")
helix_wiredia = constants.unit_converter(0.2 * (3.33 / freq_ghz), "Length", "in", "mm")
helix_coax_inner_radius = constants.unit_converter(0.082 * (3.33 / freq_ghz) / 2, "Length", "in", "mm")
helix_coax_outer_radius = constants.unit_converter(0.275 * (3.33 / freq_ghz) / 2, "Length", "in", "mm")
helix_feed_pinL = constants.unit_converter(0.05 * (3.33 / freq_ghz), "Length", "in", "mm")
helix_feed_pinD = constants.unit_converter(0.082 * (3.33 / freq_ghz), "Length", "in", "mm")
helix_diameter_syn = wl_meters / math.pi * 0.9
helix_spacing_syn = math.pi * helix_diameter_syn * math.tan(math.radians(12.5))
helix_turns_syn = gain_value_mag * wl_meters / 15.0 / helix_spacing_syn
parameters["groundx"] = groundx
parameters["groundy"] = groundy
parameters["diameter"] = helix_diameter
parameters["spacing"] = helix_spacing
parameters["wire_diameter"] = helix_wiredia
parameters["coax_inner_radius"] = helix_coax_inner_radius
parameters["coax_outer_radius"] = helix_coax_outer_radius
parameters["feed_pinL"] = helix_feed_pinL
parameters["feed_pinD"] = helix_feed_pinD
parameters["number_of_turns"] = helix_turns_syn
parameters["feeder_length"] = self.feeder_length
parameters["pos_x"] = self.origin[0]
parameters["pos_y"] = self.origin[1]
parameters["pos_z"] = self.origin[2]
myKeys = list(parameters.keys())
myKeys.sort()
parameters_out = OrderedDict([(i, parameters[i]) for i in myKeys])
return parameters_out
[docs]
@pyaedt_function_handler()
def model_hfss(self):
"""Draw an axial mode antenna.
Once the antenna is created, this method is not used anymore.
"""
if self.object_list:
logger.debug("This antenna is already defined")
return False
if (
self.material not in self._app.materials.mat_names_aedt
and self.material not in self._app.materials.mat_names_aedt_lower
):
self._app.logger.warning("Material not found. Create the material before assigning it.")
return False
self.set_variables_in_hfss()
# Map parameters
groundx = self.synthesis_parameters.groundx.hfss_variable
groundy = self.synthesis_parameters.groundy.hfss_variable
diameter = self.synthesis_parameters.diameter.hfss_variable
wire_diameter = self.synthesis_parameters.wire_diameter.hfss_variable
spacing = self.synthesis_parameters.spacing.hfss_variable
coax_inner_radius = self.synthesis_parameters.coax_inner_radius.hfss_variable
coax_outer_radius = self.synthesis_parameters.coax_outer_radius.hfss_variable
feed_pinL = self.synthesis_parameters.feed_pinL.hfss_variable
feed_pinD = self.synthesis_parameters.feed_pinD.hfss_variable
feeder_length = self.synthesis_parameters.feeder_length.hfss_variable
number_of_turns = self.synthesis_parameters.number_of_turns.hfss_variable
self._app[number_of_turns] = str(self.synthesis_parameters.number_of_turns.value)
pos_x = self.synthesis_parameters.pos_x.hfss_variable
pos_y = self.synthesis_parameters.pos_y.hfss_variable
pos_z = self.synthesis_parameters.pos_z.hfss_variable
antenna_name = self.name
coordinate_system = self.coordinate_system
my_udmPairs = []
mypair = ["PolygonSegments", "8"]
my_udmPairs.append(mypair)
mypair = ["PolygonRadius", "{}/2".format(wire_diameter)]
my_udmPairs.append(mypair)
mypair = ["StartHelixRadius", "{}/2".format(diameter)]
my_udmPairs.append(mypair)
mypair = ["RadiusChange", "0"]
my_udmPairs.append(mypair)
mypair = ["Pitch", spacing]
my_udmPairs.append(mypair)
mypair = ["Turns", str(number_of_turns)]
my_udmPairs.append(mypair)
mypair = ["SegmentsPerTurn", "16"]
my_udmPairs.append(mypair)
mypair = ["RightHanded", self.direction]
my_udmPairs.append(mypair)
udm = self._app.modeler.create_udp(
udp_dll_name="SegmentedHelix/PolygonHelix.dll",
udp_parameters_list=my_udmPairs,
upd_library="syslib",
name="helix",
)
udm.history().properties["Coordinate System"] = coordinate_system
udm.material_name = "pec"
self._app.modeler.split(udm, "XY", "PositiveOnly")
gnd = self._app.modeler.create_rectangle(
self._app.PLANE.XY,
[
"-{}/2".format(groundx),
"-{}/2".format(groundy),
"-{}-{}/2".format(feed_pinL, wire_diameter),
],
[groundx, groundy],
name="gnd_" + antenna_name,
)
gnd.history().properties["Coordinate System"] = coordinate_system
cutout = self._app.modeler.create_circle(
cs_plane=2,
origin=[
"{}/2".format(diameter),
"-{}/2".format(feed_pinD),
"-{}-{}/2".format(feed_pinL, wire_diameter),
],
radius=coax_outer_radius,
)
cutout.history().properties["Coordinate System"] = coordinate_system
gnd.subtract(cutout, keep_originals=False)
# Negative air
feed_pin = self._app.modeler.create_cylinder(
orientation=2,
origin=[
"{}/2".format(diameter),
"-{}/2".format(feed_pinD),
"-{}-{}/2".format(feed_pinL, wire_diameter),
],
radius=feed_pinD + "/2",
height=feed_pinL + "+" + wire_diameter + "/2",
name="Feed_{}".format(antenna_name),
material="pec",
)
feed_pin.history().properties["Coordinate System"] = coordinate_system
feed_coax = self._app.modeler.create_cylinder(
orientation=2,
origin=[
"{}/2".format(diameter),
"-{}/2".format(feed_pinD),
"-{}-{}/2".format(feed_pinL, wire_diameter),
],
radius=coax_inner_radius,
height="-{}".format(feeder_length),
name="Feed1_{}".format(antenna_name),
material="pec",
)
feed_coax.history().properties["Coordinate System"] = coordinate_system
Coax = self._app.modeler.create_cylinder(
orientation=2,
origin=[
"{}/2".format(diameter),
"-{}/2".format(feed_pinD),
"-{}-{}/2".format(feed_pinL, wire_diameter),
],
radius=coax_outer_radius,
height="-{}".format(feeder_length),
name="coax_{}".format(antenna_name),
material="Teflon (tm)",
)
Coax.history().properties["Coordinate System"] = coordinate_system
# Cap
cap = self._app.modeler.create_cylinder(
orientation=2,
origin=[
"{}/2".format(diameter),
"-{}/2".format(feed_pinD),
"-{}-{}/2-{}".format(feed_pinL, wire_diameter, feeder_length),
],
radius=coax_outer_radius,
height="-{}/2".format(feed_pinL),
name="port_cap_" + antenna_name,
material="pec",
)
cap.history().properties["Coordinate System"] = coordinate_system
# P1
p1 = self._app.modeler.create_circle(
cs_plane=2,
origin=[
"{}/2".format(diameter),
"-{}/2".format(feed_pinD),
"-{}-{}/2-{}".format(feed_pinL, wire_diameter, feeder_length),
],
radius=coax_outer_radius,
name="port_" + antenna_name,
)
p1.color = (128, 0, 0)
p1.history().properties["Coordinate System"] = coordinate_system
udm.group_name = antenna_name
feed_coax.group_name = antenna_name
feed_pin.group_name = antenna_name
cap.group_name = antenna_name
gnd.group_name = antenna_name
p1.group_name = antenna_name
self._app.modeler.move([udm, feed_coax, feed_pin, Coax, cap, gnd, p1], [pos_x, pos_y, pos_z])
self.object_list[udm.name] = udm
self.object_list[feed_coax.name] = feed_coax
self.object_list[feed_pin.name] = feed_pin
self.object_list[cap.name] = cap
self.object_list[gnd.name] = gnd
self.object_list[p1.name] = p1
[docs]
@pyaedt_function_handler()
def model_disco(self):
"""Model in PyDiscovery. To be implemented."""
pass
[docs]
@pyaedt_function_handler()
def setup_disco(self):
"""Set up model in PyDiscovery. To be implemented."""
pass
