Convert to md format

02-HFSS

Author: Devin-Crawford

examples/02-HFSS/Array.py

@@ -1,37 +1,34 @@
-"""
-HFSS: component antenna array
------------------------------
-This example shows how you can use PyAEDT to create an example using a 3D component file. It sets up
-the analysis, solves it, and uses postprocessing functions to create plots using Matplotlib and
-PyVista without opening the HFSS user interface. This examples runs only on Windows using CPython.
-"""
-##########################################################
-# Perform required imports
-# ~~~~~~~~~~~~~~~~~~~~~~~~
+# # HFSS: component antenna array
+
+# This example shows how you can use PyAEDT to create an example using a 3D component file. It sets up
+# the analysis, solves it, and uses postprocessing functions to create plots using Matplotlib and
+# PyVista without opening the HFSS user interface. This examples runs only on Windows using CPython.
+
+
+# ## Perform required imports
+#
 # Perform required imports.
 
 import os
 import pyaedt
 from pyaedt.modules.solutions import FfdSolutionData
 
-##########################################################
-# Set non-graphical mode
-# ~~~~~~~~~~~~~~~~~~~~~~
+# ## Set non-graphical mode
+#
 # Set non-graphical mode. 
 # You can set ``non_graphical`` either to ``True`` or ``False``.
 
 non_graphical = False
 
-##########################################################
-# Download 3D component
-# ~~~~~~~~~~~~~~~~~~~~~
+# ## Download 3D component
+#
 # Download the 3D component that is needed to run the example.
 example_path = pyaedt.downloads.download_3dcomponent()
 
-##########################################################
-# Launch HFSS and save project
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Launch HFSS and save project
+#
 # Launch HFSS and save the project.
+
 project_name = pyaedt.generate_unique_project_name(project_name="array")
 hfss = pyaedt.Hfss(projectname=project_name,
                    specified_version="2023.2",
@@ -41,9 +38,8 @@
 
 print("Project name " + project_name)
 
-##########################################################
-# Read array definition from JSON file
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Read array definition from JSON file
+#
 # Read the array definition from a JSON file. A JSON file
 # can contain all information needed to import and set up a
 # full array in HFSS.
@@ -57,9 +53,8 @@
 dict_in["cells"][(3, 3)] = {"name": "Circ_Patch_5GHz1"}
 array = hfss.add_3d_component_array_from_json(dict_in)
 
-##########################################################
-# Modify cells
-# ~~~~~~~~~~~~
+# ## Modify cells
+#
 # Make center element passive and rotate corner elements.
 
 array.cells[1][1].is_active = False
@@ -68,9 +63,8 @@
 array.cells[2][0].rotation = 90
 array.cells[2][2].rotation = 90
 
-##########################################################
-# Set up simulation
-# ~~~~~~~~~~~~~~~~~
+# ## Set up simulation
+#
 # Set up a simulation and analyze it.
 
 setup = hfss.create_setup()
@@ -79,27 +73,24 @@
 
 hfss.analyze(num_cores=4)
 
-##########################################################
-# Get far field data
-# ~~~~~~~~~~~~~~~~~~
+
+# ## Get far field data
+#
 # Get far field data. After the simulation completes, the far
 # field data is generated port by port and stored in a data class.
 
 ffdata = hfss.get_antenna_ffd_solution_data(sphere_name="Infinite Sphere1", setup_name=hfss.nominal_adaptive,
                                             frequencies=[5e9])
-
-##########################################################
-# Generate contour plot
-# ~~~~~~~~~~~~~~~~~~~~~
+# ## Generate contour plot
+#
 # Generate a contour plot. You can define the Theta scan
 # and Phi scan.
 
 ffdata.plot_farfield_contour(farfield_quantity='RealizedGain',
                              title='Contour at {}Hz'.format(ffdata.frequency))
 
-##########################################################
-# Release AEDT
-# ~~~~~~~~~~~~
+# ## Release AEDT
+#
 # Release AEDT.
 # Far field post-processing can be performed without AEDT because the data is stored.
 
@@ -109,25 +100,22 @@
 
 hfss.release_desktop()
 
-##########################################################
-# Load far field data
-# ~~~~~~~~~~~~~~~~~~~
+# ## Load far field data
+#
 # Load far field data stored.
 
 ffdata = FfdSolutionData(frequencies=frequencies[0], eep_files=eep_file[0])
 
-##########################################################
-# Generate contour plot
-# ~~~~~~~~~~~~~~~~~~~~~
+# ## Generate contour plot
+#
 # Generate a contour plot. You can define the Theta scan
 # and Phi scan.
 
 ffdata.plot_farfield_contour(farfield_quantity='RealizedGain',
                              title='Contour at {}Hz'.format(ffdata.frequency))
 
-##########################################################
-# Generate 2D cutout plots
-# ~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Generate 2D cutout plots
+#
 # Generate 2D cutout plots. You can define the Theta scan
 # and Phi scan.
 
@@ -141,9 +129,8 @@
                    title='Elevation',
                    quantity_format="dB10")
 
-##########################################################
-# Generate 3D polar plots in Matplotlib
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Generate 3D polar plots in Matplotlib
+#
 # Generate 3D polar plots in Matplotlib. You can define
 # the Theta scan and Phi scan.
 

examples/02-HFSS/Create_3d_Component_and_use_it.py

@@ -1,136 +1,126 @@
-"""
-Create a 3D Component and reuse it
-----------------------------------
-Summary of the workflow
-1. Create an antenna using PyAEDT and HFSS 3D Modeler (same can be done with EDB and HFSS 3D Layout)
-2. Store the object as a 3D Component on the disk
-3. Reuse the 3D component in another project
-4. Parametrize and optimize target design
-"""
-
-##########################################################
-# Perform required imports
-# ~~~~~~~~~~~~~~~~~~~~~~~~
+# # Create a 3D Component and reuse it
+
+# Summary of the workflow
+# 1. Create an antenna using PyAEDT and HFSS 3D Modeler (same can be done with EDB and HFSS 3D Layout)
+# 2. Store the object as a 3D Component on the disk
+# 3. Reuse the 3D component in another project
+# 4. Parametrize and optimize target design
+
+# ## Perform required imports
+#
 # Perform required imports.
+
 import os
 import tempfile
 from pyaedt import Hfss
 from pyaedt.generic.general_methods import generate_unique_name
 
-##########################################################
-# Launch HFSS 2023.2
-# ~~~~~~~~~~~~~~~~~~
+# ## Launch HFSS 2023.2
+#
 # PyAEDT can initialize a new session of Electronics Desktop or connect to an existing one. 
 # Once Desktop is connected, a new HFSS session is started and a design is created.
 
 hfss = Hfss(specified_version="2023.2", new_desktop_session=True, close_on_exit=True)
 
-##########################################################
-# Variables
-# ~~~~~~~~~
+# ## Variables
+#
 # PyAEDT can create and store all variables available in AEDT (Design, Project, Post Processing)
 
 hfss["thick"] = "0.1mm"
 hfss["width"] = "1mm"
 
-##########################################################
-#  Modeler
-# ~~~~~~~~
+# ##  Modeler
+#
 # PyAEDT supports all modeler functionalities available in the Desktop.
 # Objects can be created, deleted and modified using all available boolean operations.
 # History is also fully accessible to PyAEDT.
 
-substrate = hfss.modeler.create_box(["-width","-width","-thick"],["2*width","2*width", "thick"], matname="FR4_epoxy", name="sub")
+# +
+substrate = hfss.modeler.create_box(["-width","-width","-thick"],["2*width","2*width", "thick"], 
+                                    matname="FR4_epoxy", name="sub")
 
-patch = hfss.modeler.create_rectangle("XY",["-width/2","-width/2","0mm"],["width","width"], name="patch1")
+patch = hfss.modeler.create_rectangle("XY",["-width/2","-width/2","0mm"],["width","width"], 
+                                      name="patch1")
 
-via1 = hfss.modeler.create_cylinder(2, ["-width/8","-width/4","-thick"],"0.01mm", "thick", matname="copper", name="via_inner")
+via1 = hfss.modeler.create_cylinder(2, ["-width/8","-width/4","-thick"],"0.01mm", "thick", 
+                                    matname="copper", name="via_inner")
 
-via_outer = hfss.modeler.create_cylinder(2, ["-width/8","-width/4","-thick"],"0.025mm", "thick", matname="Teflon_based", name="via_teflon")
+via_outer = hfss.modeler.create_cylinder(2, ["-width/8","-width/4","-thick"],"0.025mm", "thick", 
+                                         matname="Teflon_based", name="via_teflon")
+# -
 
-##########################################################
-# Boundaries
-# ~~~~~~~~~~
+# ## Boundaries
+#
 # Most of HFSS boundaries and excitations are already available in PyAEDT.
 # User can assign easily a boundary to a face or to an object by taking benefits of
 # Object-Oriented Programming (OOP) available in PyAEDT.
 
 hfss.assign_perfecte_to_sheets(patch)
 
