order_parameters

Configuration.order_parameters(

self: Configuration,

dof_space: DoFSpace,

) → Annotated[numpy.typing.NDArray[numpy.float64], '[m, 1]']

Return order parameters, \(\vec{\eta}\)

Notes

• The OrderParameter class is more efficient for calculating order parameters repeatedly for evolving configurations in the same supercell.

Parameters:

dof_space (DoFSpace) – A DoFSpace with basis defining the order parameters, as described in Evaluating order parameters.

Returns:

order_parameters – Order parameters, \(\vec{\eta}\), as described in Evaluating order parameters. For global DoF, this is a direct linear transformation of the global DoF values into the DoFSpace basis. For local DoF, this is a linear transformation into the DoFSpace basis of the average of local DoF values . The average is taken over tilings of the DoFSpace supercell into a commensurate super configuration.

Return type:

np.ndarray