gsim 0.0.0__py3-none-any.whl → 0.0.2__py3-none-any.whl

gsim/palace/__init__.py

@@ -4,38 +4,25 @@ This module provides a comprehensive API for setting up and running
 electromagnetic simulations using the Palace solver with gdsfactory components.
 
 Features:
+    - Problem-specific simulation classes (DrivenSim, EigenmodeSim, ElectrostaticSim)
     - Layer stack extraction from PDK
     - Port configuration (inplane, via, CPW)
     - Mesh generation with COMSOL-style presets
     - Palace config file generation
 
 Usage:
-    from gsim.palace import (
-        get_stack, configure_inplane_port, configure_via_port,
-        extract_ports, generate_mesh
-    )
-
-    # 1. Get layer stack from active PDK
-    stack = get_stack()
-
-    # 2. Configure ports on component
-    # Inplane port (horizontal, on single layer - for CPW gaps)
-    configure_inplane_port(c.ports['o1'], layer='topmetal2', length=5.0)
-    configure_inplane_port(c.ports['o2'], layer='topmetal2', length=5.0)
-
-    # Via port (vertical, between two layers - for microstrip feed)
-    configure_via_port(c.ports['feed'], from_layer='metal1', to_layer='topmetal2')
-
-    # 3. Extract configured ports
-    ports = extract_ports(c, stack)
-
-    # 4. Generate mesh
-    result = generate_mesh(
-        component=c,
-        stack=stack,
-        ports=ports,
-        output_dir="./simulation",
-    )
+    from gsim.palace import DrivenSim
+
+    # Create and configure simulation
+    sim = DrivenSim()
+    sim.set_geometry(component)
+    sim.set_stack(air_above=300.0)
+    sim.add_cpw_port("P2", "P1", layer="topmetal2", length=5.0)
+    sim.set_driven(fmin=1e9, fmax=100e9)
+
+    # Generate mesh and run
+    sim.mesh("./sim", preset="fine")
+    results = sim.simulate()
 """
 
 from __future__ import annotations
@@ -44,6 +31,16 @@ from functools import partial
 
 from gsim.gcloud import print_job_summary
 from gsim.gcloud import run_simulation as _run_simulation
+
+# Common components (shared with FDTD)
+from gsim.common import Geometry, LayerStack, Stack
+
+# New simulation classes (composition, no inheritance)
+from gsim.palace.driven import DrivenSim
+from gsim.palace.eigenmode import EigenmodeSim
+from gsim.palace.electrostatic import ElectrostaticSim
+
+# Mesh utilities
 from gsim.palace.mesh import (
     GroundPlane,
     MeshConfig,
@@ -51,6 +48,27 @@ from gsim.palace.mesh import (
     MeshResult,
     generate_mesh,
 )
+
+# Models (new submodule)
+from gsim.palace.models import (
+    CPWPortConfig,
+    DrivenConfig,
+    EigenmodeConfig,
+    ElectrostaticConfig,
+    GeometryConfig,
+    MagnetostaticConfig,
+    MaterialConfig,
+    MeshConfig as MeshConfigModel,
+    NumericalConfig,
+    PortConfig,
+    SimulationResult,
+    TerminalConfig,
+    TransientConfig,
+    ValidationResult,
+    WavePortConfig,
+)
+
+# Port utilities
 from gsim.palace.ports import (
     PalacePort,
     PortGeometry,
@@ -60,13 +78,15 @@ from gsim.palace.ports import (
     configure_via_port,
     extract_ports,
 )
-from gsim.palace.stack import (
+
+# Stack utilities (from common, shared with FDTD)
+from gsim.common.stack import (
     MATERIALS_DB,
     Layer,
     LayerStack,
     MaterialProperties,
     StackLayer,
-    ValidationResult,
+    ValidationResult as StackValidationResult,
     extract_from_pdk,
     extract_layer_stack,
     get_material_properties,
@@ -79,40 +99,71 @@ from gsim.palace.stack import (
     print_stack,
     print_stack_table,
 )
+
+# Visualization
 from gsim.viz import plot_mesh
 
+
 __all__ = [
+    # Primary simulation classes (new API)
+    "DrivenSim",
+    "EigenmodeSim",
+    "ElectrostaticSim",
+    # Common components (shared with FDTD)
+    "Geometry",
+    "Stack",
+    # Problem configs
+    "DrivenConfig",
+    "EigenmodeConfig",
+    "ElectrostaticConfig",
+    "MagnetostaticConfig",
+    "TransientConfig",
+    # Port configs
+    "CPWPortConfig",
+    "PortConfig",
+    "TerminalConfig",
+    "WavePortConfig",
+    # Other configs
+    "GeometryConfig",
+    "MaterialConfig",
+    "MeshConfigModel",
+    "NumericalConfig",
+    "SimulationResult",
+    "ValidationResult",
+    # Stack utilities
     "MATERIALS_DB",
-    "GroundPlane",
     "Layer",
     "LayerStack",
     "MaterialProperties",
+    "extract_from_pdk",
+    "extract_layer_stack",
+    "get_material_properties",
+    "get_stack",
+    "load_stack_yaml",
+    "material_is_conductor",
+    "material_is_dielectric",
+    "parse_layer_stack",
+    "plot_stack",
+    "print_stack",
+    "print_stack_table",
+    # Mesh utilities
+    "GroundPlane",
     "MeshConfig",
     "MeshPreset",
     "MeshResult",
+    "generate_mesh",
+    "plot_mesh",
+    # Port utilities
     "PalacePort",
     "PortGeometry",
     "PortType",
     "StackLayer",
-    "ValidationResult",
     "configure_cpw_port",
     "configure_inplane_port",
     "configure_via_port",
-    "extract_from_pdk",
-    "extract_layer_stack",
     "extract_ports",
-    "generate_mesh",
-    "get_material_properties",
-    "get_stack",
-    "load_stack_yaml",
-    "material_is_conductor",
-    "material_is_dielectric",
-    "parse_layer_stack",
-    "plot_mesh",
-    "plot_stack",
+    # Cloud
     "print_job_summary",
-    "print_stack",
-    "print_stack_table",
     "run_simulation",
 ]
 

gsim/palace/base.py

@@ -0,0 +1,68 @@
+"""Base mixin for Palace simulation classes.
+
+Provides common visualization methods shared across all simulation types.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    pass
+
+
+class PalaceSimMixin:
+    """Mixin providing common methods for all Palace simulation classes.
+
+    Requires the class to have:
+        - _output_dir: Path | None (private attribute)
+    """
+
+    _output_dir: Path | None
+
+    def plot_mesh(
+        self,
+        output: str | Path | None = None,
+        show_groups: list[str] | None = None,
+        interactive: bool = True,
+    ) -> None:
+        """Plot the mesh wireframe using PyVista.
+
+        Requires mesh() to be called first.
+
+        Args:
+            output: Output PNG path (only used if interactive=False)
+            show_groups: List of group name patterns to show (None = all).
+                Example: ["metal", "P"] to show metal layers and ports.
+            interactive: If True, open interactive 3D viewer.
+                If False, save static PNG to output path.
+
+        Raises:
+            ValueError: If output_dir not set or mesh file doesn't exist
+
+        Example:
+            >>> sim.mesh(preset="default")
+            >>> sim.plot_mesh(show_groups=["metal", "P"])
+        """
+        from gsim.viz import plot_mesh as _plot_mesh
+
+        if self._output_dir is None:
+            raise ValueError("Output directory not set. Call set_output_dir() first.")
+
+        mesh_path = self._output_dir / "palace.msh"
+        if not mesh_path.exists():
+            raise ValueError(
+                f"Mesh file not found: {mesh_path}. Call mesh() first."
+            )
+
+        # Default output path if not interactive
+        if output is None and not interactive:
+            output = self._output_dir / "mesh.png"
+
+        _plot_mesh(
+            msh_path=mesh_path,
+            output=output,
+            show_groups=show_groups,
+            interactive=interactive,
+        )