make_surface_region_rsurfaceregion
Kind: Function
Domain: Simulation handoff
Canonical import: from cadflow import make_surface_region_rsurfaceregion
Signature
def make_surface_region_rsurfaceregion(*, surface_id: 'str', component_id: 'str', faces: 'Sequence[Any]' = (), geometry_refs: 'Sequence[GeometryRef]' = (), role: 'SurfaceRole | str' = <SurfaceRole.CONTACT: 'contact'>, property_id: 'str | None' = None, flip: 'bool' = False, metadata: 'Mapping[str, Any] | None' = None) -> 'SurfaceRegion'
Description
Public function in the CadFlow simulation handoff API.
Other public imports
from cadflow.simulation import make_surface_region_rsurfaceregion
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
surface_id | 'str' | yes | - | Not explicitly described in the source docstring. |
component_id | 'str' | yes | - | Not explicitly described in the source docstring. |
faces | 'Sequence[Any]' | no | () | Not explicitly described in the source docstring. |
geometry_refs | 'Sequence[GeometryRef]' | no | () | Not explicitly described in the source docstring. |
role | 'SurfaceRole | str' | no | <SurfaceRole.CONTACT: 'contact'> | Not explicitly described in the source docstring. |
property_id | 'str | None' | no | None | Not explicitly described in the source docstring. |
flip | 'bool' | no | False | Not explicitly described in the source docstring. |
metadata | 'Mapping[str, Any] | None' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'SurfaceRegion'
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.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import make_surface_region_rsurfaceregion