create_setup

Icepak.create_setup(name: str | None = None, setup_type: int | str | None = None, **kwargs) → SetupHFSS

Create an analysis setup for Icepak. Optional arguments are passed along with setup_type and name. Keyword names correspond to the setup_type corresponding to the native AEDT API. The list of keywords here is not exhaustive.

Note

This method overrides the Analysis.setup() method for the HFSS app.

Parameters:

namestr, optional

Name of the setup.

setup_typeint, str, optional

Type of the setup. Options are "IcepakSteadyState" and "IcepakTransient". The default is "IcepakSteadyState".

**kwargsdict, optional

Available keys depend on setup chosen. For more information, see Icepak templates and arguments.

Returns:

ansys.aedt.core.modules.solve_setup.SetupHFSS

3D Solver Setup object.

References

>>> oModule.InsertSetup

Examples

>>> from ansys.aedt.core import Icepak
>>> app = Icepak()
>>> app.create_setup(setup_type="Transient", name="Setup1", MaxIterations=20)