ContactSimulationModel
Kind: Class
Domain: Simulation handoff
Canonical import: from cadflow import ContactSimulationModel
Signature
class ContactSimulationModel(assembly_id: 'str', surfaces: 'tuple[SurfaceRegion, ...]' = (), contact_laws: 'tuple[SurfaceContactLaw, ...]' = (), contact_pairs: 'tuple[SurfaceContactPair, ...]' = (), surface_properties: 'tuple[SurfaceProperty, ...]' = (), materials: 'tuple[MechanicalMaterial, ...]' = (), component_materials: 'dict[str, str]' = <factory>, length_unit: 'str' = 'mm', force_unit: 'str' = 'N', time_unit: 'str' = 's', temperature_unit: 'str' = 'K', metadata: 'dict[str, Any]' = <factory>) -> None
Description
ContactSimulationModel(assembly_id: 'str', surfaces: 'tuple[SurfaceRegion, ...]' = (), contact_laws: 'tuple[SurfaceContactLaw, ...]' = (), contact_pairs: 'tuple[SurfaceContactPair, ...]' = (), surface_properties: 'tuple[SurfaceProperty, ...]' = (), materials: 'tuple[MechanicalMaterial, ...]' = (), component_materials: 'dict[str, str]' = <factory>, length_unit: 'str' = 'mm', force_unit: 'str' = 'N', time_unit: 'str' = 's', temperature_unit: 'str' = 'K', metadata: 'dict[str, Any]' = <factory>)
Other public imports
from cadflow.simulation import ContactSimulationModel
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
assembly_id | 'str' | yes | - | Not explicitly described in the source docstring. |
surfaces | 'tuple[SurfaceRegion, ...]' | no | () | Not explicitly described in the source docstring. |
contact_laws | 'tuple[SurfaceContactLaw, ...]' | no | () | Not explicitly described in the source docstring. |
contact_pairs | 'tuple[SurfaceContactPair, ...]' | no | () | Not explicitly described in the source docstring. |
surface_properties | 'tuple[SurfaceProperty, ...]' | no | () | Not explicitly described in the source docstring. |
materials | 'tuple[MechanicalMaterial, ...]' | no | () | Not explicitly described in the source docstring. |
component_materials | 'dict[str, str]' | no | <factory> | Not explicitly described in the source docstring. |
length_unit | 'str' | no | 'mm' | Not explicitly described in the source docstring. |
force_unit | 'str' | no | 'N' | Not explicitly described in the source docstring. |
time_unit | 'str' | no | 's' | Not explicitly described in the source docstring. |
temperature_unit | 'str' | no | 'K' | 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 |
|---|---|---|
assembly_id | 'str' | required |
surfaces | 'tuple[SurfaceRegion, ...]' | () |
contact_laws | 'tuple[SurfaceContactLaw, ...]' | () |
contact_pairs | 'tuple[SurfaceContactPair, ...]' | () |
surface_properties | 'tuple[SurfaceProperty, ...]' | () |
materials | 'tuple[MechanicalMaterial, ...]' | () |
component_materials | 'dict[str, str]' | factory |
length_unit | 'str' | 'mm' |
force_unit | 'str' | 'N' |
time_unit | 'str' | 's' |
temperature_unit | 'str' | 'K' |
metadata | 'dict[str, Any]' | factory |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
assign_material | method | (self, component_id: 'str', material_id: 'str') -> "'ContactSimulationModel'" | See the member signature. |
from_dict | class method | (cls, value: 'Mapping[str, Any]') -> "'ContactSimulationModel'" | See the member signature. |
from_json | class method | (cls, value: 'str') -> "'ContactSimulationModel'" | See the member signature. |
SCHEMA_VERSION | constant | - | str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str |
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
to_json | method | (self, *, indent: 'int | None' = 2) -> 'str' | See the member signature. |
with_contact_law | method | (self, value: 'SurfaceContactLaw') -> "'ContactSimulationModel'" | See the member signature. |
with_contact_pair | method | (self, value: 'SurfaceContactPair') -> "'ContactSimulationModel'" | See the member signature. |
with_material | method | (self, value: 'MechanicalMaterial') -> "'ContactSimulationModel'" | See the member signature. |
with_surface | method | (self, value: 'SurfaceRegion') -> "'ContactSimulationModel'" | See the member signature. |
with_surface_property | method | (self, value: 'SurfaceProperty') -> "'ContactSimulationModel'" | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import ContactSimulationModel