matflow.param_classes.load.LoadStep#

class matflow.param_classes.load.LoadStep(total_time, num_increments, direction=None, normal_direction=None, target_def_grad=None, target_def_grad_rate=None, target_vel_grad=None, stress=None, dump_frequency=1)#

Bases: ParameterValue

Boundary conditions for volume element loading.

Parameters:

total_time (float | int) – Total simulation time.
num_increments (int) – Number of simulation increments.
direction (str | None) – Direction or directions in which loading is done.
normal_direction (str | None) – Direction of normal vector.
target_def_grad (numpy.ma.core.MaskedArray, shape (3, 3)) – Deformation gradient aim tensor. Masked values correspond to unmasked values in stress.
target_def_grad_rate (numpy.ma.core.MaskedArray, shape (3, 3)) – Deformation gradient rate tensor. Masked values correspond to unmasked values in stress.
target_vel_grad (numpy.ma.core.MaskedArray, shape (3, 3)) – Velocity gradient aim tensor.
stress (numpy.ma.core.MaskedArray, shape (3, 3)) – Stress tensor. Masked values correspond to unmasked values in target_def_grad or target_def_grad_rate.
dump_frequency (int) – By default, 1, meaning results are written out every increment.

Methods

`biaxial`	Generate a biaxial load step.
`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 uniaxial load step.
`planar_2D`	Generate a planar 2D load case normal to the x-, y-, or z-direction.
`plane_strain`	Generate a plane-strain load step.
`prepare_JSON_dump`	Prepare this parameter value for serialisation as JSON.
`random_2D`	Generate a random 2D planar load case.
`random_3D`	Generate a random 3D 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`	Generate a uniaxial load step.
`uniaxial_cyclic`	Generate a cyclic stress case.

Attributes

`method_args`	The arguments to the factory method used to make this loading step, if known.
`method_name`	The name of the factory method used to make this loading step, if known.
`strain_like_tensor`	The strain-like tensor, if known.
`type`	More user-friendly access to method name.
`total_time`	Total simulation time.
`num_increments`	Number of simulation increments.
`direction`	Direction or directions in which loading is done.
`normal_direction`	Direction of normal vector.
`target_def_grad`	Deformation gradient aim tensor.
`target_def_grad_rate`	Deformation gradient rate tensor.
`target_vel_grad`	Velocity gradient aim tensor.
`stress`	Stress tensor.
`dump_frequency`	How frequently results are written out; the number of steps per dump.

classmethod biaxial(total_time, num_increments, direction, target_def_grad=None, target_def_grad_rate=None, dump_frequency=1)#

Generate a biaxial load step.

Parameters:

total_time (int | float) – Total simulation time.
num_increments (int) – Number of simulation increments.
direction (str) – String of two characters, ij, where {i,j} ∈ {“x”,”y”,”z”}, corresponding to the two loading directions.
target_def_grad (float | None) – Target deformation gradient to achieve along both loading direction components.
target_def_grad_rate (float | None) – Target deformation gradient rate to achieve along both loading direction components.
dump_frequency (int) – By default, 1, meaning results are written out every increment.

Return type:

Self

direction#: Direction or directions in which loading is done.

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_frequency#: How frequently results are written out; the number of steps per dump.

dump_to_HDF5_group(group)#

Write this parameter value to an HDF5 group.

Parameters:: group (Group) –

classmethod example_uniaxial()#

A non-parametrisable example uniaxial load step.

Return type:: Self

property method_args: dict[str, Any]#: The arguments to the factory method used to make this loading step, if known.

property method_name: str | None#: The name of the factory method used to make this loading step, if known. If None, new instances like this one should be made directly.

normal_direction#: Direction of normal vector.

num_increments#: Number of simulation increments.

classmethod planar_2D(total_time, num_increments, normal_direction, target_def_grad=None, target_def_grad_rate=None, dump_frequency=1)#

Generate a planar 2D load case normal to the x-, y-, or z-direction.

Parameters:

total_time (int | float) – Total simulation time.
num_increments (int) – Number of simulation increments.
normal_direction (str) – A single character, “x”, “y” or “z”, representing the loading plane normal direction.
target_def_grad ((nested) list of float or ndarray of shape (2, 2)) – Target deformation gradient components. Either a 2D array, nested list, or a flat list. If passed as a flat list, the first and fourth elements correspond to the normal components of the deformation gradient tensor. The second element corresponds to the first-row, second-column (shear) component and the third element corresponds to the second-row, first-column (shear) component.
target_def_grad_rate ((nested) list of float or ndarray of shape (2, 2)) – Target deformation gradient rate components. Either a 2D array, nested list, or a flat list. If passed as a flat list, the first and fourth elements correspond to the normal components of the deformation gradient rate tensor. The second element corresponds to the first-row, second-column (shear) component and the third element corresponds to the second-row, first-column (shear) component.
dump_frequency (int) – By default, 1, meaning results are written out every increment.

