add_excitation_model

TwinBuilder.add_excitation_model(project, design, use_default_values=True, setup=None, start=None, stop=None, export_uniform_points=False, export_uniform_points_step=1e-05, excitations=None)

Use the excitation component to assign output quantities

This works in a Twin Builder design to a windings in a Maxwell design. This method works only with AEDT 2025 R1 and later.

Parameters:

projectstr

Name or path to the project to provide.

designstr

Name of the design to import the excitations from.

use_default_valuesbool, optional

Whether to use the default values for the start and stop times for the chosen TR setup. The default value is True.

setupstr, optional

Name of the Twinbuilder setup. If not provided, the default value is the first setup in the design.

startstr, optional

Start time provided as value + units. The default value is None. If not provided and use_default_values=True, the value is chosen from the TR setup.

stopfloat, optional

Stop time provided as value + units. The default value is None. If not provided and use_default_values=True, the value is chosen from the TR setup.

export_uniform_pointsbool, optional

Whether Twin Builder is to perform linear interpolation to uniformly space out time and data points. The interpolation is based on the step size provided. The default is False.

export_uniform_points_stepfloat, optional

Step size to use for the uniform interpolation. The default value is 1E-5.

excitationsdict, optional

List of excitations to extract from the Maxwell design. It is a dictionary where the keys are the excitation names and value a list containing respectively: - The excitation value to assign to the winding, provided as a string. - A boolean whether to enable the component or not. - The excitation type. Possible options are Current or Voltage. - A boolean to enable the pin. If True the pin will be used to make connection on the schematic and the excitation value will be zeroed, since the expectation is that the value is provided through schematic connections. To know which excitations will be extracted from the Maxwell design use app.excitations_by_type["Winding Group"] where app is the Maxwell instance. If not provided, the method automatically retrieves the excitations from the Maxwell Design and sets the default excitation settings.

Returns:

pyaedt.modeler.cad.object3dcircuit.CircuitComponent or bool

Circuit component object if successful or False if fails.

References

>>> oComponentManager.AddExcitationModel

Examples

>>> from ansys.aedt.core import TwinBuilder
>>> tb = TwinBuilder(specified_version="2025.2")
>>> maxwell_app = tb.desktop_class[[project_name, "my_maxwell_design"]]
>>> excitations = {}
>>> for e in maxwell_app.excitations_by_type["Winding Group"]:
...     excitations[e.name] = ["20", True, e.props["Type"], False]
>>> comp = tb.add_excitation_model(project=project_name, design="my_maxwell_design", excitations=excitations)
>>> tb.desktop_class.release_desktop(False, False)