Download this example

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

---

3-Phase Cable with Neutral

This example uses PyAEDT to create a 3-phase cable with neutral and solve it using Maxwell 2D AC Magnetic (Eddy Current) solver.

Keywords: Maxwell 2D, cable, 3-phase, field calculator, field plot

Prerequisites

Perform imports

import os
import tempfile
import time

import ansys.aedt.core  # Interface to Ansys Electronics Desktop

Define constants

AEDT_VERSION = "2025.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")

Launch AEDT and Maxwell 2D

Create an instance of the Maxwell2d class named m2d by providing the project and design names, the version, and the graphical mode.

project_name = os.path.join(temp_folder.name, "M2D_cable.aedt")
m2d = ansys.aedt.core.Maxwell2d(
    project=project_name,
    design="cable_maxwell_eddy",
    solution_type="AC MagneticXY",
    version=AEDT_VERSION,
    non_graphical=NG_MODE,
    new_desktop=True,
)

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.20.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_7421f99a-192b-4ce1-956b-2698ef065ac1.log is enabled.
PyAEDT INFO: Log on AEDT is disabled.
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 52011.
PyAEDT INFO: Electronics Desktop started on gRPC port: 52011 after 11.033803224563599 seconds.
PyAEDT INFO: AEDT installation Path C:\Program Files\ANSYS Inc\v252\AnsysEM
PyAEDT INFO: Ansoft.ElectronicsDesktop.2025.2 version started with process ID 5012.
PyAEDT INFO: Project M2D_cable has been created.
PyAEDT INFO: Added design 'cable_maxwell_eddy' of type Maxwell 2D.
PyAEDT INFO: Aedt Objects correctly read

Define modeler units

m2d.modeler.model_units = "mm"

PyAEDT INFO: Modeler2D class has been initialized!
PyAEDT INFO: Modeler class has been initialized! Elapsed time: 0m 0sec

Add materials

Add XLPE material for insulation.

xlpe = m2d.materials.add_material("XLPE")
xlpe.update()
xlpe.conductivity = "0"
xlpe.permittivity = "2.3"

PyAEDT INFO: Materials class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Adding new material to the Project Library: XLPE
PyAEDT INFO: Material has been added in Desktop.

Create geometry of the cable and assign materials

Create geometry of the 3-phase cable with neutral and assign materials.

Create the cable shield

shield = m2d.modeler.create_circle(origin=[0, 0, 0], radius=8, name="Shield")
filler = m2d.modeler.create_circle(origin=[0, 0, 0], radius=7.5, name="Filler")
m2d.modeler.subtract(blank_list=shield.name, tool_list=filler.name)
shield.material_name = "aluminum"
filler.material_name = "polyethylene"
filler.color = [143, 175, 143]
filler.transparency = 0

Create the cable inner conductors

phase_a = m2d.modeler.create_circle(origin=[5, 0, 0], radius=2.0575, material="copper")
cond = m2d.modeler.duplicate_around_axis(
    assignment=phase_a.name, axis="Z", angle=120, clones=3
)
phase_b = m2d.modeler[cond[1][0]]
phase_c = m2d.modeler[cond[1][1]]
phase_a.name = "PhaseA"
phase_a.color = [255, 0, 0]
phase_a.transparency = 0
phase_b.name = "PhaseB"
phase_b.color = [0, 0, 255]
phase_b.transparency = 0
phase_c.name = "PhaseC"
phase_c.color = [0, 255, 0]
phase_c.transparency = 0

Create the cable inner conductor insulation

insul_a = m2d.modeler.create_circle(origin=[5, 0, 0], radius=2.25, material="XLPE")
insul_a.transparency = 0
insul = m2d.modeler.duplicate_around_axis(
    assignment=insul_a.name, axis="Z", angle=120, clones=3
)
insul_b = m2d.modeler[insul[1][0]]
insul_c = m2d.modeler[insul[1][1]]
insul_a.name = "InsulA"
insul_b.name = "InsulB"
insul_c.name = "InsulC"

Create the cable neutral wire and its insulation

neu_ins = m2d.modeler.duplicate_along_line(
    assignment=[phase_a.name, insul_a.name], vector=[-5, 0, 0], clones=2
)
phase_n = m2d.modeler[neu_ins[1][0]]
phase_n.name = "PhaseN"
phase_n.color = [128, 64, 64]
insul_n = m2d.modeler[neu_ins[1][1]]
insul_n.name = "InsulN"

m2d.modeler.subtract(blank_list=filler, tool_list=[insul_a, insul_b, insul_c, insul_n])
m2d.modeler.subtract(blank_list=insul_a, tool_list=phase_a.name)
m2d.modeler.subtract(blank_list=insul_b, tool_list=phase_b.name)
m2d.modeler.subtract(blank_list=insul_c, tool_list=phase_c.name)
m2d.modeler.subtract(blank_list=insul_n, tool_list=phase_n.name)

True

Create region

Create the air region and assign boundary condition to it.

region = m2d.modeler.create_region(pad_value=200)
m2d.assign_balloon(assignment=region.edges)

