solprop.translate.free

Translate constant Cartesian propagation into the schema-5 separable seam.

Functions

free_operators(space, dispersion, *, n_pol, ...)	Keep constant Cartesian material coefficients in separable form.
free_transform(space, *, n_pol, z_max[, ...])	Freeze the Cartesian FFT layout.

solprop.translate.free.free_operators(space, dispersion, *, n_pol, z_max, absorber=None, margin=0.05, transverse_rate=None)

Keep constant Cartesian material coefficients in separable form.

Parameters:

spacesolprop.grid.FreeGrid

Cartesian transverse wave-number squares in m^-2.

dispersionsolprop.spatial.SpatialDispersion

Constant bulk material, temporal grid and frame.

n_polint

State polarisation count, 1 or 2.

z_maxfloat

Positive propagation length in m.

absorbersolprop.boundaries.Absorber or None, optional

Shared spectral absorption rate in m^-1.

marginfloat, optional

Relative extension of the valid interval, nonnegative.

transverse_ratenumpy.ndarray or None, optional

The safety ramp’s power rate per column in m^-1 (solprop.spatial_absorber.SpatialAbsorberDesign); None is zero.

Returns:

tuple

Linear operator and the same separable record for the nonlinear prefactor.

Raises:

TranslationError

If the medium varies along z or the interval is invalid.

Warns:

solprop.exceptions.GrazingIncidenceWarning

If an active transverse/frequency bin lies within the elementary-arithmetic uncertainty of the grazing clamp branch. Translation continues unchanged; this diagnostic does not assess the field or nonlinear source in that bin.

solprop.translate.free.free_transform(space, *, n_pol, z_max, collar_rate=None, margin=0.05)

Freeze the Cartesian FFT layout.

The node chunk is the backend’s execution choice, planned when it is prepared (solprop.backends.node_chunk.plan_node_chunk()), not part of the transform.

Parameters:

spacesolprop.grid.FreeGrid

Validated Cartesian axes, raw-DFT measures and spatial collar.

n_polint

State polarisation count, 1 or 2.

z_maxfloat

Positive run length in m.

collar_ratenumpy.ndarray or None, optional

The real-space collar’s power rate on the nodes, 1/m, from the run’s solprop.spatial_absorber.SpatialAbsorberDesign; None for no collar.

marginfloat, optional

Relative extension of diagnostic tables beyond z_max, nonnegative.

Returns:

solprop.translate.modal.Transform

Empty dense matrices and the explicit FFT geometry.