solprop.backends.numpy_ref.dense#

The reference’s dense output: a plane interpolated inside the step that crossed it.

The counterparts of native’s engines::RungeKuttaDense and engines::AdamsDense (native/src/dense.cpp), which implement the session’s Dense: the session (HostSession) decides when a plane is observed inside the last accepted step, and asks one of these to hold the committed state aside, make the state the interpolated field there, and restore the committed state before the march goes on (SEP 14 phase 3, ADR-036, SEP 52 section 5.2). An observation neither rewinds the controller nor advances the history, and evaluates no source.

  • RungeKuttaDense evaluates DOPRI5’s continuous extension of Hairer, Norsett and Wanner II.6, which the engine held when the step was accepted (extend()), and carries it to the plane by the exact linear flow.

  • AdamsDense evaluates the Adams march’s interpolant over its last accepted step: the weights at the plane’s fraction from the march’s record of the step (AcceptedStep), its carrier rotations applied to the samples the engine kept (SEP 35 section 4.1).

Classes

AdamsDense(workspace, engine, march)

The Adams march's interpolant over its last accepted step.

RungeKuttaDense(workspace, engine)

DOPRI5's continuous extension of the last step that crossed a plane.

class solprop.backends.numpy_ref.dense.AdamsDense(workspace, engine, march)[source]#

Bases: object

The Adams march’s interpolant over its last accepted step.

Parameters:
workspacesolprop.backends.numpy_ref.workspace.NumpyWorkspace

The workspace whose state is observed.

enginesolprop.backends.numpy_ref.multistep.HostHistory

The engine that kept the step’s samples.

marchsolprop.backends.host.adams.HostAdamsMarch

The march whose record of the step (last_step) gives the weights’ nodes and the carrier rotations.

static crosses(position, target)[source]#

Return whether a march that returned at position stepped past target.

Parameters:
positionfloat

The committed position, m.

targetfloat

The plane, m.

Returns:
bool

True when position is past it.

observe(position)[source]#

Hold the committed state aside; make the state the field at position.

Parameters:
positionfloat

The plane, m, inside the last accepted step.

Raises:
BackendError

If no accepted step is held.

restore()[source]#

Make the committed state current again.

class solprop.backends.numpy_ref.dense.RungeKuttaDense(workspace, engine)[source]#

Bases: object

DOPRI5’s continuous extension of the last step that crossed a plane.

Parameters:
workspacesolprop.backends.numpy_ref.workspace.NumpyWorkspace

The workspace whose state is observed.

enginesolprop.backends.numpy_ref.engines.NumpyRungeKutta

The engine that held the extension.

static crosses(position, target)[source]#

Return whether a march that returned at position stepped across target.

Parameters:
positionfloat

The committed position, m.

targetfloat

The plane, m.

Returns:
bool

True past the plane’s landing tolerance (not reached(target, z)).

observe(position)[source]#

Hold the committed state aside; make the state the field at position.

Interpolated by the continuous extension and carried to position by the exact linear flow; no source is evaluated.

Parameters:
positionfloat

The plane, m, inside the extended step.

Raises:
BackendError

If no extension is held.

restore()[source]#

Make the committed state current again.