set_custom_hpc_options

Hfss.set_custom_hpc_options(cores: int = None, gpus: int = None, tasks: int = None, num_variations_to_distribute: int = None, allowed_distribution_types: list = None, use_auto_settings: bool = True) → bool | None

Set custom HPC options.

This method creates a temporary ACF file based on the local configuration file and modifies it with the specified HPC options.

Parameters:

coresint, optional

Number of cores. The default is None.

gpusstr, optional

Number of gpus. The default is None.

tasksint, optional

Number of tasks. The default is None.

num_variations_to_distributeint, optional

Number of variations to distribute. The default is None.

allowed_distribution_typeslist, optional

Allowed distribution types. The default is None.

use_auto_settingsbool, optional

Number of variations to distribute. The default is None.

Returns:

bool

True when successful, False when failed.

Examples

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss()
>>> hfss.set_custom_hpc_options(cores=4, tasks=2)