solprop.coupling#

Couple simulations through a coherent field at a reference plane (SEP 31).

A physics-layer package: NumPy, SciPy and other physics modules only. A FieldPlane is one physical plane of a field in its native representation, with its references, geometry, medium, metric and provenance; regrid() moves it onto another temporal lattice or reference; an InputPort describes what a receiving simulation accepts at its entrance, and couple() launches a plane into it under a declared CouplingModel; Outcouple synthesises a guide’s exit field, and transport() carries a spatial plane through an ordered sequence of linear elements. Extraction from a saved run is solprop.processing.planes.field_plane(); installing a launch is solprop.driver.simulation.Simulation.with_input(). The manual page is docs/guide/workflows/coupling.md.

Modules

coupler

Couple a field plane into a simulation's input port (SEP 31, sections 4.3 and 4.7).

elements

Linear optical elements acting on a spatial field between planes (SEP 31 §4.6).

envelopes

Recorded benchmark envelopes of the approximate coupling models' provider pairs.

models

The coupling models of SEP 31 section 4.3 and the scalar mode profiles they use.

outcouple

Synthesise a guide's exit field on a spatial grid (SEP 31, sections 4.1 and 5.2).

plane

One physical plane of an ultrafast field, with everything needed to use it.

port

The receiving side of a transfer: a simulation's input port and its launch.

remap

Move a field plane onto another temporal lattice, or another reference.

transport(plane, elements, *[, geometry, frame])

Apply an ordered sequence of linear elements to a field plane.