Merge pull request #633 from gdsfactory/fix_meshwell

Author: nikosavola

.gitattributes

@@ -0,0 +1,2 @@
+*.gds binary
+*.oas binary

.github/workflows/test_code.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: false
       max-parallel: 12
       matrix:
-        plugin: [femwell, gmsh, meow, sax, tidy3d, klayout, vlsir, path_length_analysis]
+        plugin: [femwell, meow, sax, tidy3d, klayout, vlsir, path_length_analysis]
         os: [ubuntu-latest]
         python-version: [3.12]
         exclude:
@@ -123,7 +123,7 @@ jobs:
         run: |
           palace --help || echo "Palace help failed but container exists"
       - name: Test with pytest
-        run: sudo env "PATH=$PATH" "$(which uv)" run --extra dev --extra gmsh pytest gplugins/palace -v
+        run: sudo env "PATH=$PATH" "$(which uv)" run --extra dev --extra meshwell pytest gplugins/palace -v
 
   test_code_coverage:
     runs-on: ubuntu-latest

.gitignore

@@ -189,3 +189,7 @@ cython_debug/
 *.BAK
 *.sav
 *.plt
+
+# Gmsh
+*.msh
+*.xao

.vscode/settings.json

@@ -0,0 +1 @@
+{"python.defaultInterpreterPath":"python"}

Makefile

@@ -6,7 +6,7 @@ venv:
 
 install:
 	uv venv --python 3.11
-	uv pip install -e .[dev,docs,femwell,gmsh,meow,sax,tidy3d,klayout,vlsir]
+	uv pip install -e .[dev,docs,femwell,meow,sax,tidy3d,klayout,vlsir]
 	uv run pre-commit install
 
 dev: test-data gmsh elmer install
@@ -27,12 +27,12 @@ test:
 	pytest
 
 uv-test:
-	@for plugin in femwell gmsh meow sax tidy3d klayout vlsir path_length_analysis; do \
+	@for plugin in femwell meow sax tidy3d klayout vlsir path_length_analysis; do \
 		uv run pytest gplugins/$$plugin; \
 	done
 
 cov:
-	uv run pytest gplugins/femwell gplugins/gmsh gplugins/meow gplugins/sax gplugins/tidy3d gplugins/klayout gplugins/vlsir gplugins/path_length_analysis --cov=gplugins/femwell --cov=gplugins/gmsh --cov=gplugins/meow --cov=gplugins/sax --cov=gplugins/tidy3d --cov=gplugins/klayout --cov=gplugins/vlsir --cov=gplugins/path_length_analysis
+	uv run pytest gplugins/femwell gplugins/meshwell gplugins/meow gplugins/sax gplugins/tidy3d gplugins/klayout gplugins/vlsir gplugins/path_length_analysis --cov=gplugins/femwell --cov=gplugins/meshwell --cov=gplugins/meow --cov=gplugins/sax --cov=gplugins/tidy3d --cov=gplugins/klayout --cov=gplugins/vlsir --cov=gplugins/path_length_analysis
 
 test-data:
 	git clone https://github.com/gdsfactory/gdsfactory-test-data.git -b test-data test-data

docs/_config.yml

@@ -29,6 +29,8 @@ execute:
     - "*luminescent*"
     - "*pso*"
     - "*mpb*"
+    - "*palace_01_electrostatic*"
+    - "*palace_02_fullwave*"
     # - "*20_schematic_driven_layout*"
     # - "*001_meep_sparameters*"
     # - "*00_tidy3d.ipynb"

docs/api_design.rst

@@ -5,23 +5,14 @@ API Design
 Meshing
 ************************
 
-.. currentmodule:: gplugins.gmsh
+.. currentmodule:: gplugins.meshwell
 
 .. rubric:: Meshing
 
 .. autosummary::
    :toctree: _autosummary/
 
-    get_layer_overlaps_z
-    get_layers_at_z
-    list_unique_layer_stack_z
-    map_unique_layer_stack_z
-    order_layer_stack
-    get_u_bounds_layers
-    get_u_bounds_polygons
-    get_uz_bounds_layers
-    uz_xsection_mesh
-    xy_xsection_mesh
+    get_meshwell_prisms
 
 
 ************************

