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(params, unknowns, resids, metadata)

Records the requested variables. This method must be defined in all recorders.

Args:

params : VecWrapper

VecWrapper containing parameters. (p)

unknowns : VecWrapper

VecWrapper containing outputs and states. (u)

resids : VecWrapper

VecWrapper containing residuals. (r)

metadata : dict

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

startup(group)

Prepare for a new run.

Args:

group : Group

Group that owns this recorder.