@tscircuit/core 0.0.2119 → 0.0.2121

package/README.md

@@ -55,5 +55,7 @@ circuit.getCircuitJson() // [{ type: "board", ...}, { type: "resistor", ...}, ..
 
 ## Development
 
+- [Declare PCB return-current experiments in TSX](./docs/pcb-return-current-simulation.md)
+
 - [How does core work?](./docs/DEVELOPMENT.md#overview-of-how-core-works)
 - [How to do benchmarking or debug performance](./docs/DEVELOPMENT.md#debugging-performance)

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as circuit_json from 'circuit-json';
-import { PcbGroup, PcbTraceError, PcbPlacementError, PcbManualEditConflictWarning, PcbViaClearanceError, PcbVia as PcbVia$1, LayerRef, AnyCircuitElement, Size, PcbTrace as PcbTrace$1, PcbTraceRoutePoint, AnySourceComponent, SourcePort, PcbComponent, SchematicPort, SchematicComponent, SimulationVoltageSource, SimulationCurrentSource, PcbSilkscreenGraphic, PcbSolderPastePolygon, SourceBus, RouteHintPoint, PcbBoard, SchematicSheet as SchematicSheet$1, SchematicGraphic as SchematicGraphic$1, SimulationExperiment, SimulationParameterSweep, PcbBend as PcbBend$1, PcbStiffener as PcbStiffener$1, PcbSoldermaskOpening as PcbSoldermaskOpening$1, CircuitJson } from 'circuit-json';
+import { PcbGroup, PcbTraceError, PcbPlacementError, PcbManualEditConflictWarning, PcbViaClearanceError, PcbVia as PcbVia$1, LayerRef, AnyCircuitElement, Size, PcbTrace as PcbTrace$1, PcbTraceRoutePoint, AnySourceComponent, SourcePort, PcbComponent, SchematicPort, SchematicComponent, SimulationVoltageSource, SimulationCurrentSource, PcbSilkscreenGraphic, PcbSolderPastePolygon, SourceBus, RouteHintPoint, PcbBoard, SchematicSheet as SchematicSheet$1, SchematicGraphic as SchematicGraphic$1, SimulationExperiment, SimulationParameterSweep, SimulationReturnCurrentExcitation, PcbBend as PcbBend$1, PcbStiffener as PcbStiffener$1, PcbSoldermaskOpening as PcbSoldermaskOpening$1, CircuitJson } from 'circuit-json';
 import * as _tscircuit_props from '@tscircuit/props';
-import { FanoutTracePath, PlatformConfig, autoroutingPhaseProps, traceProps, netProps, AutoroutingPhaseProps, AutorouterProp, subcircuitGroupProps, AutorouterConfig, PcbSx, portProps, PinAttributeMap, SupplierPartNumbers, CadModelProp, SchematicPortArrangement, groupProps, platedHoleProps, BoardOutlinePoint, boardProps, subcircuitProps, subpanelProps, capacitorProps, antennaProps, chipProps, pinoutProps, diodeProps, fuseProps, jumperProps, interconnectProps, solderjumperProps, ledProps, powerSourceProps, voltageSourceProps, currentSourceProps, ammeterProps, resistorProps, constraintProps, drcCheckProps, fabricationNoteRectProps, fabricationNotePathProps, fabricationNoteTextProps, fabricationNoteDimensionProps, pcbNoteLineProps, pcbNoteRectProps, pcbNoteTextProps, pcbNotePathProps, pcbNoteDimensionProps, footprintProps, breakoutProps, breakoutPointProps, holeProps, pcbKeepoutProps, netLabelProps, cadmodelProps, cadassemblyProps, courtyardCircleProps, courtyardOutlineProps, courtyardRectProps, silkscreenCircleProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, silkscreenLineProps, silkscreenGraphicProps, smtPadProps, fiducialProps, busProps, differentialPairProps, traceHintProps, viaProps, copperPourProps, copperTextProps, cutoutProps, assemblyDeviceProps, assemblyMotorProps, assemblyScreenProps, assemblySubassemblyProps, assemblyPartProps, assemblyReferenceSurfaceProps, enclosureCutoutApertureProps, enclosureFdmBoxProps, batteryProps, pinHeaderProps, resonatorProps, inductorProps, potentiometerProps, pushButtonProps, crystalProps, CrystalPinLabels, transistorProps, mosfetProps, opampProps, OpAmpPinLabels, switchProps, SwitchProps, testpointProps, schematicTextProps, schematicLineProps, schematicRectProps, schematicArcProps, schematicCircleProps, schematicPathProps, schematicBoxProps, schematicSymbolProps, schematicSectionProps, schematicSheetProps, schematicGraphicProps, schematicTableProps, schematicRowProps, schematicCellProps, symbolProps, analogSimulationProps, analogTransientSimulationProps, analogDcOperatingPointSimulationProps, analogDcSweepSimulationProps, analogAcSweepSimulationProps, analogSweepParameterProps, voltageProbeProps, spicemodelProps, pcbBendProps, pcbStiffenerProps, pcbSoldermaskOpeningProps, assemblyPrintedPartProps, assemblyCableProps, AnalogTransientSimulationProps, AnalogDcSweepSimulationProps, AnalogAcSweepSimulationProps, AnalogSweepParameterProps, AssemblyCablePropsInput, AssemblySubassemblyPropsInput, AssemblyDevicePropsInput, AssemblyMotorPropsInput, AssemblyPartPropsInput, AssemblyPrintedPartPropsInput, AssemblyScreenPropsInput, EnclosureCutoutApertureProps, EnclosureFdmBoxProps, CapacitorProps, ChipProps, DiodeProps, ResistorProps, ManualEditEvent, ManualEditsFile, ChipConnections, manual_edits_file } from '@tscircuit/props';
+import { FanoutTracePath, PlatformConfig, autoroutingPhaseProps, traceProps, netProps, AutoroutingPhaseProps, AutorouterProp, subcircuitGroupProps, AutorouterConfig, PcbSx, portProps, PinAttributeMap, SupplierPartNumbers, CadModelProp, SchematicPortArrangement, groupProps, platedHoleProps, BoardOutlinePoint, boardProps, subcircuitProps, subpanelProps, capacitorProps, antennaProps, chipProps, pinoutProps, diodeProps, fuseProps, jumperProps, interconnectProps, solderjumperProps, ledProps, powerSourceProps, voltageSourceProps, currentSourceProps, ammeterProps, resistorProps, constraintProps, drcCheckProps, fabricationNoteRectProps, fabricationNotePathProps, fabricationNoteTextProps, fabricationNoteDimensionProps, pcbNoteLineProps, pcbNoteRectProps, pcbNoteTextProps, pcbNotePathProps, pcbNoteDimensionProps, footprintProps, breakoutProps, breakoutPointProps, holeProps, pcbKeepoutProps, netLabelProps, cadmodelProps, cadassemblyProps, courtyardCircleProps, courtyardOutlineProps, courtyardRectProps, silkscreenCircleProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, silkscreenLineProps, silkscreenGraphicProps, smtPadProps, fiducialProps, busProps, differentialPairProps, traceHintProps, viaProps, copperPourProps, copperTextProps, cutoutProps, assemblyDeviceProps, assemblyMotorProps, assemblyScreenProps, assemblySubassemblyProps, assemblyPartProps, assemblyReferenceSurfaceProps, enclosureCutoutApertureProps, enclosureFdmBoxProps, batteryProps, pinHeaderProps, resonatorProps, inductorProps, potentiometerProps, pushButtonProps, crystalProps, CrystalPinLabels, transistorProps, mosfetProps, opampProps, OpAmpPinLabels, switchProps, SwitchProps, testpointProps, schematicTextProps, schematicLineProps, schematicRectProps, schematicArcProps, schematicCircleProps, schematicPathProps, schematicBoxProps, schematicSymbolProps, schematicSectionProps, schematicSheetProps, schematicGraphicProps, schematicTableProps, schematicRowProps, schematicCellProps, symbolProps, analogSimulationProps, analogTransientSimulationProps, analogDcOperatingPointSimulationProps, analogDcSweepSimulationProps, analogAcSweepSimulationProps, analogSweepParameterProps, pcbReturnCurrentSimulationProps, pcbReturnCurrentExcitationProps, voltageProbeProps, spicemodelProps, pcbBendProps, pcbStiffenerProps, pcbSoldermaskOpeningProps, assemblyPrintedPartProps, assemblyCableProps, AnalogTransientSimulationProps, AnalogDcSweepSimulationProps, AnalogAcSweepSimulationProps, AnalogSweepParameterProps, AssemblyCablePropsInput, AssemblySubassemblyPropsInput, AssemblyDevicePropsInput, AssemblyMotorPropsInput, AssemblyPartPropsInput, AssemblyPrintedPartPropsInput, AssemblyScreenPropsInput, EnclosureCutoutApertureProps, EnclosureFdmBoxProps, PcbReturnCurrentSimulationProps, PcbReturnCurrentExcitationProps, CapacitorProps, ChipProps, DiodeProps, ResistorProps, ManualEditEvent, ManualEditsFile, ChipConnections, manual_edits_file } from '@tscircuit/props';
 export { FanoutTracePath, fanoutTracePath, kicadFootprintStrings } from '@tscircuit/props';
 import * as react from 'react';
 import react__default, { ReactElement, ReactNode, Attributes } from 'react';
@@ -2105,9 +2105,9 @@ interface IIsolatedCircuit {
 interface IRootCircuit extends IIsolatedCircuit {
 }
 
-declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "RenderIsolatedSubcircuits", "InflateSubcircuitCircuitJson", "SourceNameDuplicateComponentRemoval", "PcbFootprintStringRender", "FetchPartFootprint", "ResolveFootprintPinLabels", "InitializePortsFromChildren", "CreateNetsFromProps", "AssignFallbackProps", "CreateTracesFromProps", "CreateTracesFromNetLabels", "CreateTraceHintsFromProps", "CreateAutoplacedBreakoutPoints", "SourceGroupRender", "AssignNameToUnnamedComponents", "SourceRender", "CheckRefDesConvention", "SourceComponentPropertyValidation", "SourceParentAttachment", "PortMatching", "OptimizeSelectorCache", "SourceTraceRender", "SourceAddConnectivityMapKey", "SourceDesignRuleChecks", "SimulationRender", "SchematicComponentRender", "SchematicPortRender", "SymbolContainerRender", "SchematicPrimitiveRender", "SchematicSymbolResize", "SchematicComponentSizeCalculation", "SchematicLayout", "SchematicSectionRender", "SchematicTraceRender", "SchematicSheetRender", "SchematicReplaceNetLabelsWithSymbols", "SchematicLabelNetsWithConflictingNames", "PanelBoardLayout", "ValidatePcbCoordinates", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbComponentSizeCalculation", "PcbComponentAnchorAlignment", "PcbCalcPlacementResolution", "PcbLayout", "PcbBoardAutoSize", "PanelLayout", "PcbFlexRender", "PcbAutoplaceBreakoutPoints", "PcbTraceHintRender", "PcbManualTraceRender", "PcbPlacementDesignRuleChecks", "PcbTraceRender", "PcbRouteNetIslands", "PcbTraceTeardropRender", "PcbCopperPourRender", "PcbViaStitchRender", "PcbCopperPourCleanup", "PcbDesignRuleChecks", "SilkscreenOverlapAdjustment", "CadModelRender", "PartsEngineRender", "MissingManufacturerPartNumberWarning", "ComponentAvailabilityWarning", "PartOrientationAnalysis", "SupplierFootprintMismatchWarning", "SimulationSpiceEngineRender"];
+declare const orderedRenderPhases: readonly ["ReactSubtreesRender", "RenderIsolatedSubcircuits", "InflateSubcircuitCircuitJson", "SourceNameDuplicateComponentRemoval", "PcbFootprintStringRender", "FetchPartFootprint", "ResolveFootprintPinLabels", "InitializePortsFromChildren", "CreateNetsFromProps", "AssignFallbackProps", "CreateTracesFromProps", "CreateTracesFromNetLabels", "CreateTraceHintsFromProps", "CreateAutoplacedBreakoutPoints", "SourceGroupRender", "AssignNameToUnnamedComponents", "SourceRender", "CheckRefDesConvention", "SourceComponentPropertyValidation", "SourceParentAttachment", "PortMatching", "OptimizeSelectorCache", "SourceTraceRender", "SourceAddConnectivityMapKey", "SourceDesignRuleChecks", "SimulationRender", "SchematicComponentRender", "SchematicPortRender", "SymbolContainerRender", "SchematicPrimitiveRender", "SchematicSymbolResize", "SchematicComponentSizeCalculation", "SchematicLayout", "SchematicSectionRender", "SchematicTraceRender", "SchematicSheetRender", "SchematicReplaceNetLabelsWithSymbols", "SchematicLabelNetsWithConflictingNames", "PanelBoardLayout", "ValidatePcbCoordinates", "PcbComponentRender", "PcbPrimitiveRender", "PcbFootprintLayout", "PcbPortRender", "PcbPortAttachment", "PcbComponentSizeCalculation", "PcbComponentAnchorAlignment", "PcbCalcPlacementResolution", "PcbLayout", "PcbBoardAutoSize", "PanelLayout", "PcbFlexRender", "PcbAutoplaceBreakoutPoints", "PcbTraceHintRender", "PcbManualTraceRender", "PcbPlacementDesignRuleChecks", "PcbTraceRender", "PcbRouteNetIslands", "PcbTraceTeardropRender", "PcbCopperPourRender", "PcbViaStitchRender", "PcbCopperPourCleanup", "PcbSimulationRender", "PcbDesignRuleChecks", "SilkscreenOverlapAdjustment", "CadModelRender", "PartsEngineRender", "MissingManufacturerPartNumberWarning", "ComponentAvailabilityWarning", "PartOrientationAnalysis", "SupplierFootprintMismatchWarning", "SimulationSpiceEngineRender"];
 type RenderPhase = (typeof orderedRenderPhases)[number];
-declare const renderPhaseIndexMap: Map<"ReactSubtreesRender" | "RenderIsolatedSubcircuits" | "InflateSubcircuitCircuitJson" | "SourceNameDuplicateComponentRemoval" | "PcbFootprintStringRender" | "FetchPartFootprint" | "ResolveFootprintPinLabels" | "InitializePortsFromChildren" | "CreateNetsFromProps" | "AssignFallbackProps" | "CreateTracesFromProps" | "CreateTracesFromNetLabels" | "CreateTraceHintsFromProps" | "CreateAutoplacedBreakoutPoints" | "SourceGroupRender" | "AssignNameToUnnamedComponents" | "SourceRender" | "CheckRefDesConvention" | "SourceComponentPropertyValidation" | "SourceParentAttachment" | "PortMatching" | "OptimizeSelectorCache" | "SourceTraceRender" | "SourceAddConnectivityMapKey" | "SourceDesignRuleChecks" | "SimulationRender" | "SchematicComponentRender" | "SchematicPortRender" | "SymbolContainerRender" | "SchematicPrimitiveRender" | "SchematicSymbolResize" | "SchematicComponentSizeCalculation" | "SchematicLayout" | "SchematicSectionRender" | "SchematicTraceRender" | "SchematicSheetRender" | "SchematicReplaceNetLabelsWithSymbols" | "SchematicLabelNetsWithConflictingNames" | "PanelBoardLayout" | "ValidatePcbCoordinates" | "PcbComponentRender" | "PcbPrimitiveRender" | "PcbFootprintLayout" | "PcbPortRender" | "PcbPortAttachment" | "PcbComponentSizeCalculation" | "PcbComponentAnchorAlignment" | "PcbCalcPlacementResolution" | "PcbLayout" | "PcbBoardAutoSize" | "PanelLayout" | "PcbFlexRender" | "PcbAutoplaceBreakoutPoints" | "PcbTraceHintRender" | "PcbManualTraceRender" | "PcbPlacementDesignRuleChecks" | "PcbTraceRender" | "PcbRouteNetIslands" | "PcbTraceTeardropRender" | "PcbCopperPourRender" | "PcbViaStitchRender" | "PcbCopperPourCleanup" | "PcbDesignRuleChecks" | "SilkscreenOverlapAdjustment" | "CadModelRender" | "PartsEngineRender" | "MissingManufacturerPartNumberWarning" | "ComponentAvailabilityWarning" | "PartOrientationAnalysis" | "SupplierFootprintMismatchWarning" | "SimulationSpiceEngineRender", number>;
+declare const renderPhaseIndexMap: Map<"ReactSubtreesRender" | "RenderIsolatedSubcircuits" | "InflateSubcircuitCircuitJson" | "SourceNameDuplicateComponentRemoval" | "PcbFootprintStringRender" | "FetchPartFootprint" | "ResolveFootprintPinLabels" | "InitializePortsFromChildren" | "CreateNetsFromProps" | "AssignFallbackProps" | "CreateTracesFromProps" | "CreateTracesFromNetLabels" | "CreateTraceHintsFromProps" | "CreateAutoplacedBreakoutPoints" | "SourceGroupRender" | "AssignNameToUnnamedComponents" | "SourceRender" | "CheckRefDesConvention" | "SourceComponentPropertyValidation" | "SourceParentAttachment" | "PortMatching" | "OptimizeSelectorCache" | "SourceTraceRender" | "SourceAddConnectivityMapKey" | "SourceDesignRuleChecks" | "SimulationRender" | "SchematicComponentRender" | "SchematicPortRender" | "SymbolContainerRender" | "SchematicPrimitiveRender" | "SchematicSymbolResize" | "SchematicComponentSizeCalculation" | "SchematicLayout" | "SchematicSectionRender" | "SchematicTraceRender" | "SchematicSheetRender" | "SchematicReplaceNetLabelsWithSymbols" | "SchematicLabelNetsWithConflictingNames" | "PanelBoardLayout" | "ValidatePcbCoordinates" | "PcbComponentRender" | "PcbPrimitiveRender" | "PcbFootprintLayout" | "PcbPortRender" | "PcbPortAttachment" | "PcbComponentSizeCalculation" | "PcbComponentAnchorAlignment" | "PcbCalcPlacementResolution" | "PcbLayout" | "PcbBoardAutoSize" | "PanelLayout" | "PcbFlexRender" | "PcbAutoplaceBreakoutPoints" | "PcbTraceHintRender" | "PcbManualTraceRender" | "PcbPlacementDesignRuleChecks" | "PcbTraceRender" | "PcbRouteNetIslands" | "PcbTraceTeardropRender" | "PcbCopperPourRender" | "PcbViaStitchRender" | "PcbCopperPourCleanup" | "PcbSimulationRender" | "PcbDesignRuleChecks" | "SilkscreenOverlapAdjustment" | "CadModelRender" | "PartsEngineRender" | "MissingManufacturerPartNumberWarning" | "ComponentAvailabilityWarning" | "PartOrientationAnalysis" | "SupplierFootprintMismatchWarning" | "SimulationSpiceEngineRender", number>;
 type RenderPhaseFn<K extends RenderPhase = RenderPhase> = `doInitial${K}` | `update${K}` | `remove${K}`;
 type RenderPhaseStates = Record<RenderPhase, {
     initialized: boolean;
@@ -194771,9 +194771,9 @@ declare class AnalogSimulation extends PrimitiveComponent<typeof analogSimulatio
     doInitialSimulationRender(): void;
 }
 
-type SimulationExperimentId = SimulationExperiment["simulation_experiment_id"];
+type SimulationExperimentId$1 = SimulationExperiment["simulation_experiment_id"];
 declare abstract class AnalogAnalysisSimulation<PropsSchema extends ZodType> extends PrimitiveComponent<PropsSchema> {
-    simulation_experiment_id: SimulationExperimentId | null;
+    simulation_experiment_id: SimulationExperimentId$1 | null;
     protected abstract insertSimulationExperiment(): SimulationExperiment | null;
     getSpiceEngineName(): string | undefined;
     usesIndependentGraphAxes(): boolean;
@@ -195421,6 +195421,100 @@ declare class AnalogSweepParameter extends PrimitiveComponent<typeof analogSweep
     doInitialSimulationRender(): void;
 }
 
+type SimulationExperimentId = SimulationExperiment["simulation_experiment_id"];
+/** Declares a pending experiment; running an EM solver is a separate operation. */
+declare class PcbReturnCurrentSimulation extends PrimitiveComponent<typeof pcbReturnCurrentSimulationProps> {
+    simulation_experiment_id: SimulationExperimentId | null;
+    get config(): {
+        componentName: string;
+        zodProps: zod.ZodObject<{
+            name: zod.ZodOptional<zod.ZodString>;
+            children: zod.ZodOptional<zod.ZodType<react.ReactNode, zod.ZodTypeDef, react.ReactNode>>;
+        }, "strict", zod.ZodTypeAny, {
+            name?: string | undefined;
+            children?: react.ReactNode;
+        }, {
+            name?: string | undefined;
+            children?: react.ReactNode;
+        }>;
+    };
+    doInitialSimulationRender(): void;
+    updateSimulationRender(): void;
+    removeSimulationRender(): void;
+}
+
+type SimulationReturnCurrentExcitationId = SimulationReturnCurrentExcitation["simulation_return_current_excitation_id"];
+/** Resolves user-selected contacts after PCB routing and placement settle. */
+declare class PcbReturnCurrentExcitation extends PrimitiveComponent<typeof pcbReturnCurrentExcitationProps> {
+    simulation_return_current_excitation_id: SimulationReturnCurrentExcitationId | null;
+    get config(): {
+        componentName: string;
+        zodProps: zod.ZodObject<{
+            name: zod.ZodOptional<zod.ZodString>;
+            source: zod.ZodString;
+            load: zod.ZodString;
+            ground: zod.ZodString;
+            current: zod.ZodPipeline<zod.ZodEffects<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, number, string | number>, zod.ZodNumber>;
+            returnSource: zod.ZodString;
+            returnSink: zod.ZodString;
+            sourceImpedance: zod.ZodPipeline<zod.ZodEffects<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, number, string | number>, zod.ZodNumber>;
+            loadImpedance: zod.ZodPipeline<zod.ZodEffects<zod.ZodUnion<[zod.ZodNumber, zod.ZodString]>, number, string | number>, zod.ZodNumber>;
+            trace: zod.ZodOptional<zod.ZodString>;
+            returnSourceLayer: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6", "inner7", "inner8"]>, zod.ZodObject<{
+                name: zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6", "inner7", "inner8"]>;
+            }, "strip", zod.ZodTypeAny, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            }, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            }>]>, "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8", "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            }>>;
+            returnSinkLayer: zod.ZodOptional<zod.ZodEffects<zod.ZodUnion<[zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6", "inner7", "inner8"]>, zod.ZodObject<{
+                name: zod.ZodEnum<["top", "bottom", "inner1", "inner2", "inner3", "inner4", "inner5", "inner6", "inner7", "inner8"]>;
+            }, "strip", zod.ZodTypeAny, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            }, {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            }>]>, "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8", "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            }>>;
+        }, "strict", zod.ZodTypeAny, {
+            source: string;
+            current: number;
+            load: string;
+            ground: string;
+            returnSource: string;
+            returnSink: string;
+            sourceImpedance: number;
+            loadImpedance: number;
+            name?: string | undefined;
+            trace?: string | undefined;
+            returnSourceLayer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | undefined;
+            returnSinkLayer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | undefined;
+        }, {
+            source: string;
+            current: string | number;
+            load: string;
+            ground: string;
+            returnSource: string;
+            returnSink: string;
+            sourceImpedance: string | number;
+            loadImpedance: string | number;
+            name?: string | undefined;
+            trace?: string | undefined;
+            returnSourceLayer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            } | undefined;
+            returnSinkLayer?: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8" | {
+                name: "top" | "bottom" | "inner1" | "inner2" | "inner3" | "inner4" | "inner5" | "inner6" | "inner7" | "inner8";
+            } | undefined;
+        }>;
+    };
+    doInitialPcbSimulationRender(): void;
+    updatePcbSimulationRender(): void;
+    removePcbSimulationRender(): void;
+}
+
 declare class VoltageProbe extends PrimitiveComponent<typeof voltageProbeProps> {
     simulation_voltage_probe_id: string | null;
     schematic_voltage_probe_id: string | null;
@@ -204277,6 +204371,11 @@ declare const enclosure: {
     };
 };
 
