Skip to content

Refactor/phase#142

Open
chemiskyy wants to merge 9 commits into
mainfrom
refactor/phase
Open

Refactor/phase#142
chemiskyy wants to merge 9 commits into
mainfrom
refactor/phase

Conversation

@chemiskyy
Copy link
Copy Markdown
Member

This pull request introduces a new CAD backend for the project, replacing CadQuery with direct OCP (OpenCASCADE) calls through the new microgen.cad subpackage. The changes refactor example scripts to use the new CAD interface and add a comprehensive set of CAD utilities and primitives. The update also ensures that the CAD backend is an optional dependency, loaded only when needed, and provides user-friendly error messages if the dependency is missing.

The most important changes are:

Introduction of the new CAD backend:

  • Added the microgen.cad subpackage, which provides a direct OCP-based CAD backend as a replacement for CadQuery. This includes a new CadShape wrapper class, primitive shape builders, STEP file I/O, and various CAD utility functions, all re-exported through microgen/cad/__init__.py.
  • Implemented a user-friendly install gate (require_cad) in microgen/cad/_install.py to check for the optional OCP dependency and provide clear installation instructions if it's missing.

CAD primitives and utility functions:

  • Added a suite of free functions in microgen/cad/primitives.py for creating core parametric primitives (box, sphere, cylinder, capsule, ellipsoid, polyhedron, extruded polygon), all returning CadShape instances.
  • Added STEP file import support via import_step in microgen/cad/io.py, complementing export methods now available on CadShape.

Refactoring of example scripts:

  • Updated all example scripts to use the new Phase.from_cad constructor instead of Phase(shape=...), and to use .cad (instead of .shape) for downstream CAD operations and exports. This ensures compatibility with the new backend and makes use of the new CadShape interface. [1] [2] [3] [4] [5] [6]

These changes modernize the CAD foundation of the codebase, improve modularity and error handling, and pave the way for further CAD-related enhancements.

chemiskyy added 9 commits May 21, 2026 18:52
Make Shape.generate_surface_mesh polymorphic for Box, Sphere and Spinodoid by accepting optional bounds/resolution and falling back to the SDF/marching-cubes path when callers request explicit sampling. Add BoundsType imports and update docstrings to explain the behavior. Remove the legacy rotate_pv_euler function and its export from operations/__init__ (cleanup of Euler helper). Tidy Rve by removing unused is_matrix/matrix_number defaults. Expose new TPMS-related classes (GradedInfill, Sweep) in shape exports and update __all__ accordingly. Add a lint test (tests/test_no_top_level_ocp_imports.py) to prevent top-level OCP imports outside the CAD boundary.
Make Rve a frozen dataclass with validated inputs and explicit pbc flags. Introduce helper validators, cached min_point/max_point and a cached box property (lazy CAD box creation). Add Rve.grid(...) to produce a pyvista.StructuredGrid with flexible resolution handling. Improve __repr__ and update from_min_max to accept pbc. Expand tests to cover pbc behavior, immutability, min/max consistency, grid generation, invalid inputs, and repr content.
Introduce shared shape type aliases and an intrinsic period attribute, and add a generic CAD bridge and periodic-shell sewing.

- Add microgen/shape/_types.py with Field, BoundsType and PeriodType aliases to centralize type defs.
- Add microgen/shape/periodic_shell.py: mesh_to_periodic_shell builds sewn OCCT shells with planar cap faces for periodic meshes.
- Add shape_to_cad in microgen/cad.py: generic fallback to build a tessellated CadShape from an implicit Shape.
- Update microgen/shape/shape.py: import shared types, add Shape.period property, and delegate default generate_cad to shape_to_cad.
- Update Tpms and Spinodoid to set their intrinsic _period and reuse mesh_to_periodic_shell; remove duplicated periodic-sewing code.
- Add tests/tests_shapes/test_shape_period.py to verify period behavior and periodicity for Tpms/Spinodoid.

These changes centralize type annotations, avoid duplicated sewing logic, and expose intrinsic periodicity as a data-structure invariant used by TPMS/Spinodoid shapes. The periodic shell code requires the optional CAD backend.
Replace the single monolithic microgen/cad.py with a microgen.cad subpackage. The functionality has been split across new modules: __init__.py, _install.py, io.py, meshbridge.py, primitives.py, shape.py and topo.py to isolate responsibilities and enable lazy OCP imports (OCP remains an optional dependency). Tests were updated to reflect the package layout (no top-level OCP import). This reorganization improves maintainability and ensures import-time safety when OCP is not installed.
Introduce shared shape type aliases and an intrinsic period attribute, and add a generic CAD bridge and periodic-shell sewing.

- Add microgen/shape/_types.py with Field, BoundsType and PeriodType aliases to centralize type defs.
- Add microgen/shape/periodic_shell.py: mesh_to_periodic_shell builds sewn OCCT shells with planar cap faces for periodic meshes.
- Add shape_to_cad in microgen/cad.py: generic fallback to build a tessellated CadShape from an implicit Shape.
- Update microgen/shape/shape.py: import shared types, add Shape.period property, and delegate default generate_cad to shape_to_cad.
- Update Tpms and Spinodoid to set their intrinsic _period and reuse mesh_to_periodic_shell; remove duplicated periodic-sewing code.
- Add tests/tests_shapes/test_shape_period.py to verify period behavior and periodicity for Tpms/Spinodoid.

These changes centralize type annotations, avoid duplicated sewing logic, and expose intrinsic periodicity as a data-structure invariant used by TPMS/Spinodoid shapes. The periodic shell code requires the optional CAD backend.
Replace the single monolithic microgen/cad.py with a microgen.cad subpackage. The functionality has been split across new modules: __init__.py, _install.py, io.py, meshbridge.py, primitives.py, shape.py and topo.py to isolate responsibilities and enable lazy OCP imports (OCP remains an optional dependency). Tests were updated to reflect the package layout (no top-level OCP import). This reorganization improves maintainability and ensures import-time safety when OCP is not installed.
Large refactor of Phase to an implicit-first, CAD-optional design (Phase 2.0). Introduced Phase.from_cad/from_shape/from_mesh, lazy cad materialisation (.cad), piece extraction, PyVista-backed grid/mesh views, cached moments (center_of_mass, inertia_matrix), and immutable transform methods. Updated mesh/operations/periodic code to use the new Phase API (use phase.cad, Phase.from_cad, and new helpers), added _split_cad_in_grid and improved raster/repeat logic. Added _phase_solid_count in mesh to correctly account for CAD solids. Updated many examples and tests to match the new API and added a new test (tests/test_phase_pieces.py). Overall: unify implicit and CAD workflows, isolate CAD seam, and make Phase behaviour more robust and lazy.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant