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 atol: Any | None

Return the absolute tolerance array.

property compile_flags: Any

Return loop compile flags.

property dt: float | None

Return the fixed step size for fixed controllers.

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 is_adaptive: bool

Return whether adaptive stepping is active.

property local_memory_elements: int

Return total persistent local-memory requirement.

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 rtol: Any | None

Return the relative tolerance array.

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 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_legend_per_variable: Any

Return the summary legend 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_step: int

Return the number of threads required by the step function.

property update_summaries_fn: Callable

Return the loop summary-update function.

property update_summaries_func: Callable

Return the compiled summary update function.