Bases: PalaceSimMixin, BaseModel

Frequency-domain driven simulation for S-parameter extraction.

This class configures and runs driven simulations that sweep through frequencies to compute S-parameters. Uses composition (no inheritance) with shared Geometry and Stack components from gsim.common.

Attributes:

• geometry (Geometry | None) –

  Wrapped gdsfactory Component (from common)

• stack (LayerStack | None) –

  Layer stack configuration (from common)

• ports (list[PortConfig]) –

  List of single-element port configurations

• cpw_ports (list[CPWPortConfig]) –

  List of CPW (two-element) port configurations

• driven (DrivenConfig) –

  Driven simulation configuration (frequencies, etc.)

• mesh (SimulationResult) –

  Mesh configuration

• materials (dict[str, MaterialConfig]) –

  Material property overrides

• numerical (NumericalConfig) –

  Numerical solver configuration

Methods:

• set_driven –

  Configure driven (frequency sweep) simulation.

• run –

  Run the driven sim on GDSFactory+ cloud.

set_driven(
    *,
    f: float | None = None,
    fmin: float | None = None,
    fmax: float | None = None,
    num_points: int = 40,
    scale: Literal["linear", "log"] = "linear",
    adaptive_tol: float = 0.02,
    adaptive_max_samples: int = 20,
    compute_s_params: bool = True,
    reference_impedance: float = 50.0,
    excitation_port: str | None = None,
    save_step: int = 0,
    save_fields_at: list[float] | None = None,
    save_freq: str | None = None,
) -> None

run(
    parent_dir: str | Path | None = None,
    *,
    verbose: Literal["quiet", "status", "full"] = "status",
    wait: bool = True,
    check_cache: bool = False,
) -> SParams | str

Bases: PalaceSimMixin, BaseModel

Eigenmode simulation for finding resonant frequencies.

This class configures and runs eigenmode simulations to find resonant frequencies and mode shapes of structures.

Attributes:

• geometry (Geometry | None) –

  Wrapped gdsfactory Component (from common)

• stack (LayerStack | None) –

  Layer stack configuration (from common)

• ports (list[PortConfig]) –

  List of single-element port configurations

• cpw_ports (list[CPWPortConfig]) –

  List of CPW (two-element) port configurations

• eigenmode (EigenmodeConfig) –

  Eigenmode simulation configuration

• materials (dict[str, MaterialConfig]) –

  Material property overrides

• numerical (NumericalConfig) –

  Numerical solver configuration

Methods:

• set_eigenmode –

  Configure eigenmode simulation.

• run –

  Run the eigenmode sim on GDSFactory+ cloud.

set_eigenmode(
    *,
    num_modes: int = 10,
    target: float | None = None,
    tolerance: float = 1e-06,
    save: int = 0,
    floquet: bool = False,
    phi_target: float = pi / 2,
    n_eff_guess: float = 2.0,
) -> None

run(
    parent_dir: str | Path | None = None,
    *,
    verbose: Literal["quiet", "status", "full"] = "status",
    wait: bool = True,
    check_cache: bool = False,
) -> dict[str, Path] | str

Bases: PalaceSimMixin, BaseModel

Electrostatic simulation for capacitance matrix extraction.

This class configures and runs electrostatic simulations to extract the capacitance matrix between conductor terminals. Unlike driven and eigenmode simulations, this does not use ports.

Attributes:

• geometry (Geometry | None) –

  Wrapped gdsfactory Component (from common)

• stack (LayerStack | None) –

  Layer stack configuration (from common)

• terminals (list[TerminalConfig]) –

  List of terminal configurations

• electrostatic (ElectrostaticConfig) –

  Electrostatic simulation configuration

• materials (dict[str, MaterialConfig]) –

  Material property overrides

• numerical (NumericalConfig) –

  Numerical solver configuration

Methods:

• set_electrostatic –

  Configure electrostatic simulation.

• add_terminal –

  Add a terminal for capacitance extraction.

• nets –

  Find the electrically connected conductor shapes of the geometry.

• load_capacitance –

  Load the capacitance matrices of a run, labelled with the terminals.

set_electrostatic(*, save_fields: int = 0) -> None

add_terminal(name: str, *, layer: str) -> None

nets() -> Nets

