Private API

This page lists non-exported (internal) symbols of CTFlows.Integrators.


From CTFlows.Integrators

__default_sciml_algorithm [Function]

CTFlows.Integrators.__default_sciml_algorithmFunction
__default_sciml_algorithm(
    _::Type{<:CTBase.Core.AbstractTag}
) -> Tsit5{typeof(OrdinaryDiffEqCore.trivial_limiter!), typeof(OrdinaryDiffEqCore.trivial_limiter!), FastBroadcast.Serial}

Return the default SciML ODE algorithm for the given tag type.

This stub returns missing for the abstract tag type. The actual implementation for Tsit5Tag is provided by CTFlowsOrdinaryDiffEqTsit5.

Returns

  • missing: Default stub implementation.

See also: Integrators.SciML, Integrators.Tsit5Tag.

__default_sciml_algorithm(
    _::Type{<:CTFlows.Integrators.Tsit5Tag}
) -> Tsit5{typeof(OrdinaryDiffEqCore.trivial_limiter!), typeof(OrdinaryDiffEqCore.trivial_limiter!), FastBroadcast.Serial}

Return the default SciML ODE algorithm (Tsit5) for Tsit5Tag type.

Overrides the stub implementation in src/Integrators/sciml.jl that returns missing.

Returns

  • Tsit5: The default Tsit5 algorithm.

Notes

  • This function is called by the SciML metadata when Tsit5Tag type is used.
  • Users can override this by explicitly passing the alg option.

See also: CTFlows.Integrators.SciML, CTFlows.Integrators.Tsit5Tag.

build_options [Function]

CTFlows.Integrators.build_optionsFunction
build_options(
    integrator::CTFlows.Integrators.AbstractIntegrator,
    config::Union{Nothing, CTFlows.Configs.AbstractConfig}
) -> Dict{Symbol, Any}

Build solver options dict for the given configuration.

Arguments

  • integrator::AbstractIntegrator: The integrator strategy.
  • config::Union{CTFlows.Configs.AbstractConfig, Nothing}: The integration configuration (or Nothing for fallback).

Returns

  • Dict{Symbol,Any}: Resolved solver options for the given configuration.

Throws

  • CTBase.Exceptions.NotImplemented: If not implemented by the concrete type.

See also: CTFlows.Integrators.AbstractIntegrator, CTFlows.Integrators.build_problem, CTFlows.Integrators.solve_problem.

build_options(
    integ::CTFlows.Integrators.SciML,
    config::CTFlows.Configs.AbstractEndPointConfig
) -> Dict{Symbol, Any}

Return pre-computed solver options for point integration configs.

For point configs (e.g., StateEndPointConfig, HamiltonianEndPointConfig), options like dense, save_everystep, and save_start are set to false to minimize memory since only the final state is needed.

Arguments

  • integ::SciML: The SciML integrator with pre-computed option caches.
  • config::Configs.AbstractEndPointConfig: The point configuration.

Returns

  • Dict{Symbol,Any}: Pre-computed options optimized for point integration.

See also: CTFlows.Integrators.build_options, CTFlows.Integrators.SciML, CTFlows.Configs.AbstractEndPointConfig.

build_options(
    integ::CTFlows.Integrators.SciML,
    config::CTFlows.Configs.AbstractTrajectoryConfig
) -> Dict{Symbol, Any}

Return pre-computed solver options for trajectory integration configs.

For trajectory configs (e.g., StateTrajectoryConfig, HamiltonianTrajectoryConfig), options like dense, save_everystep, and save_start are set to true to enable full trajectory storage and interpolation.

Arguments

  • integ::SciML: The SciML integrator with pre-computed option caches.
  • config::Configs.AbstractTrajectoryConfig: The trajectory configuration.

Returns

  • Dict{Symbol,Any}: Pre-computed options optimized for trajectory integration.

See also: CTFlows.Integrators.build_options, CTFlows.Integrators.SciML, CTFlows.Configs.AbstractTrajectoryConfig.

build_options(
    integ::CTFlows.Integrators.SciML,
    config::Nothing
) -> Dict{Symbol, Any}

Return pre-computed solver options for fallback case (Nothing).

Defaults to trajectory options when no configuration is provided.

Arguments

  • integ::SciML: The SciML integrator with pre-computed option caches.
  • config::Nothing: No configuration provided (fallback).

Returns

  • Dict{Symbol,Any}: Pre-computed options for trajectory integration (fallback).

See also: CTFlows.Integrators.build_options, CTFlows.Integrators.SciML.