.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples\02-HFSS\Waveguide_Filter.py"
.. LINE NUMBERS ARE GIVEN BELOW.
.. only:: html
.. note::
:class: sphx-glr-download-link-note
:ref:`Go to the end <sphx_glr_download_examples_02-HFSS_Waveguide_Filter.py>`
to download the full example code.
.. rst-class:: sphx-glr-example-title
.. _sphx_glr_examples_02-HFSS_Waveguide_Filter.py:
HFSS: Inductive Iris waveguide filter
-------------------------------------
This example shows how to build and analyze a 4-pole
X-Band waveguide filter using inductive irises.
.. GENERATED FROM PYTHON SOURCE LINES 8-11
.. code-block:: Python
# sphinx_gallery_thumbnail_path = 'Resources/wgf.png'
.. GENERATED FROM PYTHON SOURCE LINES 12-16
Perform required imports
~~~~~~~~~~~~~~~~~~~~~~~~
Perform required imports.
.. GENERATED FROM PYTHON SOURCE LINES 16-22
.. code-block:: Python
import os
import tempfile
import pyaedt
from pyaedt import general_methods
.. GENERATED FROM PYTHON SOURCE LINES 23-26
Set AEDT version
~~~~~~~~~~~~~~~~
Set AEDT version.
.. GENERATED FROM PYTHON SOURCE LINES 26-29
.. code-block:: Python
aedt_version = "2024.1"
.. GENERATED FROM PYTHON SOURCE LINES 30-33
Launch Ansys Electronics Desktop (AEDT)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. GENERATED FROM PYTHON SOURCE LINES 35-43
Define parameters and values for waveguide iris filter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
l: Length of the cavity from the mid-point of one iris
to the midpoint of the next iris.
w: Width of the iris opening.
a: Long dimension of the waveguide cross-section (X-Band)
b: Short dimension of the waveguide cross-section.
t: Metal thickness of the iris insert.
.. GENERATED FROM PYTHON SOURCE LINES 43-54
.. code-block:: Python
wgparams = {'l': [0.7428, 0.82188],
'w': [0.50013, 0.3642, 0.3458],
'a': 0.4,
'b': 0.9,
't': 0.15,
'units': 'in'}
non_graphical = False
new_thread = True
.. GENERATED FROM PYTHON SOURCE LINES 55-57
Save the project and results in the TEMP folder
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. GENERATED FROM PYTHON SOURCE LINES 57-76
.. code-block:: Python
project_folder = os.path.join(tempfile.gettempdir(), "waveguide_example")
if not os.path.exists(project_folder):
os.mkdir(project_folder)
project_name = os.path.join(project_folder, general_methods.generate_unique_name("wgf", n=2))
# Instantiate the HFSS application
hfss = pyaedt.Hfss(projectname=project_name + '.aedt',
specified_version=aedt_version,
designname="filter",
non_graphical=non_graphical,
new_desktop_session=True,
close_on_exit=True,
solution_type="Modal")
# hfss.settings.enable_debug_methods_argument_logger = False # Only for debugging.
var_mapping = dict() # Used by parse_expr to parse expressions.
.. GENERATED FROM PYTHON SOURCE LINES 77-79
Initialize design parameters in HFSS.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. GENERATED FROM PYTHON SOURCE LINES 79-101
.. code-block:: Python
hfss.modeler.model_units = "in" # Set to inches
for key in wgparams:
if type(wgparams[key]) in [int, float]:
hfss[key] = str(wgparams[key]) + wgparams['units']
var_mapping[key] = wgparams[key] # Used for expression parsing
elif type(wgparams[key]) == list:
count = 1
for v in wgparams[key]:
this_key = key + str(count)
hfss[this_key] = str(v) + wgparams['units']
var_mapping[this_key] = v # Used to parse expressions and generate numerical values.
count += 1
if len(wgparams['l']) % 2 == 0:
zstart = "-t/2" # Even number of cavities, odd number of irises.
is_even = True
else:
zstart = "l1/2 - t/2" # Odd number of cavities, even number of irises.
is_even = False
.. GENERATED FROM PYTHON SOURCE LINES 102-107
Draw parametric waveguide filter
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Define a function to place each iris at the correct longitudinal (z) position,
Loop from the largest index (interior of the filter) to 1, which is the first
iris nearest the waveguide ports.
.. GENERATED FROM PYTHON SOURCE LINES 107-122
.. code-block:: Python
def place_iris(zpos, dz, n):
w_str = "w" + str(n) # Iris width parameter as a string.
this_name = "iris_a_" + str(n) # Iris object name in the HFSS project.
iris = [] # Return a list of the two objects that make up the iris.
if this_name in hfss.modeler.object_names:
this_name = this_name.replace("a", "c")
iris.append(hfss.modeler.create_box(origin=['-b/2', '-a/2', zpos],
sizes=['(b - ' + w_str + ')/2', 'a', dz],
name=this_name,
material="silver"))
iris.append(iris[0].mirror([0, 0, 0], [1, 0, 0], duplicate=True))
return iris
.. GENERATED FROM PYTHON SOURCE LINES 123-126
Place irises
~~~~~~~~~~~~
Place the irises from inner (highest integer) to outer.
.. GENERATED FROM PYTHON SOURCE LINES 126-139
.. code-block:: Python
for count in reversed(range(1, len(wgparams['w']) + 1)):
if count < len(wgparams['w']): # Update zpos
zpos = zpos + "".join([" + l" + str(count) + " + "])[:-3]
iris = place_iris(zpos, "t", count)
iris = place_iris("-(" + zpos + ")", "-t", count)
else: # Place first iris
zpos = zstart
iris = place_iris(zpos, "t", count)
if not is_even:
iris = place_iris("-(" + zpos + ")", "-t", count)
.. GENERATED FROM PYTHON SOURCE LINES 140-147
Draw full waveguide with ports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use ``hfss.variable_manager`` which acts like a dict() to return an instance of
the ``pyaedt.application.Variables.VariableManager`` class for any variable.
The ``VariableManager`` instance takes the HFSS variable name as a key.
``VariableManager`` properties enable access to update, modify and
evaluate variables.
.. GENERATED FROM PYTHON SOURCE LINES 147-161
.. code-block:: Python
var_mapping['port_extension'] = 1.5 * wgparams['l'][0]
hfss['port_extension'] = str(var_mapping['port_extension']) + wgparams['units']
hfss["wg_z_start"] = "-(" + zpos + ") - port_extension"
hfss["wg_length"] = "2*(" + zpos + " + port_extension )"
wg_z_start = hfss.variable_manager["wg_z_start"]
wg_length = hfss.variable_manager["wg_length"]
hfss["u_start"] = "-a/2"
hfss["u_end"] = "a/2"
hfss.modeler.create_box(origin=["-b/2", "-a/2", "wg_z_start"],
sizes=["b", "a", "wg_length"],
name="waveguide",
material="vacuum")
.. rst-class:: sphx-glr-script-out
.. code-block:: none
<pyaedt.modeler.cad.object3d.Object3d object at 0x0000022638C96620>
.. GENERATED FROM PYTHON SOURCE LINES 162-167
Draw the whole waveguide.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
wg_z is the total length of the waveguide, including port extension.
Note that the ``.evaluated_value`` provides access to the numerical value of
``wg_z_start`` which is an expression in HFSS.
.. GENERATED FROM PYTHON SOURCE LINES 167-170
.. code-block:: Python
wg_z = [wg_z_start.evaluated_value, hfss.value_with_units(wg_z_start.numeric_value + wg_length.numeric_value, "in")]
.. GENERATED FROM PYTHON SOURCE LINES 171-175
Assign wave ports to the end faces of the waveguid
and define the calibration lines to ensure self-consistent
polarization between wave ports.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. GENERATED FROM PYTHON SOURCE LINES 175-185
.. code-block:: Python
count = 0
ports = []
for n, z in enumerate(wg_z):
face_id = hfss.modeler.get_faceid_from_position(position=[0, 0, z], assignment="waveguide")
u_start = [0, hfss.variable_manager["u_start"].evaluated_value, z]
u_end = [0, hfss.variable_manager["u_end"].evaluated_value, z]
ports.append(hfss.wave_port(face_id, integration_line=[u_start, u_end], name="P" + str(n + 1), renormalize=False))
.. GENERATED FROM PYTHON SOURCE LINES 186-192
Insert the mesh adaptation setup using refinement at two frequencies.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This approach is useful for resonant structures as the coarse initial
mesh impacts the resonant frequency and hence, the field propagation through the
filter. Adaptation at multiple frequencies helps to ensure that energy propagates
through the resonant structure while the mesh is refined.
.. GENERATED FROM PYTHON SOURCE LINES 192-205
.. code-block:: Python
setup = hfss.create_setup("Setup1", setuptype="HFSSDriven",
MultipleAdaptiveFreqsSetup=['9.8GHz', '10.2GHz'],
MaximumPasses=5)
setup.create_frequency_sweep(
unit="GHz",
name="Sweep1",
start_frequency=9.5,
stop_frequency=10.5,
sweep_type="Interpolating",
)
.. rst-class:: sphx-glr-script-out
.. code-block:: none
<pyaedt.modules.SolveSweeps.SweepHFSS object at 0x0000022638C94040>
.. GENERATED FROM PYTHON SOURCE LINES 206-208
Solve the project with two tasks.
Each frequency point is solved simultaneously.
.. GENERATED FROM PYTHON SOURCE LINES 208-212
.. code-block:: Python
setup.analyze(tasks=2)
.. GENERATED FROM PYTHON SOURCE LINES 213-219
Generate S-parameter plots
~~~~~~~~~~~~~~~~~~~~~~~~~~
The following commands fetch solution data from HFSS for plotting directly
from the Python interpreter.
Caution: The syntax for expressions must be identical to that used
in HFSS.
.. GENERATED FROM PYTHON SOURCE LINES 219-226
.. code-block:: Python
traces_to_plot = hfss.get_traces_for_plot(second_element_filter="P1*")
report = hfss.post.create_report(traces_to_plot) # Creates a report in HFSS
solution = report.get_solution_data()
plt = solution.plot(solution.expressions) # Matplotlib axes object.
.. image-sg:: /examples/02-HFSS/images/sphx_glr_Waveguide_Filter_001.png
:alt: Simulation Results Plot
:srcset: /examples/02-HFSS/images/sphx_glr_Waveguide_Filter_001.png
:class: sphx-glr-single-img
.. rst-class:: sphx-glr-script-out
.. code-block:: none
No artists with labels found to put in legend. Note that artists whose label start with an underscore are ignored when legend() is called with no argument.
.. GENERATED FROM PYTHON SOURCE LINES 227-231
Generate E field plot
~~~~~~~~~~~~~~~~~~~~~
The following command generates a field plot in HFSS and uses PyVista
to plot the field in Jupyter.
.. GENERATED FROM PYTHON SOURCE LINES 231-236
.. code-block:: Python
plot = hfss.post.plot_field(quantity="Mag_E", assignment=["Global:XZ"], plot_type="CutPlane",
setup=hfss.nominal_adaptive, intrinsics={"Freq": "9.8GHz", "Phase": "0deg"}, show=False,
export_path=hfss.working_directory)
.. image-sg:: /examples/02-HFSS/images/sphx_glr_Waveguide_Filter_002.png
:alt: Waveguide Filter
:srcset: /examples/02-HFSS/images/sphx_glr_Waveguide_Filter_002.png
:class: sphx-glr-single-img
.. GENERATED FROM PYTHON SOURCE LINES 237-240
Save and close the desktop
~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command saves the project to a file and closes the desktop.
.. GENERATED FROM PYTHON SOURCE LINES 240-243
.. code-block:: Python
hfss.save_project()
hfss.release_desktop()
.. rst-class:: sphx-glr-script-out
.. code-block:: none
True
.. rst-class:: sphx-glr-timing
**Total running time of the script:** (2 minutes 15.869 seconds)
.. _sphx_glr_download_examples_02-HFSS_Waveguide_Filter.py:
.. only:: html
.. container:: sphx-glr-footer sphx-glr-footer-example
.. container:: sphx-glr-download sphx-glr-download-jupyter
:download:`Download Jupyter notebook: Waveguide_Filter.ipynb <Waveguide_Filter.ipynb>`
.. container:: sphx-glr-download sphx-glr-download-python
:download:`Download Python source code: Waveguide_Filter.py <Waveguide_Filter.py>`
.. only:: html
.. rst-class:: sphx-glr-signature
`Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_