gplugins/common/base_models/component.py

@@ -87,6 +87,31 @@ def cleanup_component(component, layer_stack, round_tol=2, simplify_tol=1e-2):
     }
 
 
+def cleanup_component_layermap(component, layermap, round_tol=2, simplify_tol=1e-2):
+    """Process component polygons before processing.
+
+    Uses layermap (design layers) names.
+
+    Args:
+        component: gdsfactory component
+        layermap: LayerMap object or dict with layer names as keys
+        round_tol: tolerance for rounding coordinates
+        simplify_tol: tolerance for polygon simplification
+    """
+    layer_dict = vars(layermap) if not isinstance(layermap, dict) else layermap
+
+    return {
+        layer: fuse_polygons(
+            component,
+            layer,
+            round_tol=round_tol,
+            simplify_tol=simplify_tol,
+        )
+        for layername, layer in layer_dict.items()
+        if not layername.startswith("_")  # Skip private attributes
+    }
+
+
 def move_polar_rad_copy(
     pos: Coordinate, angle: float, length: float
 ) -> NDArray[np.float64]:

gplugins/common/utils/get_capacitance.py

@@ -60,7 +60,7 @@ def get_capacitance(
             return run_capacitive_simulation_palace(
                 component,
                 simulation_folder=simulation_folder,
-                simulator_params=simulator_params,
+                solver_config=simulator_params,
                 **kwargs,
             )
         case _:

gplugins/common/utils/get_component_with_net_layers.py

@@ -1,8 +1,10 @@
 import copy
 
 import gdsfactory as gf
+from gdsfactory.technology.layer_stack import DerivedLayer, LayerLevel
+from gdsfactory.typings import Port
 import klayout.db as kdb
-from gdsfactory import Component
+from gdsfactory import Component, LayerEnum
 from gdsfactory.technology import LayerStack, LogicalLayer
 
 
@@ -25,7 +27,9 @@ def get_component_layer_stack(
     layernames_dict = new_layer_stack.get_layer_to_layername()
     layernames_present = [
         name
-        for sublist in [layernames_dict[LogicalLayer(layer=layer)] for layer in layers_present]
+        for sublist in [
+            layernames_dict[LogicalLayer(layer=layer)] for layer in layers_present
+        ]
         for name in sublist
     ]
     for key in list(new_layer_stack.layers.keys()):
@@ -35,6 +39,43 @@ def get_component_layer_stack(
     return new_layer_stack
 
 
+def compare_layerlevel_and_port_layers(layer_level: LayerLevel, port: Port) -> bool:
+    """Compare the layer information between a :class:`~LayerLevel` and a :class:`~Port`.
+
+    Note:
+        If ``layer_level.layer`` is :class:`~LogicalLayer`, ``layer_level.layer`` is used.
+        If ``layer_level.layer`` is :class:`~DerivedLayer`, ``layer_level.derived_layer`` is used.
+
+    Args:
+        layer_level: The LayerLevel object containing layer information
+        port: The Port object containing layer_info with layer and datatype
+
+    Returns:
+        bool: True if the layer and datatype match between both objects
+    """
+
+    port_layer_tuple = (
+        port.layer_info.layer,
+        port.layer_info.datatype,
+    )
+
+    is_derived_layer = isinstance(layer_level.layer, DerivedLayer)
+    if is_derived_layer:
+        layer_level_tuple = (layer_level.derived_layer.layer.layer, layer_level.derived_layer.layer.datatype)
+        return layer_level_tuple == port_layer_tuple
+
+    layer_enum_or_tuple = layer_level.layer.layer
+    if isinstance(layer_enum_or_tuple, tuple):
+        layer_level_tuple = layer_enum_or_tuple
+    else:
+        layer_level_tuple = (
+            layer_enum_or_tuple.layer,
+            layer_enum_or_tuple.datatype,
+        )
+
+    return layer_level_tuple == port_layer_tuple
+
+
 def get_component_with_net_layers(
     component: Component,
     layer_stack: LayerStack,
@@ -56,57 +97,78 @@ def get_component_with_net_layers(
         new_layers_init: initial layer number for the temporary new layers.
         add_to_layerstack: True by default, but can be set to False to disable parsing of the layerstack.
     """
-    # return NotImplementedError(
-    #     "Meshing component with net layers not implemented in gdsfactory8 yet."
-    # )
 
     # Initialize returned component
     net_component = component.copy()
 
+    new_layerlevels = []
     # For each port to consider, convert relevant polygons
-    for i, portname in enumerate(port_names):
-        port = component.ports[portname]
+    for i, port_name in enumerate(port_names):
+        port = component.ports[port_name]
         # Get original port layer polygons, and modify a new component without that layer
         polygons = (
             net_component.extract(layers=(port.layer,))
             .get_polygons()
             .get(port.layer, [])
         )
-        net_component = net_component.remove_layers(layers=(port.layer,),recursive=False)
+        net_component = net_component.remove_layers(
+            layers=(port.layer,), recursive=False
+        )
         for polygon in polygons:
             # If polygon belongs to port, create a unique new layer, and add the polygon to it
             if polygon.sized(int(3 * gf.kcl.dbu)).inside(
                 kdb.Point(*port.to_itype().center)
             ):
-                # if gdstk.inside(
-                #     [port.center],
-                #     gdstk.offset(gdstk.Polygon(polygon), gf.get_active_pdk().grid_size),
-                # )[0]:
                 try:
-                    port_layernames = layer_stack.get_layer_to_layername()[
-                        LogicalLayer(layer=port.layer)
+                    derived_layerlevels_touching_port = [
+                        e
+                        for e in layer_stack.layers.values()
+                        if e.derived_layer is not None
+                        and e not in new_layerlevels
+                        and compare_layerlevel_and_port_layers(e, port)
                     ]
+                    logical_layerlevels_touching_port = [
+                        e
+                        for e in layer_stack.layers.values()
+                        if not isinstance(
+                            e.layer, gf.technology.layer_stack.DerivedLayer
+                        )
+                        and e not in new_layerlevels
+                        and compare_layerlevel_and_port_layers(e, port)
+                    ]
+
+                    layerlevels_touching_port = (
+                        derived_layerlevels_touching_port
+                        + logical_layerlevels_touching_port
+                    )
                 except KeyError as e:
                     raise KeyError(
                         "Make sure your `layer_stack` contains all layers with ports"
                     ) from e
-                for j, old_layername in enumerate(port_layernames):
+
+                for j, old_layerlevel in enumerate(layerlevels_touching_port):
                     new_layer_number = (
                         new_layers_init[0] + i,
                         new_layers_init[1] + j,
                     )
                     if add_to_layerstack:
-                        new_layer = copy.deepcopy(layer_stack.layers[old_layername])
-                        new_layer.layer = LogicalLayer(
+                        # new_layer = copy.deepcopy(layer_stack.layers[old_layerlevel])
+                        new_layerlevel = copy.deepcopy(old_layerlevel)
+                        new_layerlevel.layer = LogicalLayer(
                             layer=(
                                 new_layers_init[0] + i,
                                 new_layers_init[1] + j,
                             )
                         )
-                        new_layer.name = f"{old_layername}{delimiter}{portname}"
-                        layer_stack.layers[f"{old_layername}{delimiter}{portname}"] = (
-                            new_layer
+                        new_layerlevel.name = (
+                            f"{old_layerlevel.name}{delimiter}{port_name}"
                         )
+                        # Increase mesh order to ensure new layer is on top old
+                        new_layerlevel.mesh_order = old_layerlevel.mesh_order - 1
+                        layer_stack.layers[
+                            f"{old_layerlevel.name}{delimiter}{port_name}"
+                        ] = new_layerlevel
+                        new_layerlevels.append(new_layerlevel)
                     net_component.add_polygon(polygon, layer=new_layer_number)
             # Otherwise put the polygon back on the same layer
             else: