recording_iteration_stack.py

Management of iteration stack for recording.

class openmdao.recorders.recording_iteration_stack.Recording(name, iter_count, recording_requester)[source]

Bases: object

A class that acts as a context manager.

But with properly-timed values for abs and rel, where solvers are concerned.

Attributes

name (str) Name of object getting recorded.
iter_count (int) Current counter of iterations completed.
recording_requester (object) The object that wants to be recorded.
abs (float) Absolute error.
rel (float) Relative error.
__init__(name, iter_count, recording_requester)[source]

Initialize Recording.

Parameters:

name : str

Name of object getting recorded.

iter_count : int

Current counter of iterations completed.

recording_requester : object

The object that wants to be recorded.

openmdao.recorders.recording_iteration_stack.get_formatted_iteration_coordinate()[source]

Format the iteration coordinate into human-readable form.

‘rank0:pyoptsparsedriver|6|root._solve_nonlinear|6|mda._solve_nonlinear|6|mda.d1._solve_nonlinear|45’

Returns:

str :

the iteration coordinate formatted in our proprietary way.

openmdao.recorders.recording_iteration_stack.print_recording_iteration_stack()[source]

Print the record iteration stack.

Used for debugging.