pg_utils.eigen.form_equations

pg_utils.eigen.form_equations(eq_mode: str = 'pg', components: ~typing.List = ['Lorentz'], timescale: str = 'Alfven', bg: ~pg_utils.pg_model.bg_fields.BackgroundFieldMHD = <pg_utils.pg_model.bg_fields.BackgroundHydro object>, deactivate: ~typing.List[int] = [], save_to: ~typing.Optional[str] = None, overwrite: bool = False, verbose: int = 0) → Tuple[LabeledCollection, List][source]

Eigensolver step I: form set of equations

Parameters:

  • eq_mode (str) – mode of equation, “pg”, “cg” or “reduced”

  • components (List) – list of forcing ingredients to be added to the system. See arguments for assemble_forcing for choices

  • timescale (str) – characteristic timescale for nondimensionalization. See arguments for assemble_forcing for choices

  • bg (bg_fields.BackgroundFieldMHD) – a background field,

  • 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:

set of equations and a list of unknown parameters.