analyze_setup#

MaxwellCircuit.analyze_setup(name=None, cores=4, tasks=1, gpus=0, acf_file=None, use_auto_settings=True, num_variations_to_distribute=None, allowed_distribution_types=None, revert_to_initial_mesh=False, blocking=True)[source]#

Analyze a design setup.

Parameters:

namestr, optional: Name of the setup, which can be an optimetric setup or a simple setup. The default is None, in which case all setups are solved.
coresint, optional: Number of simulation cores. The default is 4.
tasksint, optional: Number of simulation tasks. The default is 1.
gpusint, optional: Number of simulation graphics processing units. The default is 0.
acf_filestr, optional: Full path to the custom ACF file. The default is None.
use_auto_settingsbool, optional: Either use or not auto settings in task/cores. It is not supported by all Setup.
num_variations_to_distributeint, optional: Number of variations to distribute. For this to take effect use_auto_settings must be set to True.
allowed_distribution_typeslist, optional: List of strings. Each string represents a distribution type. The default value None does nothing. An empty list [] disables all types.
revert_to_initial_meshbool, optional: Whether to revert to initial mesh before solving or not. Default is False.
blockingbool, optional: Whether to block script while analysis is completed or not. It works from AEDT 2023 R2. Default is True.

Returns:

bool: True when successful, False when failed.

References

>>> oDesign.Analyze