solprop.modes.stepindex_vector#

Recover a step-index fibre’s bound Maxwell fields and offer them as a modal provider.

The vector E/H fields of a StepIndexMode follow analytically from its existing eigenvalue roots: Bessel J in the core and scaled K in the cladding, normalised by an independent full-domain power integral (electromagnetic_field() reads them from here). StepIndexProvider packages a set of those modes, with the material regions they are solved in (agreeing to MATERIAL_AGREEMENT_RTOL), as a ModalProvider the general modal route samples (ModalGuide).

Module Attributes

MATERIAL_AGREEMENT_RTOL

Largest relative disagreement a step-index provider admits between a region's declared permittivity law and the index its channels were solved with.

Classes

StepIndexProvider(modes, regions)

Evaluate exact bound step-index E/H using independent full-domain power norms.

solprop.modes.stepindex_vector.MATERIAL_AGREEMENT_RTOL = 1e-06#

Largest relative disagreement a step-index provider admits between a region’s declared permittivity law and the index its channels were solved with.

The modes own the eigenproblem’s indices (StepIndexMode.core and cladding) and the regions own the material laws; the two describe the same material and nothing else made them agree. The regions’ laws are what a declared n2 is converted against (solprop.modes.material.MaterialKerr.susceptibility()) and what a guide’s identity records, so a core region declared at 2.0 beside channels solved at 1.45 would propagate the 1.45 fields with a chi3 90 % too large and nothing downstream would say so.

The budget is on the permittivity, and 1e-6 is chosen to admit a law evaluated by two paths – a glass law asked for its index and the same law asked for its permittivity – while refusing any disagreement a reader would call physical: the smallest index step this package’s own weakly guiding fixtures use is 0.001 in the index, which is 1.4e-3 in the permittivity, three orders above this.

class solprop.modes.stepindex_vector.StepIndexProvider(modes, regions)[source]#

Bases: Displayed

Evaluate exact bound step-index E/H using independent full-domain power norms.

A returned ModalSample is always fully valid: an unsupported channel is refused by name rather than masked out, so valid is all True in every sample this provider returns.

Attributes:
modestuple of StepIndexMode

Unique physical channels of one core/cladding geometry, in state order.

regionstuple of MaterialRegion

Core and unbounded exterior, with material laws matching the modes.

property identity: Mapping[str, JsonValue][source]#

Internal convention, bound-model and channel identities.

Serializable physical model and construction metadata.

modes: tuple[StepIndexMode, ...]#
node_rule(omega, z=0.0, *, n_r=None, n_theta=None)[source]#

Build a common rule and certify the discarded cladding power.

Parameters:
omegafloat

Positive frequency in rad/s in the guided band.

zfloat, optional

Position in m within the radius path.

n_rint or None, optional

Gauss nodes per radial panel, at least two; None uses the 64 this provider’s exponential cladding tail needs.

n_thetaint or None, optional

Angular node count; None uses 4*(maximum n+1)+1 for quartic products.

Returns:
ModalNodeRule

Material-split rule with independently integrated tail bounds.

Raises:
ModeError

If the bound field or tail cannot be certified.

property omega_domain: tuple[float, float][source]#

Material frequency support (lower, upper), rad/s.

solve() checks each mode’s cutoff.

regions: tuple[MaterialRegion, ...]#
solve(omega, z, *, nodes)[source]#

Solve bound channels on explicitly owned physical nodes.

Parameters:
omegafloat

Positive angular frequency in rad/s within material and guided support.

zfloat

Position in m in the radius path.

nodesModalNodeRule

Common Cartesian nodes with correct core/cladding ownership.

Returns:
ModalSample

Unit full-domain power E/H and their sampled physical Gram matrix. Its valid mask is all True: an unsupported channel is refused here, not masked.

Raises:
ModeError

If domains, material ownership, norm or a boundary residual is invalid.

property z_breakpoints: tuple[float, ...][source]#

Radius-path breakpoints (physical path kinks), m.

property z_domain: tuple[float, float][source]#

Radius-path interval (lower, upper), m.