-##########################################################
-# Advanced Modeler functions
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Thanks to Python capabilities a lot of additional functionalities have been added to the Modeler of PyAEDT.
-# in this example there is a property to retrieve automatically top and bottom faces of an objects.
+# ## Advanced Modeler functions
+#
+# Thanks to Python capabilities a lot of additional functionalities have been added to the modeler of PyAEDT.
+# In this example there is a property to retrieve automatically top and bottom faces of an objects.
 
+# +
 side_face = [i for i in via_outer.faces if i.id not in [via_outer.top_face_z.id, via_outer.bottom_face_z.id]]
 
 hfss.assign_perfecte_to_sheets(side_face)
 hfss.assign_perfecte_to_sheets(substrate.bottom_face_z)
+# -
 
-##########################################################
-# Create Wave Port
-# ~~~~~~~~~~~~~~~~
+# ## Create Wave Port
+#
 # Wave port can be assigned to a sheet or to a face of an object.
 
 hfss.wave_port(via_outer.bottom_face_z, name="P1", )
 
-##########################################################
-# Create 3D Component
-# ~~~~~~~~~~~~~~~~~~~
+# ## Create 3D Component
+#
 # Once the model is ready a 3D Component can be created.
 # Multiple options are available to partially select objects, cs, boundaries and mesh operations.
 # Furthermore, encrypted 3d comp can be created too.
 
 component_path = os.path.join(tempfile.gettempdir(), generate_unique_name("component_test")+".aedbcomp")
 hfss.modeler.create_3dcomponent(component_path, "patch_antenna")
 
-##########################################################
-# Multiple project management
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# ## Multiple project management
+#
 # PyAEDT allows to control multiple projects, design and solution type at the same time.
 
 hfss2 = Hfss(projectname="new_project", designname="new_design")
 
-##########################################################
-# Insert of 3d component
-# ~~~~~~~~~~~~~~~~~~~~~~
+# ## Insert of 3d component
+#
 # The 3d component can be inserted without any additional info.
 # All needed info will be read from the file itself.
 
 hfss2.modeler.insert_3d_component(component_path)
 
-##########################################################
-# 3D Component Parameters
-# ~~~~~~~~~~~~~~~~~~~~~~~
+# ## 3D Component Parameters
+#
 # All 3d Component parameters are available and can be parametrized.
 
 hfss2.modeler.user_defined_components["patch_antenna1"].parameters
-
 hfss2["p_thick"] = "1mm"
-
 hfss2.modeler.user_defined_components["patch_antenna1"].parameters["thick"]="p_thick"
 
-##########################################################
-# Multiple 3d Components
-# ~~~~~~~~~~~~~~~~~~~~~~
+# ## Multiple 3d Components
+#
 # There is no limit to the number of 3D components that can be added on the same design.
 # They can be the same or linked to different files.
 
 hfss2.modeler.create_coordinate_system(origin=[20, 20, 10], name="Second_antenna")
-
 ant2 = hfss2.modeler.insert_3d_component(component_path, targetCS="Second_antenna")
 
-##########################################################
-# Move components
-# ~~~~~~~~~~~~~~~
+# ## Move components
+#
 # The component can be moved by changing is position or moving the relative coordinate system.
 
 hfss2.modeler.coordinate_systems[0].origin = [10, 10, 3]
 
-##########################################################
-# Boundaries
-# ~~~~~~~~~~
+# ## Boundaries
+#
 # Most of HFSS boundaries and excitations are already available in PyAEDT.
 # User can assign easily a boundary to a face or to an object by taking benefits of
 
@@ -142,22 +132,19 @@
 # All setup parameters can be edited.
 
 setup1 = hfss2.create_setup()
-
 optim = hfss2.parametrics.add("p_thick", "0.2mm", "1.5mm", step=14)
 
-###############################################################################
-# Save project
-# ~~~~~~~~~~~~
+# ## Save project
+#
 # Save the project.
 
 hfss2.modeler.fit_all()
 hfss2.plot(show=False, export_path=os.path.join(hfss.working_directory, "Image.jpg"), plot_air_objects=True)
 
-###############################################################################
-# Close AEDT
-# ~~~~~~~~~~
+# ## Close AEDT
+#
 # After the simulation completes, you can close AEDT or release it using the
-# :func:`pyaedt.Desktop.release_desktop` method.
+# `pyaedt.Desktop.release_desktop` method.
 # All methods provide for saving the project before closing AEDT.
 
 hfss2.save_project(os.path.join(tempfile.gettempdir(), generate_unique_name("parametrized")+".aedt"))