local_delta_value#
- OrderParameter.local_delta_value(
- self: OrderParameter,
- linear_site_index: SupportsInt | SupportsIndex,
- new_value: Annotated[numpy.typing.ArrayLike, numpy.float64, '[m, 1]'],
Calculate and return change in order parameter value due to a local DoF change
- Parameters:
linear_site_index (int) – Linear site indices (as defined by a
SiteIndexConverter) where the local DoF value is changed.new_value (np.ndarray) – The value the local DoF is changed to.
- Returns:
delta_value – The change in order parameter values, as a const reference. Referred to values remain fixed until the next time a calculator function is called.
- Return type:
np.ndarray