top

# Documentation

In OpenOCL you can solve a large class of optimal control problems including non-linear, continuous-time, multi-stage, and constrained problems, which can appear in the context of trajectory optimization and model predictive control. The types of dynamical systems that are supported are all systems that can be described by ordinary differential equations or differential algebraic equations.

We introduced some new concepts that should make it as easy as possible for you to model optimal control problems, in particular the notion of grid-costs and grid-constraints that can be very handy when implementing tracking problems. In the following we give a short introduction to the concepts used and introduced in OpenOCL.

## Cost terms and constraints

We support bounds that hold along the entire trajectory, and grid-constraints that hold only at specific gridpoints in the discretized trajectory.

For the cost terms you can specify path-costs that are integrated along the trajectory (also known as Lagrange term), and grid-costs that can be specified for specific points on the discretized trajectory.

### Simulator(system, options)

Performs simulations of the system by integrating the system dynamics.

``````simulator = Simulator(PendulumSystem);

x0 = simulator.getStates();
x0.p = [0;1];
x0.v = [-0.5;-1];

p = simulator.getParameters();
p.m = 1;
p.l = 1.5;

t = linspace(0,4,20);

% apply constant force
uVec = simulator.getControlsVec(20);
uVec.F = 10;

[xVec,zVec,uVec] = simulator.simulate(x0,t,uVec,p);
``````

#### Arguments:

system
The system dynamics
options (struct, optional)
Options struct, can be created with Simulator.getOptions(). Defaults to empty struct.

#### Returns:

(Simulator)
the Simulator object.

#### Methods

getControlsVec(N)
Gives you a structured variable that allows you to specify an open-loop control input by setting values to the variable. The default value for all variables is zero.
##### Arguments:
N (int)
Number of control intervals
##### Returns:
The control vector.
getStates()
Returns a structured state variable that you can use to pass as the initial state to the simulator. All variable values default to zero.
##### Returns:
The states.
getParameters()
Returns a structured state variable that allows you to set parameters for the simulation. All parameter values default to zero.
##### Returns:
The parameters.
simulate(x0, times, p, uVec)
Simulates the system for the given time interval.
##### Arguments:
x0
The initial state.
times (numeric)
Times vector. The system will be evaluated at the given time points.
p
The parameters set to numeric values.
uVec (OclVariable, optional)
Controls vector with open-loop controls. Defaults to zero valued controls.
##### Returns:
The state trajectory.
The trajectory of algebraic variables.
The control inputs applied to the system.

### ocl.Constraint()

The constraint handler allows to add constraints to the optimal control problem definition.

#### Methods

Adds a constraint to the optimal control problem.
##### Arguments:
lhs (OclVariable or Matlab matrix)
Left hand side of the constraint equation
op (char)
One of the following operators as a string: ‘<=’, ‘==’, ‘>=’
rhs (OclVariable or Matlab matrix)
Right hand side of the constraint equation

### ocl.Cost()

The cost handler allows to add cost terms in a cost function definition.

#### Methods

##### Arguments:
cost (OclVariable or Matlab matrix)
Scalar variable containing the cost

### ocl.DaeHandler()

The differential equations handler allows to specify the system equations which can be of ODE and DAE type.

#### Methods

setODE(id, equation)
Adds a differential equation to the system. Note that for every state variable defined in the variables function, a differential equation must be specified.
##### Arguments:
id (char)
Name of the state variable for that the differential equation is given.
equation (OclVariable or Matlab matrix)
The equation specifies the derivative of a state variable. Right hand side of the differential equation dot(x) = f(x,z,u,p) for state variable x.
setAlgEquation(equation)
Adds an algebraic equation to the system. Note that in order to be able to simulate the system, the total number of rows of the algebraic equations needs to be equal to the total number/dimension of algebraic variables.
##### Arguments:
equation (OclVariable or Matlab matrix)
Algebraic equation g in the form g(x,z,u,p)=0

### ocl.Solver(T, vars, dae, pathcosts, gridcosts, gridconstraints)

Creates a solver object that discretizes the given optimal control problem, and calls the underlying optimizer.

``````function vanderpol
solver = ocl.Solver(END_TIME, @varsfun, @daefun, @pathcosts, 'N', 30);

solver.setInitialBounds('x',     0);
solver.setInitialBounds('y',     1);

