eddy_effects_on

Maxwell3d.eddy_effects_on(assignment, enable_eddy_effects=True, enable_displacement_current=True)

Assign eddy effects on a list of objects.

Available only for AC Magnetic (Eddy Current) and Transient solvers. For Eddy Current solvers only, you must specify the displacement current on the model objects.

Parameters:

assignmentlist, str

List of objects to assign eddy effects to.

enable_eddy_effectsbool, optional

Whether to activate eddy effects. The default is True.

enable_displacement_currentbool, optional

Whether to activate the displacement current. The default is True. Valid only for Eddy Current solvers.

Returns:

bool

True when successful and False when failed.

References

>>> oModule.SetEddyEffect

Examples

Set eddy effects on an object in Transient solver.

>>> m3d = Maxwell3d(solution_type="Transient")
>>> box = m3d.modeler.create_box(origin=[0, 0, 0], sizes=[10, 10, 10], name="cube", material="Copper")
>>> m3d.eddy_effects_on(assignment=box.name, enable_eddy_effects=True, enable_displacement_current=False)
>>> m3d.release_desktop(True, True)