next_available

LocalMechanicalPool.next_available(return_index=False)

Wait until a Mechanical instance is available and return this instance.

Parameters:

return_indexbool, optional

Whether to return the index along with the instance. The default is False.

Returns:

pymechanical.Mechanical

Instance of Mechanical.

int

Index within the pool of Mechanical instances. This index is not returned by default.

Examples

>>> mechanical = pool.next_available()
>>> mechanical
Ansys Mechanical [Ansys Mechanical Enterprise]
Product Version:231
Software build date:Wed Jul 13 14:29:54 2022