SingleIntegratorRun

class cubie.integrators.SingleIntegratorRun(system: BaseODE, loop_settings: Dict[str, Any] | None = None, output_settings: Dict[str, Any] | None = None, evaluate_driver_at_t: Callable | None = None, driver_del_t: Callable | None = None, algorithm_settings: Dict[str, Any] | None = None, step_control_settings: Dict[str, Any] | None = None)

Bases: SingleIntegratorRunCore

Expose aggregated read-only properties for integrator runs.

Notes

Instantiation, updates, and compilation are provided by SingleIntegratorRunCore. This subclass intentionally limits itself to property-based access so that front-end utilities can inspect compiled CUDA components without mutating internal state.

property algorithm: str

Return the configured algorithm identifier.

property algorithm_key: str

Return the canonical algorithm identifier.

property algorithm_order: int | None

Return the algorithm order assumed by the controller.

property atol: Any | None

Return the absolute tolerance array.

property beta_coefficient: Any | None

Return the implicit beta coefficient.

property compile_flags: Any

Return loop compile flags.

property compiled_loop_function: Callable

Return the compiled loop function.

property compiled_loop_step_function: Callable

Return the compiled algorithm step function.

property control_device_function: Callable

Return the compiled controller device function.

property control_settings: Dict[str, Any]

Return the controller settings dictionary.

property dt: float | None

Return the fixed step size for fixed controllers.

property dt0: float

Return the starting step size from the controller.

property dt_max: float

Return the maximum allowable step size.

property dt_min: float

Return the minimum allowable step size.

property evaluate_f: Callable

Return the derivative function used by the integration step.

property gamma: float | None

Return the Gustafsson damping factor.

property gamma_coefficient: Any | None

Return the implicit gamma coefficient.

property integration_step_function: Callable

Return the compiled step function.

property integration_step_size: float | None

Return the fixed step size for explicit steps.

property is_adaptive: bool

Return whether adaptive stepping is active.

property kd: float | None

Return the derivative gain.

property ki: float | None

Return the integral gain.

property kp: float | None

Return the proportional gain.

property krylov_atol: Any | None

Return the linear solve absolute tolerance array.

property krylov_rtol: Any | None

Return the linear solve relative tolerance array.

property linear_correction_type: Any | None

Return the linear correction strategy.

property local_memory_elements: int

Return total persistent local-memory requirement.

property mass_matrix: Any | None

Return the implicit mass matrix.

property max_gain: float | None

Return the maximum step size gain.

property max_linear_iterations: int | None

Return the maximum linear iterations.

property min_gain: float | None

Return the minimum step size gain.

property n_saved_observables: int

Return the number of saved observables.

property n_saved_states: int

Return the number of saved states.

property n_summarised_observables: int

Return the number of summarised observables.

property n_summarised_states: int

Return the number of summarised states.

property newton_atol: Any | None

Return the nonlinear solve absolute tolerance array.

property newton_damping: float | None

Return the Newton damping factor.

property newton_iterations_limit: int | None

Return the maximum Newton iterations for the step.

property newton_max_backtracks: int | None

Return the maximum Newton backtracking steps.

property newton_max_iters: int | None

Return the maximum Newton iterations used by the controller.

property newton_rtol: Any | None

Return the nonlinear solve relative tolerance array.

property observable_summaries_buffer_height: int

Return the total observable summary buffer height.

property observable_summaries_output_height: int

Return the observable summary output height.

property order: int

Return the algorithm order.

property output_array_heights: Any

Return the output array height descriptor.

property output_compile_flags: Any

Return the output compile flags.

output_length(duration: float) → int

Calculate number of time-domain output samples for a duration.

Parameters:

duration – Integration duration in time units.

Returns:

Number of output samples including initial and optionally final.

Return type:

int

property output_types: Any

Return the configured output types.

property persistent_local_elements: int

Return total persistent local-memory elements required by the loop.

property preconditioner_order: int | None

Return the implicit preconditioner order.

property rtol: Any | None

Return the relative tolerance array.

property safety: float | None

Return the controller safety factor.

property sample_summaries_every: float | None

Return the loop sample summaries interval, or None if not configured.

property save_every: float | None

Return the loop save interval, or None if not configured.

property save_last: bool

Return True if end-of-run-only state saving is configured.

property save_state_fn: Callable

Return the loop state-save function.

property save_state_func: Callable

Return the compiled state saving function.

property save_summaries_fn: Callable

Return the loop summary-save function.

property save_summaries_func: Callable

Return the summary saving function from the output handlers.

property save_summary_metrics_func: Callable

Return the compiled summary saving function.

property save_time: bool

Return whether time saving is enabled.

property saved_observable_indices: Any

Return the saved observable indices.

property saved_state_indices: Any

Return the saved state indices.

property shared_memory_bytes: int

Return total shared-memory usage in bytes.

property shared_memory_elements: int

Return total shared-memory elements required by the loop.

property solver_helper: Callable

Return the solver helper factory used by the algorithm.

property state_count: int

Return the algorithm state count.

property state_summaries_buffer_height: int

Return the total state summary buffer height.

property state_summaries_output_height: int

Return the state summary output height.

property step_controller: str

Return the configured step-controller identifier.

summaries_length(duration: float) → int

Calculate number of summary output samples for a duration.

Parameters:

duration – Integration duration in time units.

Returns:

Number of summary intervals.

Return type:

int

property summarise_every: float | None

Return the loop summary interval, or None if not configured.

property summarised_observable_indices: Any

Return the summarised observable indices.

property summarised_state_indices: Any

Return the summarised state indices.

property summary_buffer_height_per_variable: int

Return the summary buffer height per variable.

property summary_legend_per_variable: Any

Return the summary legend per variable.

property summary_output_height_per_variable: int

Return the summary output height per variable.

property summary_unit_modifications: Any

Return the summary unit modifications.

property system: BaseODE

Return the underlying ODE system.

property system_sizes: SystemSizes

Return the size descriptor for the ODE system.

property threads_per_loop: int

Return the number of CUDA threads required per system.

property threads_per_step: int

Return the number of threads required by the step function.

property total_summary_buffer_size: int

Return the total summary buffer size.

property update_summaries_fn: Callable

Return the loop summary-update function.

property update_summaries_func: Callable

Return the compiled summary update function.

property uses_multiple_stages: bool

Return whether the algorithm uses multiple stages.