MechanicalMaterial
Kind: Class
Domain: Simulation handoff
Canonical import: from cadflow import MechanicalMaterial
Signature
class MechanicalMaterial(material_id: 'str', youngs_modulus: 'float', poisson_ratio: 'float', density: 'float | None' = None, yield_stress: 'float | None' = None, thermal_expansion: 'float | None' = None, metadata: 'dict[str, Any]' = <factory>) -> None
Description
Isotropic structural material in the owning model's explicit units.
Other public imports
from cadflow.simulation import MechanicalMaterial
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
material_id | 'str' | yes | - | Not explicitly described in the source docstring. |
youngs_modulus | 'float' | yes | - | Not explicitly described in the source docstring. |
poisson_ratio | 'float' | yes | - | Not explicitly described in the source docstring. |
density | 'float | None' | no | None | Not explicitly described in the source docstring. |
yield_stress | 'float | None' | no | None | Not explicitly described in the source docstring. |
thermal_expansion | 'float | None' | no | None | Not explicitly described in the source docstring. |
metadata | 'dict[str, Any]' | no | <factory> | Not explicitly described in the source docstring. |
Returns
Type: None
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Data fields
| Name | Type | Default |
|---|---|---|
material_id | 'str' | required |
youngs_modulus | 'float' | required |
poisson_ratio | 'float' | required |
density | 'float | None' | None |
yield_stress | 'float | None' | None |
thermal_expansion | 'float | None' | None |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, value: 'Mapping[str, Any]') -> "'MechanicalMaterial'" | See the member signature. |
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import MechanicalMaterial