6.2.2. pyafv.PhysicalParams.with_optimal_radius

PhysicalParams.with_optimal_radius(digits=None, delta=None)[source]

Returns a new instance of PhysicalParams with the maximum radius \(\ell\) (or r) updated to the steady state value \(\ell_0\) of cell doublets. Other parameters (except delta) remain unchanged.

Basically a wrapper around get_steady_state() + creating a new instance.

Parameters:

  • digits (int | None) – If not None, round the optimal radius \(\ell_0\) to the specified number of decimal places. Only intended for randomized tests to avoid floating-point precision issues.

  • delta (float | None) – If not None, set the contact truncation threshold delta to this value in the returned instance.

Returns:

New instance with optimal radius.

Return type:

PhysicalParams

Important

In the returned instance, the contact truncation threshold delta is set to 0.45*r by default.