analyze#

SetupParam.analyze(cores=1, tasks=1, gpus=0, acf_file=None, use_auto_settings=True, solve_in_batch=False, machine='localhost', run_in_thread=False, revert_to_initial_mesh=False)[source]#

Solve the active design.

Parameters:

coresint, optional: Number of simulation cores. The default is 1.
tasksint, optional: Number of simulation tasks. The default is 1.
gpusint, optional: Number of simulation graphic processing units to use. The default is 0.
acf_filestr, optional: Full path to the custom ACF file.
use_auto_settingsbool, optional: Set True to use automatic settings for HPC. The option is only considered for setups that support automatic settings.
solve_in_batchbool, optional: Whether to solve the project in batch or not. If True the project will be saved, closed, solved and repened.
machinestr, optional: Name of the machine if remote. The default is "localhost".
run_in_threadbool, optional: Whether to submit the batch command as a thread. The default is False.
revert_to_initial_meshbool, optional: Whether to revert to initial mesh before solving or not. Default is False.

Returns:

bool: True when successful, False when failed.

References

>>> oDesign.Analyze