base_case_reader.py

Base class for all CaseReaders.

class openmdao.recorders.base_case_reader.BaseCaseReader(filename, pre_load=False)[source]

Bases: object

Base class of all CaseReader implementations.

Attributes

problem_metadata (dict) Metadata about the problem, including the system hierachy and connections.
solver_metadata (dict) The solver options for each solver in the recorded model.
system_metadata (dict) Metadata about each system in the recorded model, including options and scaling factors.
__init__(filename, pre_load=False)[source]

Initialize.

Parameters:
filename : str

The path to the file containing the recorded data.

pre_load : bool

If True, load all the data into memory during initialization.

get_case(case_id, recurse=True)[source]

Get case identified by case_id.

Parameters:
case_id : str or int

The unique identifier of the case to return or an index into all cases.

recurse : bool, optional

If True, will return all successors to the case as well.

Returns:
dict

The case identified by case_id

get_cases(source, recurse=True, flat=False)[source]

Iterate over the cases.

Parameters:
source : {‘problem’, ‘driver’, component pathname, solver pathname, iteration_coordinate}

Identifies which cases to return.

recurse : bool, optional

If True, will enable iterating over all successors in case hierarchy

flat : bool, optional

If False and there are child cases, then a nested ordered dictionary is returned rather than an iterator.

Returns:
list or dict

The cases identified by source

list_source_vars(source)[source]

List of all inputs and outputs recorded by the specified source.

Parameters:
source : {‘problem’, ‘driver’, component pathname, solver pathname}

Identifies the source for which to return information.

Returns:
dict

{‘inputs’:[list of keys], ‘outputs’:[list of keys]}. Does not recurse.

list_sources()[source]

List of all the different recording sources for which there is recorded data.

Returns:
list

One or more of: problem, driver, <component hierarchy location>, <solver hierarchy location>