dictionary_jacobian.py

Define the DictionaryJacobian class.

class openmdao.jacobians.dictionary_jacobian.DictionaryJacobian(system, **kwargs)[source]

Bases: openmdao.jacobians.jacobian.Jacobian

No global <Jacobian>; use dictionary of user-supplied sub-Jacobians.

__contains__(self, key)

Return whether there is a subjac for the given promoted or relative name pair.

Parameters
key(str, str)

Promoted or relative name pair of sub-Jacobian.

Returns
boolean

return whether sub-Jacobian has been defined.

__getitem__(self, key)

Get sub-Jacobian.

Parameters
key(str, str)

Promoted or relative name pair of sub-Jacobian.

Returns
ndarray or spmatrix or list[3]

sub-Jacobian as an array, sparse mtx, or AIJ/IJ list or tuple.

__init__(self, system, **kwargs)[source]

Initialize all attributes.

Parameters
systemSystem

Parent system to this jacobian.

**kwargsdict

options dictionary.

__setitem__(self, key, subjac)

Set sub-Jacobian.

Parameters
key(str, str)

Promoted or relative name pair of sub-Jacobian.

subjacint or float or ndarray or sparse matrix

sub-Jacobian as a scalar, vector, array, or AIJ list or tuple.

set_complex_step_mode(self, active)

Turn on or off complex stepping mode.

When turned on, the value in each subjac is cast as complex, and when turned off, they are returned to real values.

Parameters
activebool

Complex mode flag; set to True prior to commencing complex step.