gemseo / core / derivatives

Show inherited members

jacobian_operator module

Abstraction of Jacobian as linear operators.

class gemseo.core.derivatives.jacobian_operator.JacobianOperator(*args, **kwargs)[source]

Bases: LinearOperator

The Jacobian of a discipline as linear operator.

Initialize this LinearOperator.

To be called by subclasses. dtype may be None; shape should be convertible to a length-2 tuple.

Parameters:
  • dtype (dtype) – The data type of the Jacobian.

  • shape (tuple[int, ...]) – The shape of the Jacobian.

copy()[source]

Create a shallow copy of the Jacobian operator.

Returns:

A shallow copy of the Jacobian operator.

Return type:

JacobianOperator

get_matrix_representation()[source]

Compute the matrix representation of the Jacobian.

Returns:

The matrix representation of the Jacobian.

Return type:

ndarray

shift_identity()[source]

Substract the identity to the Jacobian operator.

Returns:

The Jacobian operator shifted by minus the identity.

Return type:

_SubJacobianOperator

property T: _AdjointJacobianOperator

The transpose of the Jacobian operator.

Returns:

The transpose of the Jacobian operator.

property real: _RealJacobianOperator

The real casting of the Jacobian operator output.