Skip to content

Migrating from 0.5 ​

The breaking changes since 0.5, with how to update your code. The full list is in BREAKING.md.

An OptimalControl problem is the continuous problem ​

A problem of the OptimalControl modelings returns a Problem: the continuous model and its initial guess. It no longer discretizes, and no longer takes a description or grid_size: the discretization, the modeler and the solver are chosen in solve.

julia
docp = beam(OptimalControlBackend(), :adnlp; grid_size=500)        
nlp = nlp_model(docp)                                              
pb = beam(OptimalControlBackend())                                 
sol = solve(model(pb), :collocation, :adnlp, :ipopt;               
            init=initial_guess(pb), grid_size=500,                 
            scheme=:trapeze)                                       

metadata(:problem) is problem_metadata(:problem) ​

metadata is now the function OptimalControl reexports; on a built problem it gives the metadata of that problem.

julia
metadata(:beam)[:grid_size]                                        
problem_metadata(:beam)[:grid_size]                                
metadata(beam(OptimalControlBackend()))[:grid_size]                

The grid and the references depend on the modeling ​

The modelings are independent: each has its default grid (the grid of the problem, coarser for ModelingToolkit, solved by shooting) and its reference objectives, computed from its own solves. The functions take the backend.

julia
grid_size_data(:beam)                                              
grid_size_data(:beam, OptimalControlBackend())                     
OptimalControlProblems.reference_objective(:beam)                  
OptimalControlProblems.reference_objective(:beam, JuMPBackend())   

solution_kind, references and best_reference take the backend the same way.

Errors ​

Passing parameters to a problem that has none throws CTBase.Exceptions.PreconditionError, instead of CTBase.UnauthorizedCall.

Accessors ​

time_grid, state, control, costate, variable, objective, iterations and the *_components / *_dimension accessors are the functions of CTModels that OptimalControl reexports: using OptimalControl, OptimalControlProblems brings no name conflict, and they work on JuMP models as on OptimalControl solutions.