enable_harmonic_force

Maxwell3d.enable_harmonic_force(assignment, force_type=0, window_function='Rectangular', use_number_of_last_cycles=True, last_cycles_number=1, calculate_force='Harmonic')

Enable the harmonic force calculation for the transient analysis.

Parameters:

assignmentlist

List of object names for force calculations.

force_typeint, optional

Force type. Options are 0 for objects, 1 for surface, and 2 for volumetric.

window_functionstr, optional

Windowing function. Default is "Rectangular". Available options are: "Rectangular", "Tri", "Van Hann", "Hamming", "Blackman", "Lanczos", "Welch".

use_number_of_last_cyclesbool, optional

Use number of last cycles for force calculations. Default is True.

last_cycles_numberint, optional

Defines the number of cycles to compute if use_number_of_last_cycle is True.

calculate_forcestr, optional

How to calculate force. The default is "Harmonic". Options are "Harmonic" and "Transient".

Returns:

bool

True when successful, False when failed.

References

>>> odesign.EnableHarmonicForceCalculation

Examples

Enable harmonic force in Maxwell 3D for magnetic transient solver.

>>> from ansys.aedt.core import Maxwell3d
>>> m3d = Maxwell3d(solution_type="Transient")
>>> cylinder = m3d.modeler.create_cylinder(origin=[0, 0, 0], orientation="Z", radius=3, height=21)
>>> m3d.enable_harmonic_force(assignment=cylinder.name)
>>> m3d.release_desktop(True, True)