thunderboltz.parameters.WrapParameters

class thunderboltz.parameters.WrapParameters

Additional Python interface settings and their defaults. An asterisk (*) at the beginning of the description indicates a parameter that is specific to the built-in He model.

Attributes

Bred	(list[float]) Specify reduced magnetic field (Hx), default is None.
DE	(float) The maximum change in energy (eV) of a hypothetical electron per time step, default is 0.1.
ECS	*(str or None) The total elastic cross section model for the He built-in — options are "ICS" or "MTCS", default is "ICS" if an anisotropic angular distribution function is used and "MTCS" if an isotropic angular distribution function is used.
EP_0	(float) The initial energy (eV) of a hypothetical electron per time step, default is 10.
Ered	(float) Specify reduced electric field (Td), default is None.
NN	(int) Number of background neutral gas particles (assumed gas species is of index 1), default is None.
Nmin	(float) Minimum number of pseudo pairs to be generated by the smallest cross section of interest, default is 1.0.
analytic_cs	*(str or bool) For the built-in thunderboltz.input.He_TB Helium model, use either tabulated data, analytic fits, or a mix of both, options are False | True | "mixed".
autostep	(bool) Flag to calculate DT / NP / E from Ered / L / pct_ion / DE / EP_0, default is False.
downsample	(bool) If specified with vdf_init, truncate the init file such that NP is satisfied, default is False.
duration	(float) Run simulation until duration (s) is complete, default is None.
eadf	(str) Elastic angular distribution function model — options are "default", or "He_Park".
eesd	(str) Electron energy sharing distribution model — options are "default" (one takes all) | "equal" | "uniform".
egen	*(bool) Allow secondary electron generation for the ionization model.
fixed_background	(bool) Flag to append "FixedParticle2" to each of the reaction types in the indeck
gas_index	(int) The index of the neutral gas species (if applicable), default is 1.
indeck	(callable or str) Function for auto-generating indeck and CS object or string path to directory with CS data and indeck, default is None.
mix_thresh	*(float) If analytic_cs is "mixed", use numerical data at energies lower than this threshold value (in eV), and use analytic data at higher energies.
n	*(int) For the built-in thunderboltz.input.He_TB Helium model, include CCC excitation processes from the ground state to (up to and including) states with principle quantum number n.
nsamples	*(int) For the built-in thunderboltz.input.He_TB, this specifies the number of tabulated cross section values for analytic sampling.
pc_scale	(dict[str->float]) Multiply any property involved in the \(N_{\rm min}\) constraint by a constant after the constraint is imposed; useful for convergence testing, default is {} (do nothing).
pct_ion	(float) Set the ratio \(\frac{N_{\rm e}}{N_{\rm gas}}\), default is None.
vdf_init	(list[str or int or 2D-array, int]) Initialize particles with velocity data — a string at index 0 will read velocity data from that file path; an int at index 0 will attempt to reinitialize a previous calculation from a that time step if that step dump file is available; an array or DataFrame of shape (NP,3) at index 0 will create a velocity initialization file with the provided data, the value at index 1 should represent the species type.

Methods

get_params()

Return the set of parameters and their default values as a python dictionary.