pg_utils.eigen.reduce_dimensions

pg_utils.eigen.reduce_dimensions(read_from: Union[str, Tuple[LabeledCollection, List]], save_to: Optional[str] = None, overwrite: bool = False, verbose: int = 0) → LabeledCollection[source]

Eigensolver step Ib: reduce dimension of the system

Parameters:

  • read_from (Union[str, Tuple[base.LabeledCollection, List]]) – file name to be loaded as the starting set of equations.

  • save_to (Optional[str]) – output json file name, if None (default), no file will be written.

  • overwrite (bool) – whether to overwrite existing file upon output, False by default.

  • verbose (int) – verbosity level, default to 0.

Returns:

a set of reduced dimensional equations

..warning:

The current :func:`form_equations` function already
contains functionality to reduce system into low dimensional
forms. As a result, the plan is to phase out this function.