solprop.driver.routes.general#
The general modal route: a supplied guide’s modes and its keywords.
_from_general builds a general modal run from a guide that solves its own fields,
for from_waveguide() given a provider,
from its keywords (_GeneralRequest): it refuses the gas-filled keywords given beside
a provider (_refuse_gas_keywords; GAS_KEYWORD_DEFAULTS are their “not
given” values), places a one-channel pulse in a named or indexed channel
(_in_channel), and takes the default statistics (_general_stats) and the core’s
phase index at the grid’s frequencies (_core_index). The manual page is
docs/guide/waveguides/general-modal.md.
Module Attributes
Every gas-filled from_waveguide keyword, with the value that means "not given". |
- solprop.driver.routes.general.GAS_KEYWORD_DEFAULTS: Mapping[str, object] = {'envelope': False, 'gas': None, 'ionisation_field_range': None, 'kerr': True, 'mode_average': False, 'n_r': None, 'n_theta': None, 'node_budget': None, 'plasma': None, 'plasma_integration': None, 'preionisation': None, 'pressure': None, 'pressure_floor': None, 'radial_rule': 'gauss_kronrod', 'raman': None, 'susceptibility': None, 'taper_coupling': True, 'temperature': None, 'thg': None, 'vacuum_end': None}#
Every gas-filled from_waveguide keyword, with the value that means “not given”.
A general modal guide owns its materials, its responses, its transverse rule and its grid kind, so each of these is refused by name when it departs from the value here; a keyword silently ignored would let a caller believe a fill, a response or a resolution was applied.