constraint.py¶
ConstraintComp is now deprecated.
-
class
openmdao.components.constraint.
ConstraintComp
(expr, out='out')[source]¶ Bases:
openmdao.components.exec_comp.ExecComp
ConstraintComp is deprecated. Please see the basic tutorial for more information.
A Component that represents an equality or inequality constraint.
Args: expr : str
Constraint expression containing an operator that is one of [‘<’, ‘>’, ‘<=’, ‘>=’, ‘=’].
out : str, optional
Name of the output variable containing the result of the constraint equation. Default is ‘out’.
Options: deriv_options[‘type’] : str(‘user’)
Derivative calculation type (‘user’, ‘fd’, ‘cs’) Default is ‘user’, where derivative is calculated from user-supplied derivatives. Set to ‘fd’ to finite difference this system. Set to ‘cs’ to perform the complex step if your components support it.
deriv_options[‘form’] : str(‘forward’)
Finite difference mode. (forward, backward, central)
deriv_options[‘step_size’] : float(1e-06)
Default finite difference stepsize
deriv_options[‘step_calc’] : str(‘absolute’)
Set to absolute, relative
deriv_options[‘check_type’] : str(‘fd’)
Type of derivative check for check_partial_derivatives. Set to ‘fd’ to finite difference this system. Set to ‘cs’ to perform the complex step method if your components support it.
deriv_options[‘check_form’] : str(‘forward’)
Finite difference mode: (“forward”, “backward”, “central”) During check_partial_derivatives, the difference form that is used for the check.
deriv_options[‘check_step_calc’] : str(‘absolute’,)
Set to ‘absolute’ or ‘relative’. Default finite difference step calculation for the finite difference check in check_partial_derivatives.
deriv_options[‘check_step_size’] : float(1e-06)
Default finite difference stepsize for the finite difference check in check_partial_derivatives”
deriv_options[‘linearize’] : bool(False)
Set to True if you want linearize to be called even though you are using FD.