Simulation handoff

Surface regions, mechanical materials, contact laws, validation, analysis evidence, and solver packages.

This catalog contains 22 public symbols. Select a symbol for its exact signature, parameters, return contract, errors, members, aliases, and behavior notes.

Modules

Symbol	Import	Summary
simulation	from cadflow import simulation	Solver-neutral surface contact semantics and native BREP evidence.

Classes

Symbol	Import	Summary
ContactSimulationAnalysis	from cadflow import ContactSimulationAnalysis	ContactSimulationAnalysis(backend: 'str', validation: 'ContactSimulationValidationReport', resolved_surfaces: 'tuple[dict[str, Any], ...]', pair_metrics: 'tuple[dict[str, Any], ...]')
ContactSimulationIssue	from cadflow import ContactSimulationIssue	ContactSimulationIssue(severity: 'str', code: 'str', path: 'str', message: 'str')
ContactSimulationModel	from cadflow import ContactSimulationModel	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>)
ContactSimulationValidationReport	from cadflow import ContactSimulationValidationReport	ContactSimulationValidationReport(valid: 'bool', issues: 'tuple[ContactSimulationIssue, ...]' = ())
MechanicalMaterial	from cadflow import MechanicalMaterial	Isotropic structural material in the owning model's explicit units.
SurfaceContactLaw	from cadflow import SurfaceContactLaw	Distributed traction/separation law; penalty units are force/length^3.
SurfaceContactPair	from cadflow import SurfaceContactPair	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>)
SurfaceProperty	from cadflow import SurfaceProperty	Intrinsic properties of one manufactured surface, not a surface pair.
SurfaceRegion	from cadflow import SurfaceRegion	A named set of replayable component-local BREP faces.

Enums

Symbol	Import	Summary
FrictionModel	from cadflow import FrictionModel	An enumeration.
NormalContactModel	from cadflow import NormalContactModel	An enumeration.
SlidingFormulation	from cadflow import SlidingFormulation	An enumeration.
SurfaceRole	from cadflow import SurfaceRole	An enumeration.

Functions

Symbol	Import	Summary
analyze_contact_simulation_model_rcontactsimulationanalysis	from cadflow import analyze_contact_simulation_model_rcontactsimulationanalysis	Public function in this domain.
export_contact_simulation_json_rpath	from cadflow import export_contact_simulation_json_rpath	Public function in this domain.
export_contact_simulation_package_rpath	from cadflow import export_contact_simulation_package_rpath	Write a neutral manifest plus component-local BREP files for every face.
geometry_ref_from_face	from cadflow import geometry_ref_from_face	Create a replayable geometric face reference from a public Face.
import_contact_simulation_json_rcontactsimulationmodel	from cadflow import import_contact_simulation_json_rcontactsimulationmodel	Public function in this domain.
make_contact_simulation_model_rcontactsimulationmodel	from cadflow import make_contact_simulation_model_rcontactsimulationmodel	Public function in this domain.
make_surface_region_rsurfaceregion	from cadflow import make_surface_region_rsurfaceregion	Public function in this domain.
validate_contact_simulation_model_rcontactsimulationvalidationreport	from cadflow import validate_contact_simulation_model_rcontactsimulationvalidationreport	Public function in this domain.