make_global_variables#

casm.bset.cluster_functions.make_global_variables(
prim: Prim,
key: str,
make_variable_name_f: Callable | None = None,
)[source]#

Construct the variable list for a global degree of freedom (DoF)

Parameters:

  • prim (Prim) – The Prim

  • key (str) – The name of the global DoF type. Must exist in prim.

  • make_variable_name_f (Optional[Callable] = None) – Allows specifying a custom function to construct variable names. The default function used is make_variable_name(). Custom functions should have the same signature as make_variable_name().

Returns:

  • variables (list[Variable]) – A list of Variable for each component of DoF of type key from each site in cluster.

  • variable_subsets (list[list[int]]) – Lists of variables (as indices into the variables list) which mix under application of symmetry. For example, if the variables are the 6 strain components, then var_subsets=[[0, 1, 2, 3, 4, 5]].