Stress¶

class Stress(value: float | int, unit: str)¶

Bases: UnitBase

Stress object.

Attributes¶

unitstr: Symbol of the unit of measurement for stress.
valuefloat or int: Stress numerical value.

Methods¶

to(): It converts actual value to a new value computed using target_unit as the reference unit of measurement.

to(target_unit: str, inplace: bool = False) → Stress¶

It converts actual value to a new value computed using target_unit as the reference unit of measurement.

If inplace is True, it overrides actual value and unit, otherwise it returns a new instance with the converted value and the target_unit as unit.

Parameters¶

target_unitstr: Target unit to which convert the current value.
inplacebool, optional: Whether to override the current instance value. Default is False, so it does not override the current value.

Returns¶

Stress: Converted stress.

Raises

TypeError

If target_unit is not a str,
if inplace is not a bool.

KeyError

If the target_unit is not among available ones.

Examples

Stress instantiation.

>>> from gearpy.units import Stress
>>> s = Stress(1, 'GPa')
>>> s
... 1 GPa

Conversion from giga-pascal to mega-pascal with inplace = False by default, so it does not override the current value.

>>> s.to('MPa')
... 1000.0 MPa
>>> s
... 1 GPa

Conversion from giga-pascal to mega-pascal with inplace = True, in order to override the current value.

>>> s.to('MPa', inplace = True)
... 1000.0 MPa
>>> s
... 1000.0 MPa

property unit: str¶

Symbol of the unit of measurement for stress. It must be a str. Available units are:

'Pa' for pascal,
'kPa' for kilo-pascal,
'MPa' for mega-pascal,
'GPa' for giga-pascal.

Returns¶

str: Symbol of the unit of measurement for stress.

Raises

TypeError: If unit is not a str.
KeyError: If the unit is not among available ones.

property value: float | int¶

Stress numerical value. The relative unit is expressed by the unit property.

Returns¶

float or int: Stress numerical value.

Raises

TypeError: If value is not a float or an int.