SurfaceContactPair
Kind: Class
Domain: Simulation handoff
Canonical import: from cadflow import SurfaceContactPair
Signature
class SurfaceContactPair(pair_id: 'str', surface_a_id: 'str', surface_b_id: 'str', law_id: 'str', initial_clearance: 'float' = 0.0, interference: 'float' = 0.0, search_tolerance: 'float' = 0.0, minimum_opposed_normal_cosine: 'float' = 0.5, sliding: 'SlidingFormulation | str' = <SlidingFormulation.FINITE: 'finite'>, activation_step: 'str | None' = None, metadata: 'dict[str, Any]' = <factory>) -> None
Description
SurfaceContactPair(pair_id: 'str', surface_a_id: 'str', surface_b_id: 'str', law_id: 'str', initial_clearance: 'float' = 0.0, interference: 'float' = 0.0, search_tolerance: 'float' = 0.0, minimum_opposed_normal_cosine: 'float' = 0.5, sliding: 'SlidingFormulation | str' = <SlidingFormulation.FINITE: 'finite'>, activation_step: 'str | None' = None, metadata: 'dict[str, Any]' = <factory>)
Other public imports
from cadflow.simulation import SurfaceContactPair
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
pair_id | 'str' | yes | - | Not explicitly described in the source docstring. |
surface_a_id | 'str' | yes | - | Not explicitly described in the source docstring. |
surface_b_id | 'str' | yes | - | Not explicitly described in the source docstring. |
law_id | 'str' | yes | - | Not explicitly described in the source docstring. |
initial_clearance | 'float' | no | 0.0 | Not explicitly described in the source docstring. |
interference | 'float' | no | 0.0 | Not explicitly described in the source docstring. |
search_tolerance | 'float' | no | 0.0 | Not explicitly described in the source docstring. |
minimum_opposed_normal_cosine | 'float' | no | 0.5 | Not explicitly described in the source docstring. |
sliding | 'SlidingFormulation | str' | no | <SlidingFormulation.FINITE: 'finite'> | Not explicitly described in the source docstring. |
activation_step | 'str | 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 |
|---|---|---|
pair_id | 'str' | required |
surface_a_id | 'str' | required |
surface_b_id | 'str' | required |
law_id | 'str' | required |
initial_clearance | 'float' | 0.0 |
interference | 'float' | 0.0 |
search_tolerance | 'float' | 0.0 |
minimum_opposed_normal_cosine | 'float' | 0.5 |
sliding | 'SlidingFormulation | str' | <SlidingFormulation.FINITE: 'finite'> |
activation_step | 'str | None' | None |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
from_dict | class method | (cls, value: 'Mapping[str, Any]') -> "'SurfaceContactPair'" | 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 SurfaceContactPair