getResidual

getResidual#

Model.getResidual()#

Return the residual vector from the last iteration.

Returns:

A list containing the residual vector.

Note

The specific form of the residual is documented in the pages for Static and Transient, respectively.

Example#

The following example is used to set the variable residual equal to the residual vector from the last iteration.

residual = model.getResidual()