matflow.param_classes.single_crystal_parameters.SingleCrystalParameters

class matflow.param_classes.single_crystal_parameters.SingleCrystalParameters(phases, perturbations=None)

Bases: ParameterValue

Parameter relating to the phases in a single crystal.

Parameters:

• phases (dict[str, dict[str, list[float]]]) – The data used to create the bulk phases.

• perturbations (Perturbation | list[Perturbation] | None) – The perturbations to apply to the phases.

Methods

as_base	Return a copy where base includes the perturbations.
dump_element_group_to_HDF5_group	Write a list (from an element group) of parameter values to an HDF5 group.
dump_to_HDF5_group	Write this parameter value to an HDF5 group.
prepare_JSON_dump	Prepare this parameter value for serialisation as JSON.
save_from_HDF5_group	Extract a parameter value from an HDF5 group.
save_from_JSON	Extract a parameter value from JSON data.
to_dict	Serialise this parameter value as a dictionary.

Attributes

base	The initial data used to create the bulk phases.
perturbations	The perturbations to apply to the phases.
phases	The data used to create the bulk phases, with perturbations applied.

as_base()

Return a copy where base includes the perturbations.

Return type:

Self

property base: dict[str, dict[str, list[float]]]

The initial data used to create the bulk phases.

classmethod dump_element_group_to_HDF5_group(objs, group)

Write a list (from an element group) of parameter values to an HDF5 group.

Parameters:

• objs (list[ParameterValue]) –

• group (Group) –

dump_to_HDF5_group(group)

Write this parameter value to an HDF5 group.

Parameters:

group (Group) –

property perturbations: list[matflow.param_classes.single_crystal_parameters.Perturbation]

The perturbations to apply to the phases.

property phases: dict[str, dict[str, list[float]]]

The data used to create the bulk phases, with perturbations applied.

prepare_JSON_dump()

Prepare this parameter value for serialisation as JSON.

Return type:

dict[str, Any]

classmethod save_from_HDF5_group(group, param_id, workflow)

Extract a parameter value from an HDF5 group.

Parameters:

• group (Group) –

• param_id (int) –

• workflow (Workflow) –

classmethod save_from_JSON(data, param_id, workflow)

Extract a parameter value from JSON data.

Parameters:

• param_id (int | list[int]) –

• workflow (Workflow) –

to_dict()

Serialise this parameter value as a dictionary.