assign_2way_coupling

Icepak.assign_2way_coupling(setup=None, number_of_iterations=2, continue_ipk_iterations=True, ipk_iterations_per_coupling=20)

Assign two-way coupling to a setup.

Parameters:

setupstr, optional

Name of the setup. The default is None, in which case the active setup is used.

number_of_iterationsint, optional

Number of iterations. The default is 2.

continue_ipk_iterationsbool, optional

Whether to continue Icepak iterations. The default is True.

ipk_iterations_per_couplingint, optional

Additional iterations per coupling. The default is 20.

Returns:

bool

True when successful, False when failed.

References

>>> oModule.AddTwoWayCoupling

Examples

>>> icepak.assign_2way_coupling("Setup1", 1, True, 10)
True