Download this example

Download this example as a Jupyter Notebook or as a Python script.

---

Eddy current analysis and reduced matrix

This example shows how to leverage PyAEDT to assign a matrix and perform series or parallel connections in a Maxwell 2D design.

Keywords: Maxwell 2D, eddy current, *matrix**.

Perform imports and define constants

Perform required imports.

import tempfile
import time

import ansys.aedt.core

Define constants.

AEDT_VERSION = "2024.2"
NUM_CORES = 4
NG_MODE = False  # Open AEDT UI when it is launched.

Create temporary directory

Create a temporary directory where downloaded data or dumped data can be stored. If you’d like to retrieve the project data for subsequent use, the temporary folder name is given by temp_folder.name.

temp_folder = tempfile.TemporaryDirectory(suffix=".ansys")

Download AEDT file

Set the local temporary folder to export the AEDT file to.

project_path = ansys.aedt.core.downloads.download_file(
    source="maxwell_ec_reduced_matrix",
    name="m2d_eddy_current.aedt",
    destination=temp_folder.name,
)

Launch AEDT and Maxwell 2D

Launch AEDT and Maxwell 2D, providing the version, path to the project, and the graphical mode.

m2d = ansys.aedt.core.Maxwell2d(
    project=project_path,
    version=AEDT_VERSION,
    design="EC_Planar",
    non_graphical=NG_MODE,
)

PyAEDT INFO: Parsing C:\Users\ansys\AppData\Local\Temp\tmpid_nn7zi.ansys\maxwell_ec_reduced_matrix\m2d_eddy_current.aedt.
PyAEDT INFO: Python version 3.10.11 (tags/v3.10.11:7d4cc5a, Apr  5 2023, 00:38:17) [MSC v.1929 64 bit (AMD64)]
PyAEDT INFO: PyAEDT version 0.12.dev0.
PyAEDT INFO: Initializing new Desktop session.
PyAEDT INFO: Log on console is enabled.
PyAEDT INFO: Log on file C:\Users\ansys\AppData\Local\Temp\pyaedt_ansys_9e665ed4-5541-4907-8bfe-7a6bb3fb71e9.log is enabled.
PyAEDT INFO: Log on AEDT is enabled.
PyAEDT INFO: Debug logger is disabled. PyAEDT methods will not be logged.
PyAEDT INFO: Launching PyAEDT with gRPC plugin.
PyAEDT INFO: New AEDT session is starting on gRPC port 50977
PyAEDT INFO: File C:\Users\ansys\AppData\Local\Temp\tmpid_nn7zi.ansys\maxwell_ec_reduced_matrix\m2d_eddy_current.aedt correctly loaded. Elapsed time: 0m 0sec
PyAEDT INFO: AEDT installation Path C:\Program Files\AnsysEM\v242\Win64
PyAEDT INFO: Ansoft.ElectronicsDesktop.2024.2 version started with process ID 3248.
PyAEDT INFO: Project m2d_eddy_current has been opened.
PyAEDT INFO: Aedt Objects correctly read

Assign a matrix

Assign a matrix given the list of sources to assign the matrix to and the return path.

matrix = m2d.assign_matrix(
    assignment=["pri", "sec", "terz"], matrix_name="Matrix1", return_path="infinite"
)

PyAEDT INFO: Modeler2D class has been initialized!
PyAEDT INFO: Modeler class has been initialized! Elapsed time: 0m 1sec
PyAEDT INFO: Infinite is the only return path option in EddyCurrent.

Assign reduced matrices

Assign reduced matrices to the parent matrix previously created. For 2D/3D Eddy current solvers, two or more excitations can be joined either in series or parallel connection. The result is known as a reduced matrix.

series = matrix.join_series(sources=["pri", "sec"], matrix_name="ReducedMatrix1")
parallel = matrix.join_parallel(sources=["sec", "terz"], matrix_name="ReducedMatrix2")

Analyze setup

Run the analysis.

m2d.save_project()
m2d.analyze(setup=m2d.setup_names[0], cores=NUM_CORES, use_auto_settings=False)

PyAEDT INFO: Project m2d_eddy_current Saved correctly
PyAEDT INFO: Key Desktop/ActiveDSOConfigurations/Maxwell 2D correctly changed.
PyAEDT INFO: Solving design setup Setup1
PyAEDT INFO: Key Desktop/ActiveDSOConfigurations/Maxwell 2D correctly changed.
PyAEDT INFO: Design setup Setup1 solved correctly in 0.0h 0.0m 23.0s

True

Get expressions

Get the available report quantities given the context and the quantities category L.

expressions = m2d.post.available_report_quantities(
    report_category="EddyCurrent",
    display_type="Data Table",
    context={"Matrix1": "ReducedMatrix1"},
    quantities_category="L",
)

PyAEDT INFO: Parsing C:/Users/ansys/AppData/Local/Temp/tmpid_nn7zi.ansys/maxwell_ec_reduced_matrix/m2d_eddy_current.aedt.
PyAEDT INFO: File C:/Users/ansys/AppData/Local/Temp/tmpid_nn7zi.ansys/maxwell_ec_reduced_matrix/m2d_eddy_current.aedt correctly loaded. Elapsed time: 0m 0sec
PyAEDT INFO: aedt file load time 0.03125429153442383
PyAEDT INFO: PostProcessor class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Post class has been initialized! Elapsed time: 0m 0sec

Create report and get solution data

Create a data table report and get report data given the matrix context.

report = m2d.post.create_report(
    expressions=expressions,
    context={"Matrix1": "ReducedMatrix1"},
    plot_type="Data Table",
    setup_sweep_name="Setup1 : LastAdaptive",
    plot_name="reduced_matrix",
)
data = m2d.post.get_solution_data(
    expressions=expressions,
    context={"Matrix1": "ReducedMatrix1"},
    report_category="EddyCurrent",
    setup_sweep_name="Setup1 : LastAdaptive",
)

PyAEDT INFO: Solution Data Correctly Loaded.

Get matrix data

Get inductance results for the join connections in nH.

ind = ansys.aedt.core.generic.constants.unit_converter(
    data.data_magnitude()[0],
    unit_system="Inductance",
    input_units=data.units_data[expressions[0]],
    output_units="uH",
)

Release AEDT

m2d.save_project()
m2d.release_desktop()
# Wait 3 seconds to allow AEDT to shut down before cleaning the temporary directory.
time.sleep(3)

PyAEDT INFO: Project m2d_eddy_current Saved correctly
PyAEDT INFO: Desktop has been released and closed.

Clean up

All project files are saved in the folder temp_folder.name. If you’ve run this example as a Jupyter notebook, you can retrieve those project files. The following cell removes all temporary files, including the project folder.

temp_folder.cleanup()

---

Download this example

Download this example as a Jupyter Notebook or as a Python script.