matflow.param_classes.single_crystal_parameters.SingleCrystalParameters#

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

Bases: ParameterValue

Methods

as_base

Return a copy where base includes the perturbations.

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

perturbations

phases

as_base()#

Return a copy where base includes the perturbations.

property base#
dump_to_HDF5_group(group)#

Write this parameter value to an HDF5 group.

property perturbations#
property phases#
prepare_JSON_dump()#

Prepare this parameter value for serialisation as JSON.

Return type:

Dict

classmethod save_from_HDF5_group(group, param_id, workflow)#

Extract a parameter value from an HDF5 group.

Parameters:

param_id (int) –

classmethod save_from_JSON(data, param_id, workflow)#

Extract a parameter value from JSON data.

Parameters:

param_id (int) –

to_dict()#

Serialise this parameter value as a dictionary.