SurfaceRegion
类型: 类
领域: 仿真交接
推荐导入: from cadflow import SurfaceRegion
签名
class SurfaceRegion(surface_id: 'str', component_id: 'str', geometry_refs: 'tuple[GeometryRef, ...]', role: 'SurfaceRole | str' = <SurfaceRole.CONTACT: 'contact'>, property_id: 'str | None' = None, metadata: 'dict[str, Any]' = <factory>) -> None
功能说明
SurfaceRegion 是 CadFlow 仿真交接领域的公共类。
原始 API 说明
A named set of replayable component-local BREP faces.
其他公共导入路径
from cadflow.simulation import SurfaceRegion
参数
| 名称 | 类型 | 必需 | 默认值 | 源码说明 |
|---|---|---|---|---|
surface_id | 'str' | 是 | - | 源码 Docstring 未单独说明。 |
component_id | 'str' | 是 | - | 源码 Docstring 未单独说明。 |
geometry_refs | 'tuple[GeometryRef, ...]' | 是 | - | 源码 Docstring 未单独说明。 |
role | 'SurfaceRole | str' | 否 | <SurfaceRole.CONTACT: 'contact'> | 源码 Docstring 未单独说明。 |
property_id | 'str | None' | 否 | None | 源码 Docstring 未单独说明。 |
metadata | 'dict[str, Any]' | 否 | <factory> | 源码 Docstring 未单独说明。 |
返回值
类型: None
源码 Docstring 未声明更多返回语义。
异常
源码 Docstring 未声明更窄的异常契约。类型、数值、所有权、路径或后端状态无效时，仍可能抛出相应公共异常。
数据字段
| 名称 | 类型 | 默认值 |
|---|---|---|
surface_id | 'str' | required |
component_id | 'str' | required |
geometry_refs | 'tuple[GeometryRef, ...]' | required |
role | 'SurfaceRole | str' | <SurfaceRole.CONTACT: 'contact'> |
property_id | 'str | None' | None |
metadata | 'dict[str, Any]' | factory |
公共成员
| 成员 | 类型 | 签名 | 说明 |
|---|---|---|---|
from_dict | class method | (cls, value: 'Mapping[str, Any]') -> "'SurfaceRegion'" | 见成员签名。 |
to_dict | method | (self) -> 'dict[str, Any]' | 见成员签名。 |
行为与约束
- 实例是不可变 dataclass 值；更新式工作流会返回替代值。
导入检查
from cadflow import SurfaceRegion