pg_utils.eigen.assemble_forcing

pg_utils.eigen.assemble_forcing(eqs: LabeledCollection, *args: str, timescale: str = 'Alfven', verbose: int = 0) → Tuple[LabeledCollection, List][source]

Assemble components of the forcing in the PG system

Parameters:

  • eqs (base.LabeledCollection) – original set of equations

  • *args (str) –

    strings of components to be added. The following are implemented (case-insensitive): * ‘Lorentz’: Lorentz force terms; assumes vorticity equation exists

  • timescale (str) – type of char. time scale for nondimensionalization. Choice of timescale only influences the vorticity equation The following are implemented (case-insensitive): * ‘Alfven’: use Alfven time scales T = B/sqrt(rho_0*mu_0) (default) * ‘Spin’: use inverse spin rate T = 1/Omega

  • verbose (int) – verbosity level

Returns:

set of equations with forcing added, and the unknown variables