assembled_jacobian.py

Define the AssembledJacobian class.

class openmdao.jacobians.assembled_jacobian.AssembledJacobian(matrix_class, system)[source]

Bases: openmdao.jacobians.jacobian.Jacobian

Assemble a global <Jacobian>.

__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, matrix_class, system)[source]

Initialize all attributes.

Parameters
matrix_classtype

Class to use to create internal matrices.

systemSystem

Parent system to this jacobian.

__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.

property msginfo

Return info to prepend to messages.

Returns
str

Info to prepend to messages.

set_complex_step_mode(self, active)[source]

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.

class openmdao.jacobians.assembled_jacobian.COOJacobian(system)[source]

Bases: openmdao.jacobians.assembled_jacobian.AssembledJacobian

Assemble sparse global <Jacobian> in Coordinate list format.

__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)[source]

Initialize all attributes.

Parameters
systemSystem

Parent system to this jacobian.

__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.

property msginfo

Return info to prepend to messages.

Returns
str

Info to prepend to messages.

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.

class openmdao.jacobians.assembled_jacobian.CSCJacobian(system)[source]

Bases: openmdao.jacobians.assembled_jacobian.AssembledJacobian

Assemble sparse global <Jacobian> in Compressed Col Storage format.

__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)[source]

Initialize all attributes.

Parameters
systemSystem

Parent system to this jacobian.

__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.

property msginfo

Return info to prepend to messages.

Returns
str

Info to prepend to messages.

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.

class openmdao.jacobians.assembled_jacobian.CSRJacobian(system)[source]

Bases: openmdao.jacobians.assembled_jacobian.AssembledJacobian

Assemble sparse global <Jacobian> in Compressed Row Storage format.

__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)[source]

Initialize all attributes.

Parameters
systemSystem

Parent system to this jacobian.

__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.

property msginfo

Return info to prepend to messages.

Returns
str

Info to prepend to messages.

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.

class openmdao.jacobians.assembled_jacobian.DenseJacobian(system)[source]

Bases: openmdao.jacobians.assembled_jacobian.AssembledJacobian

Assemble dense global <Jacobian>.

__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)[source]

Initialize all attributes.

Parameters
systemSystem

Parent system to this jacobian.

__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.

property msginfo

Return info to prepend to messages.

Returns
str

Info to prepend to messages.

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.