MaxwellMatrix

class ansys.aedt.core.modules.boundary.maxwell_boundary.MaxwellMatrix(app, name, props=None, schema=None)

Provides methods to interact with matrices in Maxwell.

This class allows sources in a reduced matrix to be listed, updated, and deleted.

Parameters:

appansys.aedt.core.Maxwell3d, ansys.aedt.core.Maxwell2d

Parent Maxwell application instance.

schemaMaxwellMatrix.MatrixElectric, MaxwellMatrix.MatrixMagnetostatic, MaxwellMatrix.MatrixACMagnetic,

MaxwellMatrix.MatrixACMagneticAPhi, optional

Schema defining the matrix assignment. The default is None.

Examples

Setup a Maxwell 2D model in Electrostatic (valid for all electric solvers).

>>> from ansys.aedt.core import Maxwell2d
>>> m2d = Maxwell2d(version="2025.2", solution_type=SolutionsMaxwell2D.ElectroStaticXY)
>>> rectangle1 = m2d.modeler.create_rectangle([0.5, 1.5, 0], [2.5, 5], name="Sheet1")
>>> rectangle2 = m2d.modeler.create_rectangle([9, 1.5, 0], [2.5, 5], name="Sheet2")
>>> rectangle3 = m2d.modeler.create_rectangle([16.5, 1.5, 0], [2.5, 5], name="Sheet3")
>>> voltage1 = m2d.assign_voltage([rectangle1], amplitude=1, name="Voltage1")
>>> voltage2 = m2d.assign_voltage([rectangle2], amplitude=1, name="Voltage2")
>>> voltage3 = m2d.assign_voltage([rectangle3], amplitude=1, name="Voltage3")

Define matrix assignments by instantiating the MaxwellElectric class.

>>> matrix_args = MaxwellMatrix.MatrixElectric(
>>>             signal_sources=[voltage1.name, voltage2.name],
>>>             ground_sources=[voltage3.name],
>>>             matrix_name="test_matrix",
>>>         )

Assign matrix. The method returns a MaxwellParameters object.

>>> matrix = m2d.assign_matrix(matrix_args)
>>> m2d.release_desktop(True, True)

Methods

MaxwellMatrix.create()	Create a boundary.
MaxwellMatrix.delete()	Delete the boundary.
MaxwellMatrix.join_parallel(sources[, ...])	Create matrix reduction by joining sources in parallel.
MaxwellMatrix.join_series(sources[, ...])	Create matrix reduction by joining sources in series.
MaxwellMatrix.jsonalize_tree()	Create dictionary from the Binary Tree.
MaxwellMatrix.suppress_all(app)	Activate suppress option for all the operations contained in the binary tree node.
MaxwellMatrix.unsuppress_all(app)	Disable suppress option for all the operations contained in the binary tree node.
MaxwellMatrix.update()	Update the boundary.
MaxwellMatrix.update_property(prop_name, ...)	Update the property of the binary tree node.

Attributes

MaxwellMatrix.available_properties	Available properties.
MaxwellMatrix.children
MaxwellMatrix.command	Command of the modeler hystory if available.
MaxwellMatrix.gc_sources
MaxwellMatrix.ground_sources
MaxwellMatrix.group_sources
MaxwellMatrix.name	Boundary Name.
MaxwellMatrix.properties	Properties data.
MaxwellMatrix.props	Maxwell parameter data.
MaxwellMatrix.public_dir	Shortcut for dir(self).
MaxwellMatrix.reduced_matrices	List of reduced matrix groups for the parent matrix.
MaxwellMatrix.rl_sources
MaxwellMatrix.signal_sources