load_capacitance(results: dict[str, Path] | str | Path) -> CapacitanceMatrices

The capacitance matrices of an electrostatic run, labelled by terminal.

Attributes:

• terminals (tuple[str, ...]) –

  Terminal names, in Palace's index order.

• maxwell (NDArray[float64]) –

  Maxwell capacitance matrix, in F.

• mutual (NDArray[float64]) –

  Mutual capacitance matrix, in F, as Palace writes it.

• inverse (NDArray[float64] | None) –

  Inverse of the Maxwell matrix, in 1/F, when Palace wrote it.

• excitation_voltage (NDArray[float64] | None) –

  Voltage applied in each excitation, in V.

• stored_energy (NDArray[float64] | None) –

  Electric energy of each excitation, in J.

Methods:

• between –

  Capacitance between two electrodes, in F (their mutual capacitance).

• to_ground –

  Capacitance of an electrode to ground, in F.

• maxwell_frame –

  The Maxwell matrix as a DataFrame indexed by terminal name.

• mutual_frame –

  The mutual matrix as a DataFrame indexed by terminal name.

• problems –

  List what is inconsistent in the matrices; empty when they hold together.

between(first: str, second: str) -> float

to_ground(name: str) -> float

maxwell_frame() -> DataFrame

mutual_frame() -> DataFrame

problems(rtol: float = 0.001) -> list[str]

Bases: BaseModel

Configuration for mesh generation with quality presets.

Attributes:

• refined_mesh_size (float) –

  Mesh size near conductors (um)

• max_mesh_size (float) –

  Maximum mesh size in air/dielectric (um)

• cells_per_wavelength (int) –

  Number of mesh cells per wavelength

• margin (float) –

  XY margin around design (um)

• margin_x (float | None) –

  X-axis margin override (um). Falls back to margin.

• margin_y (float | None) –

  Y-axis margin override (um). Falls back to margin.

• airbox_margin (float) –

  Extra airbox around stack (um); 0 = disabled

• fmax (float) –

  Maximum frequency for mesh sizing (Hz)

• boundary_conditions (list[str] | None) –

  List of boundary conditions for each face

• planar_conductors (bool) –

  Treat conductors as 2D PEC surfaces instead of volumes

• algorithm_3d (Literal['delaunay', 'hxt']) –

  Gmsh 3D meshing algorithm, "delaunay" or "hxt". In the 800 um CPW tests behind gsim#283 HXT gave a different mesh and was slower than Delaunay at every thread count.

• threads (int) –

  Threads for 3D meshing. With Delaunay and surface_threads=1 the mesh does not depend on it, and it did not speed meshing up in those tests either. With HXT the mesh depends on the thread count.

• surface_threads (int) –

  Threads for 1D and 2D (surface) meshing. Values above 1 are faster but gave a different mesh on every run, so keep 1 when the mesh must be reproducible.

• show_gui (bool) –

  Show gmsh GUI during meshing

• preview_only (bool) –

  Generate preview only, don't save mesh

Methods:

• coarse –

  Fast mesh for quick iteration (~2.5 elements per wavelength).

• default –

  Balanced mesh (~5 elements per wavelength).

• fine –

  High accuracy mesh (~10 elements per wavelength).

coarse(**kwargs: Any) -> Self

default(**kwargs: Any) -> Self

fine(**kwargs: Any) -> Self

The nets of a layout, in the order their first shape appears.

Attributes:

• nets (tuple[Net, ...]) –

  The nets.

• unmatched_ports (tuple[str, ...]) –

  Names of ports whose centre is on no conductor or via shape with the GDS layer number of the port.

Methods:

• net_at –

  The net under the point (x, y) (um) on a conductor or via layer.

net_at(x: float, y: float, layer: str) -> Net | None

Conductor shapes that are electrically connected.

Attributes:

• name (str) –

  The names of the ports on the net joined by +, or net<k> when it has none, with k its position in the list of nets, counting from 1.

• ports (tuple[str, ...]) –

  Names of the ports whose centre lies on the net.

• members (tuple[tuple[str, int], ...]) –

  (layer name, index) of each shape, where the index is the position of the shape in GeometryData.polygons.

layers: tuple[str, ...]

Bases: BaseModel

Complete layer stack for Palace simulation.

Bases: BaseModel

Layer information for Palace simulation.