yaocptool.modelling.mixins package

Submodules

yaocptool.modelling.mixins.algebraic_mixin module

class AlgebraicMixin(**kwargs)

Bases: object

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

create_algebraic_variable(name='y', size=1)

Create a new algebraic variable with the name “name” and size “size”. Size can be an int or a tuple (e.g. (2,2)). However, the new algebraic variable will be vectorized (casadi.vec) to be included in the algebraic vector (model.y).

Parameters:

• name (str) –
• size (int||tuple) –

Returns:

find_algebraic_variable(x, u, guess=None, t=0.0, p=None, theta_value=None, rootfinder_options=None)

include_algebraic(var, alg=None)

include_equations(*args, **kwargs)

n_y

remove_algebraic(var, eq=None)

replace_variable(original, replacement)

y_names

yaocptool.modelling.mixins.control_mixin module

class ControlMixin(**kwargs)

Bases: object

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

control_is_parametrized(u)

Check if the control “u” is parametrized

Parameters:u (casadi.SX) – Rtype bool:

create_control(name='u', size=1)

Create a new control variable name “name” and size “size”. Size can be an int or a tuple (e.g. (2,2)). However, the new control variable will be vectorized (casadi.vec) to be included in the control vector (model.u).

Parameters:

• name – str
• size – int

Returns:

create_input(name='u', size=1)

Same as the “model.create_control” function. Create a new control/input variable name “name” and size “size”. Size can be an int or a tuple (e.g. (2,2)). However, the new control variable will be vectorized (casadi.vec) to be included in the control vector (model.u).

Parameters:

• name – str
• size – int

Returns:

include_control(var)

n_u

n_u_par

parametrize_control(u, expr, u_par=None)

Parametrize a control variables so it is a function of a set of parameters or other model variables.

Parameters:

• u (list|casadi.SX) –
• expr (list|casadi.SX) –
• u_par (list|casadi.SX) –

remove_control(var)

replace_variable(original, replacement)

u_names

yaocptool.modelling.mixins.parameter_mixin module

class ParameterMixin(**kwargs)

Bases: object

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

create_parameter(name='p', size=1)

Create a new parameter name “name” and size “size”

Parameters:

• name – str
• size – int

Returns:

create_theta(name='theta', size=1)

Create a new parameter name “name” and size “size”

Parameters:

• name – str
• size – int

Returns:

include_parameter(p)

include_theta(theta)

n_p

n_theta

p_names

remove_parameter(var)

remove_theta(var)

theta_names

yaocptool.modelling.mixins.state_mixin module

class StateMixin(**kwargs)

Bases: object

__init__(**kwargs)

Initialize self. See help(type(self)) for accurate signature.

create_state(name='x', size=1)

Create a new state with the name “name” and size “size”. Size can be an int or a tuple (e.g. (2,2)). However, the new state will be vectorized (casadi.vec) to be included in the state vector (model.x).

Parameters:

• name – str
• size – int|tuple

Returns:

include_equations(*args, **kwargs)

include_state(var, ode=None, x_0=None)

n_x

ode

remove_state(var, eq=None)

replace_variable(original, replacement)

x_names

Module contents