export_element_based_harmonic_force#

Maxwell3d.export_element_based_harmonic_force(output_directory: str | None = None, setup: str | None = None, start_frequency: float | None = None, stop_frequency: float | None = None, number_of_frequency: int | None = None) str#

Export an element-based harmonic force data to a .csv file.

This method requires enabling element-based harmonic force before solving the model.

Parameters:
output_directorystr, optional

Path for the output directory. If None pyaedt working dir will be used.

setupstr, optional

Name of the solution setup. If None, the nominal setup is used.

start_frequencyfloat, optional

When a float is entered the Start-Stop Frequency approach is used.

stop_frequencyfloat, optional

When a float is entered, the Start-Stop Frequency approach is used.

number_of_frequencyint, optional

When a number is entered, the number of frequencies approach is used.

Returns:
str

Path to the export directory.

References

>>> odesign.ExportElementBasedHarmonicForce

Examples

The following example shows how to set and export element based (volumetric) harmonic force.

>>> from ansys.aedt.core import Maxwell3d
>>> m3d = Maxwell3d(solution_type="Transient")
>>> coil = m3d.modeler.create_rectangle(orientation="XZ",
>>>                                     origin=[70, 0, -11],
>>>                                     sizes=[11, 110], name="Coil",
>>>                                     material="copper")
>>> coil.sweep_around_axis(axis="Z")
>>> terminal = m3d.modeler.create_rectangle(orientation="XZ",
>>>                                         origin=[70, 0, -11],
>>>                                         sizes=[11, 110],
>>>                                         name="Coil_terminal")
>>> steel = m3d.modeler.create_rectangle(orientation="XZ",
>>>                                      origin=[181, 0, -11],
>>>                                      sizes=[11, 55], name="steel",
>>>                                      material="steel_1008")
>>> steel.sweep_around_axis(axis="Z")
>>> region = m3d.modeler.create_region()
>>> m3d.assign_winding(assignment=terminal.name, is_solid=False, current="100*cos(2*PI*50*time)")
>>> # Enable element based volumetric harmonic force and solve the model.
>>> m3d.enable_harmonic_force(assignment=steel.name, force_type=2, calculate_force="Harmonic")
>>> setup = m3d.create_setup()
>>> setup.props["StopTime"] = "2/50s"
>>> setup.props["TimeStep"] = "1/500s"
>>> m3d.analyze(setup=setup.name, use_auto_settings=False)
>>> # Export element based harmonic force in a .csv file.
>>> m3d.export_element_based_harmonic_force()
>>> m3d.desktop_class.close_desktop()