solprop.translate.collar_check#

The design check of a requested collar: what it sends back (SEP 40, 4.4).

design_check() propagates the launch linearly through the designed collar, one frequency node at a time, and compares it over the requested aperture with the same launch on a bare grid too large to return it; the largest returned share along the run, weighted over equal-energy frequency nodes, is the estimate. Radially the generator is exponentiated by eigendecomposition; the Cartesian, line and planar grids take a one-frequency Strang march. Above BUDGET the design is refused, an estimate near it is refined once and must meet REFINED_BUDGET, and an inconclusive check is not a pass; CheckResult is the verdict and its record.

The formula and the reasoning are docs/dev/algorithms.md section 8, “The transverse collar’s design check”; the contract is SEP 40 section 4.4.

Module Attributes

BUDGET

The reflection budget in energy, (2e-4)^2 (SEP 40 sections 4.8 and 7.1).

REFINED_BUDGET

What a refined estimate must meet: the budget less the 25 % by which the check read low against full runs (Part II).

WARNING_SHARE

The monitor's warning share of the launch energy, which sets the launch's extent and reach (SEP 40 sections 4.4 and 5.3).

Functions

design_check(space, rate, launch, ...)

Run the design check of SEP 40 section 4.4 on one launch.

Classes

CheckResult(status[, returned, bare_wall, ...])

The design check's verdict and its record (SEP 40 section 4.4).

solprop.translate.collar_check.BUDGET = 4e-08#

The reflection budget in energy, (2e-4)^2 (SEP 40 sections 4.8 and 7.1).

class solprop.translate.collar_check.CheckResult(status, returned=nan, bare_wall=nan, refined=False, nodes=(), planes=0, wall_time=0.0, reason='')[source]#

Bases: object

The design check’s verdict and its record (SEP 40 section 4.4).

Attributes:
status{‘passed’, ‘refused’, ‘inconclusive’, ‘pending’}

The verdict; "pending" when there is no launch to check yet.

returnedfloat

U_ret, an energy share of the launch.

bare_wallfloat

The same launch’s return from a bare wall at the same outer size.

refinedbool

Whether the estimate was refined.

nodestuple of float

The frequency nodes, rad/s.

planesint

The planes compared.

wall_timefloat

The check’s own wall time, s.

reasonstr

Why a check did not pass or converge; empty otherwise.

bare_wall: float = nan#
nodes: tuple[float, ...] = ()#
planes: int = 0#
reason: str = ''#
record()[source]#

Return the check’s record for the design.

Returns:
dict

JSON-ready values.

refined: bool = False#
returned: float = nan#
status: Literal['passed', 'refused', 'inconclusive', 'pending']#
wall_time: float = 0.0#
solprop.translate.collar_check.REFINED_BUDGET = 3e-08#

What a refined estimate must meet: the budget less the 25 % by which the check read low against full runs (Part II).

solprop.translate.collar_check.WARNING_SHARE = 1e-06#

The monitor’s warning share of the launch energy, which sets the launch’s extent and reach (SEP 40 sections 4.4 and 5.3).

solprop.translate.collar_check.design_check(space, rate, launch, dispersion, z_max, width)[source]#

Run the design check of SEP 40 section 4.4 on one launch.

Parameters:
spacesolprop.grid.RadialGrid, solprop.grid.FreeGrid or PlanarGrid

The design’s grid.

ratenumpy.ndarray

The collar’s power rate on the nodes, 1/m.

launchnumpy.ndarray

The noise-free launch, canonical layout.

dispersionsolprop.spatial.SpatialDispersion

The medium and the temporal grid.

z_maxfloat

The run’s length, m.

widthfloat

The collar’s narrowest width, m.

Returns:
CheckResult

The verdict, "pending" for a launch that is zero everywhere.