+declare const simulation: {
+    readonly pcbreturncurrentsimulation: react.FunctionComponent<PcbReturnCurrentSimulationProps>;
+    readonly pcbreturncurrentexcitation: react.FunctionComponent<PcbReturnCurrentExcitationProps>;
+};
+
 declare function resolveStaticFileImport(path: string, platform?: PlatformConfig): Promise<string>;
 
 declare class RootCircuit extends IsolatedCircuit {
@@ -206014,6 +206113,8 @@ interface TscircuitElements {
     analogdcsweepsimulation: _tscircuit_props.AnalogDcSweepSimulationProps;
     analogacsweepsimulation: _tscircuit_props.AnalogAcSweepSimulationProps;
     analogsweepparameter: _tscircuit_props.AnalogSweepParameterProps;
+    pcbreturncurrentsimulation: _tscircuit_props.PcbReturnCurrentSimulationProps;
+    pcbreturncurrentexcitation: _tscircuit_props.PcbReturnCurrentExcitationProps;
     spicemodel: _tscircuit_props.SpiceModelProps;
     fiducial: _tscircuit_props.FiducialProps;
     jscad: any;
@@ -206036,4 +206137,4 @@ declare module "react/jsx-runtime" {
     }
 }
 
-export { Ammeter, AnalogAcSweepSimulation, AnalogAnalysisSimulation, AnalogDcOperatingPointSimulation, AnalogDcSweepSimulation, AnalogSimulation, AnalogSweepParameter, AnalogTransientSimulation, Antenna, AssemblyCable, type AssemblyCableJsxProps, type AssemblyCadAssemblyJsxProps, AssemblyDevice, type AssemblyDeviceJsxProps, AssemblyMotor, type AssemblyMotorJsxProps, AssemblyPart, type AssemblyPartJsxProps, AssemblyPrintedPart, type AssemblyPrintedPartJsxProps, AssemblyReferenceSurface, AssemblyScreen, type AssemblyScreenJsxProps, AssemblySubassembly, type AssemblySubassemblyJsxProps, type AsyncEffect, type AutorouterCompleteEvent, type AutorouterErrorEvent, type AutorouterEvent, type AutorouterProgressEvent, type AutoroutingCacheDisabledReason, type AutoroutingCacheStatus, type AutoroutingEndEvent, type AutoroutingErrorEvent, type AutoroutingExecutionMetadata, AutoroutingPhase, type AutoroutingProgressEvent, type AutoroutingStartEvent, Battery, Board, Breakout, BreakoutPoint, Bus, CadAssembly, CadModel, Capacitor, Chip, Circuit, type CircuitJsonMetadata, type ComponentWithPins, Connector, Constraint, CopperPour, CopperText, CourtyardCircle, CourtyardOutline, CourtyardRect, Crystal, CurrentSource, Cutout, type DebugLogOutputEvent, DifferentialPair, Diode, DrcCheck, EnclosureCutoutAperture, EnclosureFdmBox, FabricationNoteDimension, FabricationNotePath, FabricationNoteRect, FabricationNoteText, Breakout as Fanout, BreakoutPoint as FanoutPoint, Fiducial, Footprint, Fuse, type GenericConnectionsAndSelectorsSel, type GenericLocalAutorouter, Group, Hole, type IIsolatedCircuit, type IRenderable, type IRootCircuit, Inductor, Interconnect, IsolatedCircuit, Jumper, Keepout, Led, type LocalCacheEngine, Mosfet, MountedBoard, Net, NetLabel, NormalComponent, type Obstacle, OpAmp, type PackingEndEvent, type PackingErrorEvent, type PackingStartEvent, Panel, PcbBend, type PcbGroupId, PcbNoteDimension, PcbNoteLine, PcbNotePath, PcbNoteRect, PcbNoteText, PcbSoldermaskOpening, PcbStiffener, PcbTrace, PcbVia, PinHeader, type PinLabelSpec, Pinout, PlatedHole, Port, Potentiometer, PowerSource, PrimitiveComponent, Project, PushButton, type RenderPhase, type RenderPhaseFn, type RenderPhaseFunctions, type RenderPhaseStates, Renderable, Resistor, Resonator, RootCircuit, type RootCircuitEventName, SOLVERS, SchematicArc, SchematicBox, SchematicCell, SchematicCircle, SchematicGraphic, SchematicLine, SchematicPath, SchematicRect, SchematicRow, SchematicSection, SchematicSheet, SchematicSymbol, SchematicTable, SchematicText, type Sel, SilkscreenCircle, SilkscreenGraphic, SilkscreenLine, SilkscreenPath, SilkscreenRect, SilkscreenText, type SimpleRouteBounds, type SimpleRouteBus, type SimpleRouteBusTermination, type SimpleRouteConnection, type SimpleRouteDifferentialPair, type SimpleRouteJson, type SimpleRoutePoint, type SimplifiedPcbTrace, type SingleLayerConnectionPoint, SmtPad, SolderJumper, type SolverEndedEvent, type SolverName, type SolverStartedEvent, SpiceModel, type SrjConnectionName, Subcircuit, Subpanel, Switch, SymbolComponent as Symbol, TestPoint, Trace, TraceHint, Transistor, Via, VoltageProbe, VoltageSource, analog, applyEditEvents, applyEditEventsToManualEditsFile, applyPcbEditEventsToManualEditsFile, applySchematicEditEventsToManualEditsFile, assembly, createUseComponent, enclosure, getPhaseTimingsFromRenderEvents, getSimpleRouteJsonFromCircuitJson, normalizePinLabels, orderedRenderPhases, renderPhaseIndexMap, resolveStaticFileImport, sel, unrouteCircuitJson, useCapacitor, useChip, useDiode, useLed, useRenderedCircuit, useResistor };
+export { Ammeter, AnalogAcSweepSimulation, AnalogAnalysisSimulation, AnalogDcOperatingPointSimulation, AnalogDcSweepSimulation, AnalogSimulation, AnalogSweepParameter, AnalogTransientSimulation, Antenna, AssemblyCable, type AssemblyCableJsxProps, type AssemblyCadAssemblyJsxProps, AssemblyDevice, type AssemblyDeviceJsxProps, AssemblyMotor, type AssemblyMotorJsxProps, AssemblyPart, type AssemblyPartJsxProps, AssemblyPrintedPart, type AssemblyPrintedPartJsxProps, AssemblyReferenceSurface, AssemblyScreen, type AssemblyScreenJsxProps, AssemblySubassembly, type AssemblySubassemblyJsxProps, type AsyncEffect, type AutorouterCompleteEvent, type AutorouterErrorEvent, type AutorouterEvent, type AutorouterProgressEvent, type AutoroutingCacheDisabledReason, type AutoroutingCacheStatus, type AutoroutingEndEvent, type AutoroutingErrorEvent, type AutoroutingExecutionMetadata, AutoroutingPhase, type AutoroutingProgressEvent, type AutoroutingStartEvent, Battery, Board, Breakout, BreakoutPoint, Bus, CadAssembly, CadModel, Capacitor, Chip, Circuit, type CircuitJsonMetadata, type ComponentWithPins, Connector, Constraint, CopperPour, CopperText, CourtyardCircle, CourtyardOutline, CourtyardRect, Crystal, CurrentSource, Cutout, type DebugLogOutputEvent, DifferentialPair, Diode, DrcCheck, EnclosureCutoutAperture, EnclosureFdmBox, FabricationNoteDimension, FabricationNotePath, FabricationNoteRect, FabricationNoteText, Breakout as Fanout, BreakoutPoint as FanoutPoint, Fiducial, Footprint, Fuse, type GenericConnectionsAndSelectorsSel, type GenericLocalAutorouter, Group, Hole, type IIsolatedCircuit, type IRenderable, type IRootCircuit, Inductor, Interconnect, IsolatedCircuit, Jumper, Keepout, Led, type LocalCacheEngine, Mosfet, MountedBoard, Net, NetLabel, NormalComponent, type Obstacle, OpAmp, type PackingEndEvent, type PackingErrorEvent, type PackingStartEvent, Panel, PcbBend, type PcbGroupId, PcbNoteDimension, PcbNoteLine, PcbNotePath, PcbNoteRect, PcbNoteText, PcbReturnCurrentExcitation, PcbReturnCurrentSimulation, PcbSoldermaskOpening, PcbStiffener, PcbTrace, PcbVia, PinHeader, type PinLabelSpec, Pinout, PlatedHole, Port, Potentiometer, PowerSource, PrimitiveComponent, Project, PushButton, type RenderPhase, type RenderPhaseFn, type RenderPhaseFunctions, type RenderPhaseStates, Renderable, Resistor, Resonator, RootCircuit, type RootCircuitEventName, SOLVERS, SchematicArc, SchematicBox, SchematicCell, SchematicCircle, SchematicGraphic, SchematicLine, SchematicPath, SchematicRect, SchematicRow, SchematicSection, SchematicSheet, SchematicSymbol, SchematicTable, SchematicText, type Sel, SilkscreenCircle, SilkscreenGraphic, SilkscreenLine, SilkscreenPath, SilkscreenRect, SilkscreenText, type SimpleRouteBounds, type SimpleRouteBus, type SimpleRouteBusTermination, type SimpleRouteConnection, type SimpleRouteDifferentialPair, type SimpleRouteJson, type SimpleRoutePoint, type SimplifiedPcbTrace, type SingleLayerConnectionPoint, SmtPad, SolderJumper, type SolverEndedEvent, type SolverName, type SolverStartedEvent, SpiceModel, type SrjConnectionName, Subcircuit, Subpanel, Switch, SymbolComponent as Symbol, TestPoint, Trace, TraceHint, Transistor, Via, VoltageProbe, VoltageSource, analog, applyEditEvents, applyEditEventsToManualEditsFile, applyPcbEditEventsToManualEditsFile, applySchematicEditEventsToManualEditsFile, assembly, createUseComponent, enclosure, getPhaseTimingsFromRenderEvents, getSimpleRouteJsonFromCircuitJson, normalizePinLabels, orderedRenderPhases, renderPhaseIndexMap, resolveStaticFileImport, sel, simulation, unrouteCircuitJson, useCapacitor, useChip, useDiode, useLed, useRenderedCircuit, useResistor };

package/dist/index.js

@@ -84,6 +84,8 @@ __export(components_exports, {
   PcbNotePath: () => PcbNotePath,
   PcbNoteRect: () => PcbNoteRect,
   PcbNoteText: () => PcbNoteText,
+  PcbReturnCurrentExcitation: () => PcbReturnCurrentExcitation,
+  PcbReturnCurrentSimulation: () => PcbReturnCurrentSimulation,
   PcbSoldermaskOpening: () => PcbSoldermaskOpening,
   PcbStiffener: () => PcbStiffener,
   PcbTrace: () => PcbTrace,
@@ -1034,6 +1036,7 @@ var orderedRenderPhases = [
   "PcbCopperPourRender",
   "PcbViaStitchRender",
   "PcbCopperPourCleanup",
+  "PcbSimulationRender",
   "PcbDesignRuleChecks",
   "SilkscreenOverlapAdjustment",
   "CadModelRender",
@@ -1127,6 +1130,16 @@ var asyncPhaseDependencies = {
     "PcbViaStitchRender",
     "PcbCopperPourCleanup"
   ],
+  PcbSimulationRender: [
+    "PcbFootprintStringRender",
+    "FetchPartFootprint",
+    "PcbPlacementDesignRuleChecks",
+    "PcbTraceRender",
+    "PcbRouteNetIslands",
+    "PcbCopperPourRender",
+    "PcbViaStitchRender",
+    "PcbCopperPourCleanup"
+  ],
   SilkscreenOverlapAdjustment: [
     "PcbFootprintStringRender",
     "FetchPartFootprint"
@@ -118340,7 +118353,7 @@ function Group_getRoutingPhasePlans(group) {
 var package_default = {
   name: "@tscircuit/core",
   type: "module",
-  version: "0.0.2118",
+  version: "0.0.2120",
   types: "dist/index.d.ts",
   main: "dist/index.js",
   module: "dist/index.js",
@@ -118399,7 +118412,7 @@ var package_default = {
     "@tscircuit/miniflex": "^0.0.4",
     "@tscircuit/modelprinter": "^0.0.18",
     "@tscircuit/ngspice-spice-engine": "^0.0.20",
-    "@tscircuit/props": "^0.0.697",
+    "@tscircuit/props": "^0.0.698",
     "@tscircuit/schematic-match-adapt": "^0.0.18",
     "@tscircuit/schematic-trace-solver": "https://jscdn.tscircuit.com/@tscircuit/schematic-trace-solver/0.0.230.tgz",
     "@tscircuit/solver-utils": "^0.0.16",
@@ -118483,7 +118496,7 @@ var package_default = {
   },
   overrides: {
     "@tscircuit/circuit-json-util": "^0.0.119",
-    "@tscircuit/props": "^0.0.697",
+    "@tscircuit/props": "^0.0.698",
     "circuit-json": "^0.0.525",
     "@tscircuit/cableprinter": "^0.0.6"
   }
@@ -133090,6 +133103,280 @@ var AnalogSweepParameter = class extends PrimitiveComponent2 {
   }
 };
 
+// lib/components/primitive-components/PcbReturnCurrentSimulation.ts
+import { pcbReturnCurrentSimulationProps } from "@tscircuit/props";
+var PcbReturnCurrentSimulation = class extends PrimitiveComponent2 {
+  simulation_experiment_id = null;
+  get config() {
+    return {
+      componentName: "PcbReturnCurrentSimulation",
+      zodProps: pcbReturnCurrentSimulationProps
+    };
+  }
+  doInitialSimulationRender() {
+    if (this.root?.pcbDisabled) return;
+    if (this.parent?.componentName === "PcbReturnCurrentSimulation") {
+      this.renderError(
+        "A PCB return-current simulation cannot contain another simulation."
+      );
+    }
+    if (this.children.some(
+      (child) => child.componentName !== "PcbReturnCurrentExcitation"
+    )) {
+      this.renderError(
+        "A PCB return-current simulation can contain only return-current excitations."
+      );
+    }
+    const experiment = this.root.db.simulation_experiment.insert({
+      name: this._parsedProps.name ?? "PCB return current",
+      experiment_type: "pcb_return_current"
+    });
+    this.simulation_experiment_id = experiment.simulation_experiment_id;
+  }
+  updateSimulationRender() {
+    if (!this.simulation_experiment_id) return;
+    this.root.db.simulation_experiment.update(this.simulation_experiment_id, {
+      name: this._parsedProps.name ?? "PCB return current"
+    });
+  }
+  removeSimulationRender() {
+    if (!this.simulation_experiment_id) return;
+    this.root.db.simulation_experiment.delete(this.simulation_experiment_id);
+    this.simulation_experiment_id = null;
+  }
+};
+
+// lib/components/primitive-components/PcbReturnCurrentExcitation.ts
+import { pcbReturnCurrentExcitationProps } from "@tscircuit/props";
+
+// lib/components/primitive-components/PcbReturnCurrentExcitation_doInitialPcbSimulationRender.ts
+var positionToleranceMm = 1e-6;
+function PcbReturnCurrentExcitation_doInitialPcbSimulationRender(excitation) {
+  if (excitation.root?.pcbDisabled) return;
+  const { db: db2 } = excitation.root;
+  const props = excitation._parsedProps;
+  const simulation2 = excitation.parent;
+  if (simulation2?.componentName !== "PcbReturnCurrentSimulation") {
+    excitation.renderError(
+      "A PCB return-current excitation must be directly inside a PCB return-current simulation."
+    );
+    return;
+  }
+  if (!simulation2.simulation_experiment_id) {
+    excitation.renderError(
+      "The PCB return-current simulation has not been declared."
+    );
+    return;
+  }
+  const subcircuit = excitation.getSubcircuit();
+  const resolvePcbPort = (selector, role) => {
+    const ports = subcircuit.selectAll(selector).filter((component) => component.componentName === "Port");
+    if (ports.length !== 1) {
+      excitation.renderError(
+        `${role} selector "${selector}" must identify exactly one physical PCB port.`
+      );
+    }
+    const port = ports[0];
+    const pcbPort = port?.pcb_port_id ? db2.pcb_port.get(port.pcb_port_id) : null;
+    const hasPhysicalPad = pcbPort && (db2.pcb_smtpad.list({ pcb_port_id: pcbPort.pcb_port_id }).length > 0 || db2.pcb_plated_hole.list({ pcb_port_id: pcbPort.pcb_port_id }).length > 0);
+    if (!pcbPort || !hasPhysicalPad) {
+      excitation.renderError(
+        `${role} selector "${selector}" needs a physical PCB pad or plated-hole port.`
+      );
+    }
+    return pcbPort;
+  };
+  const signalSource = resolvePcbPort(props.source, "Signal source");
+  const signalLoad = resolvePcbPort(props.load, "Signal load");
+  const returnSource = resolvePcbPort(
+    props.returnSource,
+    "Return source (load-side ground)"
+  );
+  const returnSink = resolvePcbPort(
+    props.returnSink,
+    "Return sink (driver-side ground)"
+  );
+  if ((/* @__PURE__ */ new Set([
+    signalSource.pcb_port_id,
+    signalLoad.pcb_port_id,
+    returnSource.pcb_port_id,
+    returnSink.pcb_port_id
+  ])).size !== 4) {
+    excitation.renderError(
+      "Signal source, signal load, return source and return sink must be four distinct physical PCB ports."
+    );
+  }
+  const groundNets = subcircuit.selectAll(props.ground.startsWith("net.") ? "net" : props.ground).filter(
+    (component) => component.componentName === "Net" && (!props.ground.startsWith("net.") || component.getPortSelector() === props.ground)
+  );
+  if (groundNets.length !== 1 || !groundNets[0].source_net_id) {
+    excitation.renderError(
+      `Ground selector "${props.ground}" must identify exactly one source net.`
+    );
+  }
+  const groundNet = db2.source_net.get(groundNets[0].source_net_id);
+  const groundConnectivityKey = groundNet.subcircuit_connectivity_map_key;
+  for (const [pcbPort, selector] of [
+    [signalSource, props.source],
+    [signalLoad, props.load]
+  ]) {
+    if (groundConnectivityKey && db2.source_port.get(pcbPort.source_port_id)?.subcircuit_connectivity_map_key === groundConnectivityKey) {
+      excitation.renderError(
+        `Signal terminal "${selector}" is electrically connected to ground net "${groundNet.name}".`
+      );
+    }
+  }
+  for (const [pcbPort, selector] of [
+    [returnSource, props.returnSource],
+    [returnSink, props.returnSink]
+  ]) {
+    const sourcePort = db2.source_port.get(pcbPort.source_port_id);
+    if (!groundConnectivityKey || sourcePort?.subcircuit_connectivity_map_key !== groundConnectivityKey) {
+      excitation.renderError(
+        `Return contact "${selector}" is not electrically connected to ground net "${groundNet.name}".`
+      );
+    }
+  }
+  const contact = (pcbPort, selector, requestedLayer, role) => {
+    const layers = [...new Set(pcbPort.layers)];
+    if (!requestedLayer && layers.length !== 1) {
+      excitation.renderError(
+        `${role} "${selector}" spans multiple layers; specify ${role === "Return source" ? "returnSourceLayer" : "returnSinkLayer"}.`
+      );
+    }
+    const layer = requestedLayer ?? layers[0];
+    if (!layers.includes(layer)) {
+      excitation.renderError(
+        `${role} "${selector}" has no physical port on layer "${layer}".`
+      );
+    }
+    return {
+      contact_type: "pcb_port",
+      pcb_port_id: pcbPort.pcb_port_id,
+      x: pcbPort.x,
+      y: pcbPort.y,
+      layer
+    };
+  };
+  const returnSourceContact = contact(
+    returnSource,
+    props.returnSource,
+    props.returnSourceLayer,
+    "Return source"
+  );
+  const returnSinkContact = contact(
+    returnSink,
+    props.returnSink,
+    props.returnSinkLayer,
+    "Return sink"
+  );
+  for (const [signalPort, referenceContact] of [
+    [signalSource, returnSinkContact],
+    [signalLoad, returnSourceContact]
+  ]) {
+    if (Math.hypot(
+      signalPort.x - referenceContact.x,
+      signalPort.y - referenceContact.y
+    ) <= positionToleranceMm && signalPort.layers.includes(referenceContact.layer)) {
+      excitation.renderError(
+        "A signal terminal and its ground reference must occupy different physical PCB locations on the same layer."
+      );
+    }
+  }
+  let selectedSourceTraceId;
+  if (props.trace) {
+    const traces2 = subcircuit.selectAll(props.trace).filter((component) => component.componentName === "Trace");
+    if (traces2.length !== 1 || !traces2[0].source_trace_id) {
+      excitation.renderError(
+        `Trace selector "${props.trace}" must identify exactly one routed source trace.`
+      );
+    }
+    selectedSourceTraceId = traces2[0].source_trace_id;
+  }
+  const endpointMatches = (endpoint, pcbPort, end) => endpoint?.route_type === "wire" && Math.hypot(endpoint.x - pcbPort.x, endpoint.y - pcbPort.y) <= positionToleranceMm && pcbPort.layers.includes(endpoint.layer) && (!endpoint[`${end}_pcb_port_id`] || endpoint[`${end}_pcb_port_id`] === pcbPort.pcb_port_id);
+  const traces = db2.pcb_trace.list().filter((pcbTrace) => {
+    if (pcbTrace.subcircuit_id !== subcircuit.subcircuit_id) return false;
+    if (selectedSourceTraceId && pcbTrace.source_trace_id !== selectedSourceTraceId)
+      return false;
+    const sourceTrace = pcbTrace.source_trace_id ? db2.source_trace.get(pcbTrace.source_trace_id) : null;
+    if (!sourceTrace || sourceTrace.connected_source_port_ids.length !== 2 || !sourceTrace.connected_source_port_ids.includes(
+      signalSource.source_port_id
+    ) || !sourceTrace.connected_source_port_ids.includes(signalLoad.source_port_id))
+      return false;
+    const first = pcbTrace.route[0];
+    const last = pcbTrace.route.at(-1);
+    return endpointMatches(first, signalSource, "start") && endpointMatches(last, signalLoad, "end") || endpointMatches(first, signalLoad, "start") && endpointMatches(last, signalSource, "end");
+  });
+  if (traces.length !== 1) {
+    excitation.renderError(
+      `The connection from "${props.source}" to "${props.load}" must have exactly one complete routed PCB trace${props.trace ? ` selected by "${props.trace}"` : "; use trace to disambiguate multiple routes"}. Split or branched routes are not supported.`
+    );
+  }
+  const previousExcitations = db2.simulation_return_current_excitation.list({
+    simulation_experiment_id: simulation2.simulation_experiment_id
+  });
+  if (previousExcitations.some(
+    (previous) => previous.pcb_trace_id === traces[0].pcb_trace_id
+  )) {
+    excitation.renderError(
+      "A PCB return-current simulation can excite each signal trace only once. Use separate experiments to compare different currents or directions."
+    );
+  }
+  if (previousExcitations.some(
+    (previous) => previous.ground_source_net_id !== groundNet.source_net_id
+  )) {
+    excitation.renderError(
+      "All excitations in a PCB return-current simulation must use the same ground net. Use separate experiments for different ground nets."
+    );
+  }
+  const inserted = db2.simulation_return_current_excitation.insert({
+    simulation_experiment_id: simulation2.simulation_experiment_id,
+    pcb_trace_id: traces[0].pcb_trace_id,
+    ground_source_net_id: groundNet.source_net_id,
+    current: props.current,
+    return_source: returnSourceContact,
+    return_sink: returnSinkContact,
+    source_port: {
+      signal_pcb_port_id: signalSource.pcb_port_id,
+      reference_pcb_port_id: returnSink.pcb_port_id,
+      reference_layer: returnSinkContact.layer,
+      resistance: props.sourceImpedance
+    },
+    load_port: {
+      signal_pcb_port_id: signalLoad.pcb_port_id,
+      reference_pcb_port_id: returnSource.pcb_port_id,
+      reference_layer: returnSourceContact.layer,
+      resistance: props.loadImpedance
+    }
+  });
+  excitation.simulation_return_current_excitation_id = inserted.simulation_return_current_excitation_id;
+}
+
+// lib/components/primitive-components/PcbReturnCurrentExcitation.ts
+var PcbReturnCurrentExcitation = class extends PrimitiveComponent2 {
+  simulation_return_current_excitation_id = null;
+  get config() {
+    return {
+      componentName: "PcbReturnCurrentExcitation",
+      zodProps: pcbReturnCurrentExcitationProps
+    };
+  }
+  doInitialPcbSimulationRender() {
+    PcbReturnCurrentExcitation_doInitialPcbSimulationRender(this);
+  }
+  updatePcbSimulationRender() {
+    this.removePcbSimulationRender();
+    this.doInitialPcbSimulationRender();
+  }
+  removePcbSimulationRender() {
+    if (!this.simulation_return_current_excitation_id) return;
+    this.root.db.simulation_return_current_excitation.delete(
+      this.simulation_return_current_excitation_id
+    );
+    this.simulation_return_current_excitation_id = null;
+  }
+};
+
 // lib/components/primitive-components/VoltageProbe.ts
 import { voltageProbeProps } from "@tscircuit/props";
 
@@ -134544,6 +134831,16 @@ var enclosure = {
   }
 };
 
+// lib/namespaced-elements/simulation.ts
+var simulation = {
+  pcbreturncurrentsimulation: createNamespacedElement(
+    "pcbreturncurrentsimulation"
+  ),
+  pcbreturncurrentexcitation: createNamespacedElement(
+    "pcbreturncurrentexcitation"
+  )
+};
+
 // lib/RootCircuit.ts
 var RootCircuit = class extends IsolatedCircuit {
   isRootCircuit = true;
@@ -134861,6 +135158,8 @@ export {
   PcbNotePath,
   PcbNoteRect,
   PcbNoteText,
+  PcbReturnCurrentExcitation,
+  PcbReturnCurrentSimulation,
   PcbSoldermaskOpening,
   PcbStiffener,
   PcbTrace,
@@ -134932,6 +135231,7 @@ export {
   renderPhaseIndexMap,
   resolveStaticFileImport,
   sel,
+  simulation,
   unrouteCircuitJson,
   useCapacitor,
   useChip,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/core",
   "type": "module",
-  "version": "0.0.2119",
+  "version": "0.0.2121",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -60,7 +60,7 @@
     "@tscircuit/miniflex": "^0.0.4",
     "@tscircuit/modelprinter": "^0.0.18",
     "@tscircuit/ngspice-spice-engine": "^0.0.20",
-    "@tscircuit/props": "^0.0.697",
+    "@tscircuit/props": "^0.0.698",
     "@tscircuit/schematic-match-adapt": "^0.0.18",
     "@tscircuit/schematic-trace-solver": "https://jscdn.tscircuit.com/@tscircuit/schematic-trace-solver/0.0.230.tgz",
     "@tscircuit/solver-utils": "^0.0.16",
@@ -144,7 +144,7 @@
   },
   "overrides": {
     "@tscircuit/circuit-json-util": "^0.0.119",
-    "@tscircuit/props": "^0.0.697",
+    "@tscircuit/props": "^0.0.698",
     "circuit-json": "^0.0.525",
     "@tscircuit/cableprinter": "^0.0.6"
   }