Solver Recording

Solver recording is useful when you want to record the iterations within a solver. The recorder can capture the values of states, errors, and residuals as the solver converges.

Option Default Acceptable Values Acceptable Types Description Deprecation
excludes [] N/A ['list'] Patterns for vars to exclude in recording. (processed post-includes) Paths are relative to solver's Group. Uses fnmatch wildcardsN/A
includes ['*'] N/A ['list'] Patterns for variables to include in recording. Paths are relative to solver's Group. Uses fnmatch wildcards N/A
record_abs_error True [True, False] ['bool'] Set to True to record absolute error at the solver level N/A
record_inputs True [True, False] ['bool'] Set to True to record inputs at the solver level N/A
record_metadata True [True, False] ['bool'] Deprecated. Recording of metadata will always be done The recording option, record_metadata, on Solver is deprecated. Recording of metadata will always be done
record_outputs True [True, False] ['bool'] Set to True to record outputs at the solver level N/A
record_rel_error True [True, False] ['bool'] Set to True to record relative error at the solver level N/A
record_solver_residualsFalse [True, False] ['bool'] Set to True to record residuals at the solver level N/A

Note

Note that the excludes option takes precedence over the includes option.

Note

The paths given in the includes and excludes options are relative to the Group that the solver is attached to.

Note

It is currently not possible to record linear solvers.

Solver Recording Example

import openmdao.api as om
from openmdao.test_suite.components.sellar import SellarDerivatives

prob = om.Problem(model=SellarDerivatives())
prob.setup()

recorder = om.SqliteRecorder("cases.sql")

solver = prob.model.nonlinear_solver
solver.add_recorder(recorder)
solver.recording_options['record_abs_error'] = True
solver.options['use_apply_nonlinear'] = True

prob.run_model()
NL: NLBGS Converged in 7 iterations
prob.cleanup()
cr = om.CaseReader("cases.sql")
solver_cases = cr.list_cases('root.nonlinear_solver')
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|0
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|1
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|2
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|3
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|4
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|5
solver
rank0:root._solve_nonlinear|0|NonlinearBlockGS|6
for case_id in solver_cases:
    print(cr.get_case(case_id).abs_err)
2.2545141061171243
0.043663258684468076
0.0008635223885384846
1.707062189737485e-05
3.3746495375908125e-07
6.671260877055829e-09
1.318802844707534e-10