initialGuess = solver.getInitialGuess();
initialGuess.states.x.set(-0.2);

[solution,timepoints] = solver.solve(initialGuess);

% initial guess, solution and times have
% the following structure:
solution.states       % state trajectory
solution.integrator   % integrator variables trajectory
solution.controls     % control trajectory
solution.parameters   % parameters
timepoints.states     % time points of states
timepoints.controls   % time points of controls

% plotting of control and state p trajectory:
oclPlot(timepoints.controls, solution.controls.u)
oclPlot(timepoints.states, solution.states.p)
end

function varsfun(svh)
end

function daefun(daeh,x,~,u,~)
daeh.setODE('x', (1-x.y^2)*x.x - x.y + u.F);
daeh.setODE('y', x.x);
end

function pathcosts(ch,x,~,u,~)
end
``````

#### Arguments:

T (numeric or [])
The end time/horizon length of the optimal control problem. If your system equations are expressed as function of an independent variable other than time, `T` represents not the end time but the endpoint of the integration over the independent variable. If you would like to optimize for time, time optimal control, pass the empty list `[]`
vars = @(vars_handler)[]
System variables function. Optional, defaults to an empty function handle.
dae = @(dae_handler,x,z,u,p)[]
DAE (system equations) function. Optional, defaults to an empty function handle.
pathcosts = @(cost_handler,x,z,u,p) 0
Path-costs function. Optional, defaults to a function handle returning 0.
gridcosts = @(cost_handler,k,K,x) 0
Grid-costs function. Optional, defaults to a function handle returning 0.
gridconstraints = @(constraints_handler,k,K,x) []
Grid-constraints function. Optional, defaults to an empty function handle.

(ocl.Solver)
A solver object.

#### Methods

getInitialGuess()
Use this method to retrieve a first initial guess that is generated from the bounds. You can further modify this initial guess to improve the solver performance.
##### Returns:
Structured variable for setting the initial guess
solve(initialGuess)
Calls the solver and starts doing iterations.
##### Arguments:
initialGuess
Provide a good initial guess
##### Returns:
The solution of the OCP
Grid points of the solution
setBounds(id, lb, ub)
Sets a bound on a variable for the whole trajectory. If only the lower bound is given, it will be `lb==ub`. A bound can be either scalar or a vector with `length(lb)==length(ub)==N+1` for states and `length(lb)==length(ub)==N` for control variables.
##### Arguments:
id (char)
The variable id
lb (numeric)
The lower bound
ub (numeric,optional)
The upper bound
setInitialBounds(id, lb, ub)
Sets an initial bound on a variable. If only the lower bound is given, it will be `lb==ub`. A bound can be either scalar or a vector with `length(lb)==length(ub)==N+1` for states and `length(lb)==length(ub)==N` for control variables.
##### Arguments:
id (char)
The variable id
lb (numeric)
The lower bound
ub (numeric,optional)
The upper bound
setEndBounds(id, lb, ub,optional)
Sets an end bound on a variable. If only the lower bound is given, it will be `lb==ub`. A bound can be either scalar or a vector with `length(lb)==length(ub)==N+1` for states and `length(lb)==length(ub)==N` for control variables.
##### Arguments:
id (char)
The variable id
lb (numeric)
The lower bound
ub,optional (numeric)
The upper bound

### ocl.Solver(stages, transitions)

Creates a solver object for multi-stage problems.

``````
``````

#### Arguments:

stages = {} (cell<ocl.Stage>)
List (cell-array) of stages. Optional, defaults to empty list.
transitions = {} (cell<ocl.Transition>)
List (cell-array) of transitions. Optional, defaults to empty list.

(ocl.Solver)
A solver object.

#### Methods

getInitialGuess()
Use this method to retrieve a first initial guess that is generated from the bounds. You can further modify this initial guess to improve the solver performance.
##### Returns:
Structured variable for setting the initial guess
solve(initialGuess)
Calls the solver and starts doing iterations.
##### Arguments:
initialGuess
Provide a good initial guess
##### Returns:
The solution of the OCP
Time points of the solution

### ocl.Stage(T, vars, dae, pathcosts, gridcosts, gridconstraints)

The definition of a Stage.

``````stage = ocl.Stage([], @vars, @ode, 'N', 10, 'd', 2);

