evaluate_design

abstractmethod Project.evaluate_design(design: Design, run_async: bool = False) → Design | str

Evaluate a design.

Parameters:

design: Design

Instance of a Design class with defined parameters.

run_async: bool, optional

Whether to perform the evaluation as an asynchronous, non-blocking long running operation. If True, this method returns immediately with the ID of the long running operation instead of the evaluated design. By default False.

Note

Argument is supported for Ansys optiSLang version >= 27.1 only.

Returns:

Union[Design, str]

Evaluated design, or the ID of the long running operation if run_async is True.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with the server.

OslCommandError

Raised when a command or query fails.

OslVersionError

Raised when run_async is True and the connected Ansys optiSLang server is older than version 27.1.

TimeoutError

Raised when the timeout float value expires.