matflow.param_classes.load.LoadCase#

class matflow.param_classes.load.LoadCase(steps)#

Bases: ParameterValue

A loading case, consisting of a sequence of loadings to apply.

Methods

`biaxial`	A single-step biaxial load case.
`create_damask_loading_plan`	Turn this load case into a DAMASK loading plan.
`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.
`example_uniaxial`	A non-parametrisable example single-step uniaxial load case.
`multistep`	A load case with multiple steps.
`planar_2D`	A single-step planar 2D load case.
`plane_strain`	A single-step plane-strain load case.
`prepare_JSON_dump`	Prepare this parameter value for serialisation as JSON.
`random_2D`	A single-step random 2D load case.
`random_3D`	A single-step random 3D load case.
`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.
`uniaxial`	A single-step uniaxial load case.
`uniaxial_cyclic`	Uniaxial cyclic loading.

Attributes

`num_steps`	The number of steps in the case.
`type`	The type of the step if there is only a single step, or the types if there are multiple steps.
`types`	The types of the steps.
`steps`	The steps in the loading case.

Parameters:: steps (list[matflow.param_classes.load.LoadStep]) –

classmethod biaxial(**kwargs)#

A single-step biaxial load case.

See biaxial() for argument documentation.

Return type:: Self

create_damask_loading_plan()#

Turn this load case into a DAMASK loading plan.

Return type:: list[dict[str, Any]]

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[Self]) –
group (HDF5Group) –

dump_to_HDF5_group(group)#

Write this parameter value to an HDF5 group.

Parameters:: group (HDF5Group) –

classmethod example_uniaxial()#

A non-parametrisable example single-step uniaxial load case.

Return type:: Self

classmethod multistep(steps)#

A load case with multiple steps.

Parameters:: steps (list[dict[str, Any] | matflow.param_classes.load.LoadStep]) – A list of LoadStep objects or dict`s representing `LoadStep objects, in which case if a dict has a key type, the corresponding LoadStep classmethod will be invoked with the remainder of the dict items.
Return type:: Self

property num_steps: int#: The number of steps in the case.

classmethod planar_2D(**kwargs)#

A single-step planar 2D load case.

See planar_2D() for argument documentation.

Return type:: Self

classmethod plane_strain(**kwargs)#

A single-step plane-strain load case.

See plane_strain() for argument documentation.

Return type:: Self

prepare_JSON_dump()#

Prepare this parameter value for serialisation as JSON.

Return type:: dict[str, Any]

classmethod random_2D(**kwargs)#

A single-step random 2D load case.

See random_2D() for argument documentation.

Return type:: Self

classmethod random_3D(**kwargs)#

A single-step random 3D load case.

See random_3D() for argument documentation.

Return type:: Self

classmethod save_from_HDF5_group(group, param_id, workflow)#

Extract a parameter value from an HDF5 group.

Parameters:

group (HDF5Group) –
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) –

steps: list[matflow.param_classes.load.LoadStep]#: The steps in the loading case.

to_dict()#

Serialise this parameter value as a dictionary.

Return type:: dict[str, Any]

property type: str | list[str]#: The type of the step if there is only a single step, or the types if there are multiple steps.

property types: list[str]#: The types of the steps.

classmethod uniaxial(**kwargs)#

A single-step uniaxial load case.

See uniaxial() for argument documentation.

Return type:: Self

classmethod uniaxial_cyclic(**kwargs)#

Uniaxial cyclic loading.

See uniaxial_cyclic() for argument documentation.

Return type:: Self