SurfaceContactLaw
Kind: Class
Domain: Simulation handoff
Canonical import: from cadflow import SurfaceContactLaw
Signature
class SurfaceContactLaw(law_id: 'str', normal_model: 'NormalContactModel | str' = <NormalContactModel.HARD: 'hard'>, allow_separation: 'bool' = True, normal_penalty_stiffness: 'float | None' = None, pressure_overclosure: 'tuple[tuple[float, float], ...]' = (), friction_model: 'FrictionModel | str' = <FrictionModel.FRICTIONLESS: 'frictionless'>, friction_coefficient: 'float' = 0.0, tangential_penalty_stiffness: 'float | None' = None, normal_damping_per_area: 'float' = 0.0, cohesive_tensile_strength: 'float | None' = None, cohesive_shear_strength: 'float | None' = None, metadata: 'dict[str, Any]' = <factory>) -> None
Description
Distributed traction/separation law; penalty units are force/length^3.
Other public imports
from cadflow.simulation import SurfaceContactLaw
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
law_id | 'str' | yes | - | Not explicitly described in the source docstring. |
normal_model | 'NormalContactModel | str' | no | <NormalContactModel.HARD: 'hard'> | Not explicitly described in the source docstring. |
allow_separation | 'bool' | no | True | Not explicitly described in the source docstring. |
normal_penalty_stiffness | 'float | None' | no | None | Not explicitly described in the source docstring. |
pressure_overclosure | 'tuple[tuple[float, float], ...]' | no | () | Not explicitly described in the source docstring. |
friction_model | 'FrictionModel | str' | no | <FrictionModel.FRICTIONLESS: 'frictionless'> | Not explicitly described in the source docstring. |
friction_coefficient | 'float' | no | 0.0 | Not explicitly described in the source docstring. |
tangential_penalty_stiffness | 'float | None' | no | None | Not explicitly described in the source docstring. |
normal_damping_per_area | 'float' | no | 0.0 | Not explicitly described in the source docstring. |
cohesive_tensile_strength | 'float | None' | no | None | Not explicitly described in the source docstring. |
cohesive_shear_strength | '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 |
|---|---|---|
law_id | 'str' | required |
normal_model | 'NormalContactModel | str' | <NormalContactModel.HARD: 'hard'> |
allow_separation | 'bool' | True |
normal_penalty_stiffness | 'float | None' | None |
pressure_overclosure | 'tuple[tuple[float, float], ...]' | () |
friction_model | 'FrictionModel | str' | <FrictionModel.FRICTIONLESS: 'frictionless'> |
friction_coefficient | 'float' | 0.0 |
tangential_penalty_stiffness | 'float | None' | None |
normal_damping_per_area | 'float' | 0.0 |
cohesive_tensile_strength | 'float | None' | None |
cohesive_shear_strength | 'float | None' | None |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, value: 'Mapping[str, Any]') -> "'SurfaceContactLaw'" | 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 SurfaceContactLaw