dumpcase.py

Class definition for DumpCaseRecorder, a recorder that prints human-readable text output to a stream.

class openmdao.recorders.dumpcase.DumpCaseRecorder(out='stdout')[source]

Bases: openmdao.recorders.baserecorder.BaseRecorder

Dumps cases in a “pretty” form to out, which may be a string or a file-like object (defaults to stdout). If out is stdout or stderr, then that standard stream is used. Otherwise, if out is a string, then a file with that name will be opened in the current directory. If out is None, cases will be ignored.

record(params, unknowns, resids, metadata)[source]

Dump the given run data in a “pretty” form.

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)[source]

Write out info that applies to the entire run.

Args:

group : Group

Group that owns this recorder.