% Function definitions can be in the same file
% (if the main script is wrapped by a function)
% or in separate files:
function vars(sh)
end

function ode(sh,x,~,~,~)
sh.setODE('s', x.v);
sh.setODE('v', -10);
end
``````

#### Arguments:

T (numeric or [])
The end time/horizon length of the optimal control problem. If your system equations are expressed as function of an independent variable other than time, `T` represents not the end time but the endpoint of the integration over the independent variable. If you would like to optimize for time, time optimal control, pass the empty list `[]`
vars = @(vars_handler)[]
System variables function. Optional, defaults to an empty function handle.
dae = @(dae_handler,x,z,u,p)[]
DAE (system equations) function. Optional, defaults to an empty function handle.
pathcosts = @(cost_handler,x,z,u,p) 0
Path-costs function. Optional, defaults to a function handle returning 0.
gridcosts = @(cost_handler,k,K,x) 0
Grid-costs function. Optional, defaults to a function handle returning 0.
gridconstraints = @(constraints_handler,k,K,x) []
Grid-constraints function. Optional, defaults to an empty function handle.

### ocl.System(vars, dae)

A dynamical system is defined by implementing functions for the system variables and equations, and creating an OclSystem passing the function pointers. You need to implement two functions, one for defining the system variables, and a second one for defining the system equations. The system is created by passing the handles of the two functions to the constructor of OclSystem. A system can be used width an ocl.Simulator.

``````sys = OclSystem(@sysVars,@sysEq);

% Function definitions can be in the same file
% (if the main script is wrapped by a function)
% or in separate files:
function sysVars(svh)
end
function sysEq(seh,x,z,u,p)
seh.setODE('p',(1-x.v^2)*x.p-x.v+u.u);
seh.setODE('v',x.p);
end
``````

#### Arguments:

vars = @(vars_handler)[]
System variables function. Optional, defaults to an empty function handle.
dae = @(dae_handler,x,z,u,p)[]
DAE (system equations) function. Optional, defaults to an empty function handle.

### OclVariable()

The OclVariable type(or CasadiVariable in the CasADi backend) is the basic structure to retrieve, store, modify structured optimization variables. You can access subvariables by their name like the state trajectory or the control variables.

``````% v is a solution of an OCP
% p=[px;py;pz] is of size 3x1
% p trajectory is of size 3x1x(N+1)
% F trajectory is of size 1x1xN
% with N control intervals
p = v.states.p;     % get state p trajectory
F = v.controls.F;   % get control F trajectory

% set all 3x1 p states to the same value
v.states.p = [3;2;1];
% set p states 4 and 5 in the trajectory
v.states.p(:,:,4:5) = [1,2,3;4,5,6].';
% or (with the same result)
v.states.p(:,:,4:5) = {[1;2;3],[4;5;6]};
% or even
v.states.p(:,:,4:5) = {[1,2,3],[4,5,6]};

% set all px values of p in state trajectory
v.states.p(1,:,:) = 4;

% plotting of state p trajectory:
plot(t.states.value,v.states.p.value)
``````

#### Methods

get(id)
Alternative syntax: var.id Gets a sub-variable of a variable. You can use the shorthand notation with the dot operator, e.g.: solution.states.x
##### Arguments:
id (char)
Name of the state variable
##### Returns:
(OclVariable)
the sub-variable of the given variable.
set(value)
Alternative syntax: var = value Sets a value to the variable.
##### Arguments:
value (numeric)
The value to be set. The value either has to be of the same dimension as the variable or if possible it will be repeated in some dimensions to fit the variable. Scalar values will be set to all entries of the variable. You can use the shorthand notation, e.g. initialGuess.states.x = [1,2,3]
slice(dim1, dim2, dim3)
Alternative syntax: var(dim1,dim2,dim3) Gets a slice of a variable. You can slice a variable the same way as you would index a matrix in Matlab/Octave which means linear indexing is also possible.
##### Arguments:
dim1 (int, :, end)
indizes for the first dimension. The indizes can be scalar, integer arrays, or you can use : or end.
dim2 (int, :, end, optional)
indizes for the second dimension. The indizes can be scalar, integer arrays, or you can use : or end.
dim3 (int, :, end, optional)
indizes for the third dimension. The indizes can be scalar, integer arrays, or you can use : or end.
##### Returns:
(OclVariable)
the sliced variable.
value()
Get the value of the variable. This is particularly useful if you want to plot the numeric values of the variable, for example for the solution. In system and OCP definition this gives you the underlying symbolic values.
##### Returns:
the underlying value of the variable. The value can be either numeric (for initial guess and solution) or symbolic (in system/ocp definitions).
disp()
Display function of OclVariable. It shows the size of the variable, the names of the children variables, and a part of the value. The output of an OCP initial guess variable looks similar to:
``````Variable:
Size: [3681 1]
Type: OclStructure
Children: states, integrator, controls, parameters, time
Value: [100;2;1;0;0;0;0;0;0;0;0;0;0;0;0..]
``````