Return type:

Self

classmethod plane_strain(total_time, num_increments, direction, target_def_grad=None, target_def_grad_rate=None, dump_frequency=1, strain_rate_mode=None)#

Generate a plane-strain load step.

Parameters:

total_time (int | float) – Total simulation time.
num_increments (int) – Number of simulation increments.
direction (str) – String of two characters, ij, where {i,j} ∈ {“x”,”y”,”z”}. The first character, i, corresponds to the loading direction and the second, j, corresponds to the zero-strain direction. Zero stress will be specified on the remaining direction.
target_def_grad (float | None) – Target deformation gradient to achieve along the loading direction component.
target_def_grad_rate (float | None) – Target deformation gradient rate to achieve along the loading direction component.
dump_frequency (int) – By default, 1, meaning results are written out every increment.
strain_rate_mode (StrainRateMode | str | None) – One of “def_grad_rate”, “vel_grad”, “vel_grad_approx”. If not specified, default is “def_grad_rate”. Use “vel_grad_approx” for specifying non-mixed boundary conditions.

Return type:

Self

prepare_JSON_dump()#

Prepare this parameter value for serialisation as JSON.

Return type:: dict[str, Any]

classmethod random_2D(total_time, num_increments, normal_direction, target_def_grad_rate=None, target_def_grad=None, dump_frequency=1)#

Generate a random 2D planar load case.

Parameters:

total_time (int | float) – Total simulation time.
num_increments (int) – Number of simulation increments.
normal_direction (str) – A single character, “x”, “y” or “z”, representing the loading plane normal direction.
target_def_grad_rate (float | None) – Maximum target deformation gradient rate component. Components will be sampled randomly in the interval [-target_def_grad_rate, +target_def_grad_rate).
target_def_grad (float | None) – Maximum target deformation gradient component. Components will be sampled randomly in the interval [-target_def_grad, +target_def_grad).
dump_frequency (int) – By default, 1, meaning results are written out every increment.

Return type:

Self

classmethod random_3D(total_time, num_increments, target_def_grad, dump_frequency=1)#

Generate a random 3D case.

Parameters:

total_time (int | float) – Total simulation time.
num_increments (int) – Number of simulation increments.
target_def_grad (float) – Maximum target deformation gradient component. Components will be sampled randomly in the interval [-target_def_grad, +target_def_grad).
dump_frequency (int) – By default, 1, meaning results are written out every increment.

Return type:

Self

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) –

property strain_like_tensor: Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes] | None#: The strain-like tensor, if known.

stress#: Stress tensor.

target_def_grad#: Deformation gradient aim tensor.

target_def_grad_rate#: Deformation gradient rate tensor.

target_vel_grad#: Velocity gradient aim tensor.

to_dict()#

Serialise this parameter value as a dictionary.

Return type:: dict[str, Any]

total_time#: Total simulation time.

property type: str#: More user-friendly access to method name.

classmethod uniaxial(total_time, num_increments, direction, target_def_grad_rate=None, target_def_grad=None, dump_frequency=1)#

Generate a uniaxial load step.

Parameters:

total_time (float | int) – Total simulation time.
num_increments (int) – Number of simulation increments.
direction (str) – A single character, “x”, “y” or “z”, representing the loading direction.
target_def_grad (float) – Target deformation gradient to achieve along the loading direction component.
target_def_grad_rate (float) – Target deformation gradient rate to achieve along the loading direction component.
dump_frequency (int, optional) – By default, 1, meaning results are written out every increment.

Return type:

Self

classmethod uniaxial_cyclic(max_stress, min_stress, cycle_frequency, num_increments_per_cycle, num_cycles, direction, waveform='sine', dump_frequency=1)#

Generate a cyclic stress case.

Parameters:

max_stress (float) – Maximum scalar stress.
min_stress (float) – Minimum scalar stress.
num_increments_per_cycle (int) – Number of simulation increments per cycle.
num_cycles (int) – Total number of cycles.
direction (str) – Direction in which to apply loading
waveform (str) – Waveform of stress cycle. Only sine currently supported.
dump_frequency (int) – By default, 1, meaning results are written out every increment.
cycle_frequency (float) –

Return type:

list[Self]