Continuation Base

The base module provides user-facing facades for continuation workflows.

Continuation Pipeline

ContinuationPipeline()

Facade for natural-parameter continuation varying selected state components. Users supply an engine (DI). Use ContinuationPipeline.with_default_engine() to construct a default engine wired with the generic predict-correct backend and the periodic-orbit interface.

class hiten.algorithms.continuation.base.ContinuationPipeline(config, engine, interface=None, backend=None)[source]

Bases: _HitenBaseFacade, Generic[DomainT, InterfaceT, ConfigT, ResultT]

Facade for natural-parameter continuation varying selected state components.

Users supply an engine (DI). Use ContinuationPipeline.with_default_engine() to construct a default engine wired with the generic predict-correct backend and the periodic-orbit interface.

Parameters:

  • config (ConfigT) – Configuration object for the continuation algorithm.

  • interface (InterfaceT) – Interface object for the continuation algorithm.

  • engine (_ContinuationEngine) – Engine object for the continuation algorithm.

  • backend (_ContinuationBackend)

classmethod with_default_engine(*, config, interface=None, backend=None)[source]

Create a facade instance with a default engine (factory).

Parameters:

  • config (ConfigT) – Configuration object for the continuation algorithm.

  • interface (InterfaceT, optional) – Interface object for the continuation algorithm. If None, uses the default _PeriodicOrbitContinuationInterface.

  • backend (_ContinuationBackend, optional) – Backend instance for the continuation algorithm. If None, uses the default _PCContinuationBackend.

Returns:

A continuation facade instance with a default engine injected.

Return type:

ContinuationPipeline

generate(domain_obj, override=False, *, state=None, target=None, step=None, max_members=None, max_retries_per_step=None, step_min=None, step_max=None, extra_params=None, shrink_policy=None, getter=None, stepper=None)[source]

Generate a continuation result.

Parameters:

  • domain_obj (DomainT) – The domain object to continue.

  • override (bool) – Whether to override the default configuration.

  • state (Optional[SynodicState) –

    Sequence[SynodicState] | int | Sequence[int]]

    The state to continue.

  • target (Optional[Sequence[float] | np.ndarray]) – The target to continue.

  • step (Optional[float | Sequence[float] | np.ndarray]) – The step to continue.

  • max_members (Optional[int]) – The maximum number of members to continue.

  • max_retries_per_step (Optional[int]) – The maximum number of retries per step.

  • step_min (Optional[float]) – The minimum step size.

  • step_max (Optional[float]) – The maximum step size.

  • extra_params (Optional[dict]) – The extra parameters to continue.

  • shrink_policy (Optional[Callable[[np.ndarray], np.ndarray]]) – The shrink policy to continue.

  • getter (Optional[Callable[["PeriodicOrbit"], float]]) – The getter to continue.

  • stepper (Optional[Literal["natural", "secant"]]) – The stepper to continue.

Returns:

The continuation result.

Return type:

ContinuationResult