### ocl.VarsHandler()

The variables handler allows to specify the system variables, its dimensions and bounds.

#### Methods

Adds a state variable to the system.
##### Arguments:
id (char)
Name of the state variable
s (int, optional)
Size of the state variable. Scalar, vector, and matrix valued variables are allowed. If a scalar value s is given, the size of the variable will be [s,1]. Defaults to [1,1].
lb=-inf (numeric, optional)
Lower bound on the variable. This value can be overwritten when you specify bounds for OclSolver with solver.setBound. Defaults to -inf.
ub=inf (numeric, optional)
Upper bound on the variable. This value can be overwritten when you specify bounds for OclSolver with solver.setBound. Defaults to inf.
Adds an algebraic variable to the system.
##### Arguments:
id (char)
Name of the algebraic variable
s (int, optional)
Size of the algebraic variable. Scalar, vector, and matrix valued variables are allowed. If a scalar value s is given, the size of the variable will be [s,1]. Defaults to [1,1].
lb=-inf (numeric, optional)
Lower bound on the variable. This value can be overwritten when you specify bounds for OclSolver with solver.setBound. Defaults to -inf.
ub=inf (numeric, optional)
Upper bound on the variable. This value can be overwritten when you specify bounds for OclSolver with solver.setBound. Defaults to inf.
Adds an control input to the system.
##### Arguments:
id (char)
Name of the control variable
s (int, optional)
Size of the control variable. Scalar, vector, and matrix valued variables are allowed. If a scalar value s is given, the size of the variable will be [s,1]. Defaults to [1,1].
lb=-inf (numeric, optional)
Lower bound on the variable. This value can be overwritten when you specify bounds for OclSolver with solver.setBound. Defaults to -inf.
ub=inf (numeric, optional)
Upper bound on the variable. This value can be overwritten when you specify bounds for OclSolver with solver.setBound. Defaults to inf.
##### Arguments:
id (char)
Name of the parameter
s (int, optional)
Size of the control variable. Scalar, vector, and matrix valued variables are allowed. If a scalar value s is given, the size of the variable will be [s,1]. Defaults to [1,1].
default=[] (numeric, optional)
Default value for the parameter. This value can be overwritten when you specify the parameter for OclSolver with solver.setParameter. Defaults to unbounded.

### @(constraints_handler,k,K,x)(constraints_handler, k, K, X)

Function handle signature for point constraints function.

#### Arguments:

constraints_handler
Constraints handler
k (int)
current grid point index
K (int)
last grid point index
X
State variable

### @(cost_handler,k,K,x)(cost_handler, k, K, X)

Function handle signature for point cost function.

#### Arguments:

cost_handler (ocl.Cost)
cost_handler handler
k (int)
current grid point index
K (int)
last grid point index
X
State variable

### @(cost_handler,x,z,u,p)(cost_handler, x, z, u, p)

Function handle signature for the path cost function.

#### Arguments:

cost_handler (ocl.Cost)
Cost handler
x
State variables
z
Algebraic states
u
Controls
p
Parameters

### @(dae_handler,x,z,u,p)(dae_handler, x, z, u, p)

Function handle signature for DAE function.

dae_handler
DAE handler
x
State variables
z
Algebraic states
u
Controls
p
Parameters

### @(vars_handler)(vars_handler)

Function handle signature for system variables function.

#### Arguments:

vars_handler
Variables handler

Creates an options struct for ocl.Solver. Check the casadi documentation and the ipopt documentation to see which options are available. The `ipopt` options can be set in ‘casadi_options.ipopt’. The default values are the following:
``````casadi_options = struct;