connect_design

AEDTCommon.connect_design(app_name: str | None = None)

Connect to an application design.

If a design exists, this method uses the active project and design. If a design does not exist, this method creates a design of the specified type. If no application is specified, the default is "HFSS".

Parameters:

app_namestr

AEDT application name. Options are:

• "Circuit"

• "EMIT"

• "HFSS"

• "HFSS3DLayout"

• "Icepak"

• "Maxwell2D"

• "Maxwell3D"

• "Q2D"

• "Q3D"

• "Rmxprt"

• "TwinBuilder"

• "Mechanical"

Returns:

bool

Returns True if the connection to a design is successful, False otherwise.

Examples

>>> from ansys.aedt.toolkits.common.backend.api import AEDTCommon
>>> toolkit_api = AEDTCommon()
>>> toolkit_api.launch_aedt()
>>> toolkit_api.wait_to_be_idle()
>>> toolkit_api.connect_design()