Private API

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


From CTFlowsSciMLIntegrator

SciMLIntegrationResult [Struct]

CTFlowsSciMLIntegrator.SciMLIntegrationResultType
struct SciMLIntegrationResult{S<:SciMLBase.AbstractODESolution} <: CTFlows.Integrators.AbstractIntegrationResult

Integration result from a SciML solver.

Wraps a SciMLBase.AbstractODESolution and implements the AbstractIntegrationResult interface required by the Trajectories layer.

Fields

  • ode_sol::S: The raw SciML ODE solution.

_AUTO_OPTION_KEYS [Constant]

CTFlowsSciMLIntegrator._AUTO_OPTION_KEYSConstant

Tuple of option keys that support automatic resolution based on configuration type.

These options use the :auto sentinel value in their metadata and are resolved dynamically during integrator construction:

  • For StateEndPointConfig: set to false (only final state needed)
  • For StateTrajectoryConfig: set to true (full trajectory storage needed)

Users can override automatic resolution by providing explicit true/false values when constructing the integrator.

Returns

  • Tuple{Symbol, ...}: The tuple of option keys supporting automatic resolution.

See also: CTFlows.Integrators.build_sciml_integrator, CTFlows.Configs.StateEndPointConfig, CTFlows.Configs.StateTrajectoryConfig.

_check_retcode [Function]

CTFlowsSciMLIntegrator._check_retcodeFunction
_check_retcode(sol, unsafe)

Check the return code of a SciML ODE solution and throw SolverFailure if integration failed.

Arguments

  • sol: A SciML ODE solution with a retcode field.
  • unsafe::Bool: If true, bypass retcode checking; if false, throw on failure.

Throws

  • CTBase.Exceptions.SolverFailure: If !unsafe and the retcode indicates failure.

See also: CTFlows.Integrators.solve_problem.