Continuation Configuration

The config module provides configuration classes for domain-specific continuation algorithms.

Base Configuration

_ContinuationConfig()

Define configuration parameters for continuation algorithms.

class hiten.algorithms.continuation.config._ContinuationConfig(target, step, max_members, max_retries_per_step=50, step_min=1e-10, step_max=1.0, shrink_policy=None)[source]

Bases: object

Define configuration parameters for continuation algorithms.

Parameters:

  • target (np.ndarray) – The target to continue.

  • step (np.ndarray) – The step to continue.

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

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

  • step_min (float) – The minimum step size.

  • step_max (float) – The maximum step size.

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

target: ndarray
step: ndarray
max_members: int
max_retries_per_step: int
step_min: float
step_max: float
shrink_policy: Callable[[ndarray], ndarray] | None

Orbit Continuation Configuration

_OrbitContinuationConfig()

Define configuration parameters for periodic orbit continuation.

class hiten.algorithms.continuation.config._OrbitContinuationConfig(target, step, max_members, max_retries_per_step=50, step_min=1e-10, step_max=1.0, shrink_policy=None, state=None, getter=None, extra_params=None, stepper='natural')[source]

Bases: _ContinuationConfig

Define configuration parameters for periodic orbit continuation.

This dataclass encapsulates configuration options specific to periodic orbit continuation, including state initialization, parameter extraction, and additional correction settings.

Parameters:

  • state (SynodicState or None) – Initial state for orbit construction. If None, uses default state from the orbit class.

  • getter (callable or None) – Function to extract continuation parameter from periodic orbit. Should take a PeriodicOrbit and return float. If None, uses default parameter extraction.

  • extra_params (dict or None) – Additional parameters passed to orbit correction methods. Common keys include tolerances, maximum iterations, etc.

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

  • target (ndarray)

  • step (ndarray)

  • max_members (int)

  • max_retries_per_step (int)

  • step_min (float)

  • step_max (float)

  • shrink_policy (Callable[[ndarray], ndarray] | None)

state: SynodicState | None
getter: Callable[[PeriodicOrbit], float] | None
extra_params: dict | None
stepper: Literal['natural', 'secant']