Continuation Types

The types module defines the standardized result and problem objects used by continuation engines.

Continuation Result

ContinuationResult()

Standardized result for a continuation run.

class hiten.algorithms.continuation.types.ContinuationResult(accepted_count, rejected_count, success_rate, family, parameter_values, iterations)[source]

Bases: object

Standardized result for a continuation run.

Parameters:
accepted_count

The number of accepted solutions.

Type:

int

rejected_count

The number of rejected solutions.

Type:

int

success_rate

The success rate.

Type:

float

family

The family of solutions.

Type:

Tuple[object, …]

parameter_values

The parameter values.

Type:

Tuple[np.ndarray, …]

iterations

The number of iterations.

Type:

int

accepted_count: int
rejected_count: int
success_rate: float
family: Tuple[object, ...]
parameter_values: Tuple[ndarray, ...]
iterations: int

Continuation Problem

_ContinuationProblem()

Defines the inputs for a continuation run.

class hiten.algorithms.continuation.types._ContinuationProblem(initial_solution, parameter_getter, target, step, max_members, max_retries_per_step, representation_of=None, shrink_policy=None, step_min=1e-10, step_max=1.0, stepper='natural', state_indices=None, corrector_tol=1e-12, corrector_max_attempts=50, corrector_max_delta=0.01, corrector_order=8, corrector_steps=500, corrector_forward=1, corrector_fd_step=1e-08)[source]

Bases: object

Defines the inputs for a continuation run.

Parameters:
initial_solution

Starting solution for the continuation.

Type:

object

parameter_getter

Function that extracts continuation parameter(s) from a solution object.

Type:

callable

target

Target parameter range(s) for continuation. For 1D: (min, max). For multi-dimensional: (2, m) array where each column specifies (min, max) for one parameter.

Type:

sequence

step

Initial step size(s) for continuation parameters. If scalar, uses same step for all parameters.

Type:

float or sequence of float

max_members

Maximum number of accepted solutions to generate.

Type:

int

max_retries_per_step

Maximum number of retries per failed continuation step.

Type:

int

representation_of

Function to convert solution objects to vector representations.

Type:

callable or None

shrink_policy

Policy for shrinking step sizes when continuation fails.

Type:

callable or None

step_min

Minimum allowed step size.

Type:

float

step_max

Maximum allowed step size.

Type:

float

stepper

The stepper to use.

Type:

str

state_indices

The state indices.

Type:

Optional[np.ndarray]

corrector_tol

Convergence tolerance for the corrector residual norm.

Type:

float

corrector_max_attempts

Maximum number of corrector iterations.

Type:

int

corrector_max_delta

Maximum allowed infinity norm of corrector Newton steps.

Type:

float

corrector_order

Integration order for corrector.

Type:

int

corrector_steps

Number of integration steps for corrector.

Type:

int

corrector_forward

Integration direction for corrector (1 for forward, -1 for backward).

Type:

int

corrector_fd_step

Finite difference step size for corrector.

Type:

float

corrector_options_override

Full corrector options object that overrides all individual parameters if provided.

Type:

Optional[“OrbitCorrectionOptions”]

initial_solution: object
parameter_getter: Callable[[ndarray], ndarray]
target: ndarray
step: ndarray
max_members: int
max_retries_per_step: int
representation_of: Callable[[ndarray], ndarray] | None = None
shrink_policy: Callable[[ndarray], ndarray] | None = None
step_min: float = 1e-10
step_max: float = 1.0
stepper: str = 'natural'
state_indices: ndarray | None = None
corrector_tol: float = 1e-12
corrector_max_attempts: int = 50
corrector_max_delta: float = 0.01
corrector_order: int = 8
corrector_steps: int = 500
corrector_forward: int = 1
corrector_fd_step: float = 1e-08