base_recorder.py

Class definition for BaseRecorder, the base class for all recorders.

class openmdao.recorders.base_recorder.BaseRecorder

Bases: object

Base class for all case recorders.

close()

Closes out unless it’s sys.stdout, sys.stderr, or StringIO. Note that a closed recorder will do nothing in record().

record_iteration(params, unknowns, resids, metadata)

Writes the provided data.

Args:

params : dict

Dictionary containing parameters. (p)

unknowns : dict

Dictionary containing outputs and states. (u)

resids : dict

Dictionary containing residuals. (r)

metadata : dict, optional

Dictionary containing execution metadata (e.g. iteration coordinate).

record_metadata(group)

Writes the metadata of the given group

Args:

group : System

System containing vectors

startup(group)

Prepare for a new run.

Args:

group : Group

Group that owns this recorder.