solprop.coupling#
Couple simulations through a coherent field at a reference plane (SEP 31).
plane:FieldPlane, one physical plane of a field in its native representation, with its references, geometry, medium, metric and provenance.remap:regrid()moves a plane onto another temporal lattice or reference.port:InputPort, what a receiving simulation accepts at its entrance, and theCouplingLaunchbound to it.couplerandmodels:couple()launches a plane into a port under a declaredCouplingModel, admitted against the recorded pair envelopes ofenvelopes.outcouple:Outcouplesynthesises a guide’s exit field on a spatial grid.elementsand thetransportmodule (whose function shadows it):solprop.coupling.transport()carries a spatial plane through an ordered sequence of linear elements, with itsTransportReport.
A physics-layer package: it imports no translation, driver or backend module. A
spatial plane’s power metric is a solprop.spatial.SpatialFlux (SEP 34), whose
resolution and admittance call translation code through lazy imports in
solprop.spatial, so a coupling that measures a plane runs it at runtime.
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
Couple a field plane into a simulation's input port (SEP 31, sections 4.3 and 4.7). |
|
Linear optical elements acting on a spatial field between planes (SEP 31 §4.6). |
|
Recorded benchmark envelopes of the approximate coupling models' provider pairs. |
|
The coupling models of SEP 31 section 4.3 and the scalar mode profiles they use. |
|
Synthesise a guide's exit field on a spatial grid (SEP 31, sections 4.1 and 5.2). |
|
One physical plane of an ultrafast field, with everything needed to use it. |
|
The receiving side of a transfer: a simulation's input port and its launch. |
|
Move a field plane onto another temporal lattice, or another reference. |
|
|
Apply an ordered sequence of linear elements to a field plane. |