m2d.modeler.fit_all()

PyAEDT WARNING: Balloon boundary with type voltage is only valid for Electrostatic solvers.
PyAEDT INFO: Boundary Balloon Balloon_R0VIMR has been created.

Assign excitations

Set electrical excitations for the conductive objects.

winding_a = m2d.assign_winding(assignment=phase_a.name, current=200, name="PhaseA")
winding_b = m2d.assign_winding(
    assignment=phase_b.name, current=200, phase=-120, name="PhaseB"
)
winding_c = m2d.assign_winding(
    assignment=phase_c.name, current=200, phase=-240, name="PhaseC"
)
winding_n = m2d.assign_winding(assignment=phase_n.name, current=0, name="PhaseN")
winding_s = m2d.assign_winding(assignment=shield.name, current=0, name="Shield")

PyAEDT INFO: Boundary Winding PhaseA has been created.
PyAEDT INFO: Boundary Coil Coil_AO817C has been created.
PyAEDT INFO: Boundary Winding PhaseB has been created.
PyAEDT INFO: Boundary Coil Coil_NQYFN6 has been created.
PyAEDT INFO: Boundary Winding PhaseC has been created.
PyAEDT INFO: Boundary Coil Coil_0NU84B has been created.
PyAEDT INFO: Boundary Winding PhaseN has been created.
PyAEDT INFO: Boundary Coil Coil_U7EB12 has been created.
PyAEDT INFO: Boundary Winding Shield has been created.
PyAEDT INFO: Boundary Coil Coil_YUY4PP has been created.

Assign matrix

Set matrix for RL parameters calculation.

m2d.assign_matrix(
    assignment=["PhaseA", "PhaseB", "PhaseC", "PhaseN", "Shield"], matrix_name="Matrix1"
)

PyAEDT INFO: Infinite is the only return path option in EddyCurrent.
PyAEDT INFO: Boundary Matrix Matrix1 has been created.

<ansys.aedt.core.modules.boundary.maxwell_boundary.MaxwellParameters at 0x23d6eb46740>

Assign mesh operation

Assign surface approximation mesh to all objects.

m2d.mesh.assign_surface_mesh_manual(
    assignment=m2d.modeler.object_list, normal_dev="10deg"
)

PyAEDT INFO: Mesh class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Mesh class has been initialized! Elapsed time: 0m 0sec

<ansys.aedt.core.modules.mesh.MeshOperation at 0x23d6eb46800>

Analysis setup

Set analysis setup to run the simulation.

setup = m2d.create_setup()
setup["MaximumPasses"] = 15
setup["PercentError"] = 0.1
setup["Frequency"] = "60Hz"

Run the Maxwell 2D analysis

The following command runs the 2D finite element analysis in Maxwell.

m2d.analyze_setup(name=setup.name)

PyAEDT INFO: Solving design setup MySetupAuto
PyAEDT INFO: Design setup MySetupAuto solved correctly in 0.0h 0.0m 16.0s

True

Field plots

Plot the magnitude of magnetic flux density

plot1 = m2d.post.create_fieldplot_surface(
    assignment=m2d.modeler.object_list, quantity="Mag_B", plot_name="B"
)

PyAEDT INFO: Parsing C:\Users\ansys\AppData\Local\Temp\tmp_kk_jaez.ansys\M2D_cable.aedt.
PyAEDT INFO: File C:\Users\ansys\AppData\Local\Temp\tmp_kk_jaez.ansys\M2D_cable.aedt correctly loaded. Elapsed time: 0m 0sec
PyAEDT INFO: aedt file load time 0.0
PyAEDT INFO: PostProcessor class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: PostProcessor class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Post class has been initialized! Elapsed time: 0m 0sec
PyAEDT INFO: Active Design set to cable_maxwell_eddy

Add the expression for the current density absolute value using the advanced field calculator

j_abs = {
    "name": "Jabs",
    "description": "Absolute value of the current density",
    "design_type": ["Maxwell 2D"],
    "fields_type": ["Fields"],
    "primary_sweep": "",
    "assignment": "",
    "assignment_type": [""],
    "operations": [
        "Fundamental_Quantity('Jt')",
        "Operation('Smooth')",
        "Operation('ScalarZ')",
        "Scalar_Function(FuncValue='Phase')",
        "Operation('AtPhase')",
        "Operation('Abs')",
    ],
    "report": ["Field_2D"],
}
m2d.post.fields_calculator.add_expression(j_abs, None)

'Jabs'

Plot the absolute value of the current density in the conductive objects

plot2 = m2d.post.create_fieldplot_surface(
    assignment=[phase_a, phase_b, phase_c],
    quantity="Jabs",
    plot_name="Jabs_cond_3Phase",
)
plot3 = m2d.post.create_fieldplot_surface(
    assignment=[shield, phase_n], quantity="Jabs", plot_name="Jabs_shield_neutral"
)

PyAEDT INFO: Active Design set to cable_maxwell_eddy
PyAEDT INFO: Active Design set to cable_maxwell_eddy

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