cubie.integrators.algorithms.IntegratorLoopSettings

Integrator configuration management with validation and adapter patterns.

This module provides the IntegratorLoopSettings class for managing compile-critical settings for integrator loops, including timing parameters, buffer sizes, and function references. It uses validation and adapter patterns to ensure configuration consistency.

Classes

IntegratorLoopSettings(loop_step_config, ...)

Compile-critical settings for the integrator loop.

class cubie.integrators.algorithms.IntegratorLoopSettings.IntegratorLoopSettings(loop_step_config: ~cubie.integrators.algorithms.LoopStepConfig.LoopStepConfig, buffer_sizes: ~cubie.outputhandling.output_sizes.LoopBufferSizes, precision: type = <class 'numpy.float32'>, compile_flags: ~cubie.outputhandling.output_config.OutputCompileFlags = OutputCompileFlags(save_state=False, save_observables=False, summarise=False, summarise_observables=False, summarise_state=False), dxdt_function: ~typing.Callable | None = None, save_state_func: ~typing.Callable | None = None, update_summaries_func: ~typing.Callable | None = None, save_summaries_func: ~typing.Callable | None = None)[source]

Bases: object

Compile-critical settings for the integrator loop.

This class manages configuration settings that are critical for compiling integrator loops, including timing parameters, buffer sizes, precision, and function references. The integrator loop is not the source of truth for these settings, so minimal setters are provided. Instead, there are update_from methods which extract relevant settings from other objects.

Parameters:

loop_step_config (LoopStepConfig) – Configuration object for loop step timing parameters.
buffer_sizes (LoopBufferSizes) – Configuration object specifying buffer sizes for integration.
precision (type, default=float32) – Numerical precision type (float32, float64, or float16).
compile_flags (OutputCompileFlags, default=OutputCompileFlags()) – Compilation flags for output handling.
dxdt_function (callable, optional) – Function that computes time derivatives of the state.
save_state_func (callable, optional) – Function for saving state values during integration.
update_summaries_func (callable, optional) – Function for updating summary statistics.
save_summaries_func (callable, optional) – Function for saving summary statistics.

Notes

This class serves as a data container for compile-time settings and provides convenient property access to nested configuration values. It validates input parameters to ensure consistency.