thunderboltz.parameters.OutputParameters

class thunderboltz.parameters.OutputParameters

A listing of the main output parameters of the simulation, these keywords are the named columns of the time series and steady state data frames returned by get_timeseries() and get_ss_params() respectively. These data tables also include the ParticleParameters of the species at index \(0\). The steady state parameters returned by get_ss_params() will also include standard deviations for each parameter indicated by an added “_std” suffix.

Attributes

D_H	(float) The hall components of the flux diffusion tensor \(\overleftrightarrow{\boldsymbol{D}}^f = \langle \boldsymbol{r} \boldsymbol{v} \rangle - \langle \boldsymbol{r} \rangle \langle \boldsymbol{v} \rangle\) are combined into the flux Hall diffusion \(D^f_{\text{H}} = D^f_{xz} + D^f_{zx}\).
D_H_bulk	(float) The hall components of the bulk diffusion tensor \(\overleftrightarrow{\boldsymbol{D}}^b = \frac{1}{2} \frac{\text{d}}{\text{d}t}\langle (\boldsymbol{r} - \langle \boldsymbol{r}\rangle)^2 \rangle\) are combined into the bulk Hall diffusion \(D^b_{\text{H}} = D^b_{xz} + D^b_{zx}\).
D_XX	(float) The diagonal components of the flux diffusion tensor \(\overleftrightarrow{\boldsymbol{D}}^f = \langle \boldsymbol{r} \boldsymbol{v} \rangle - \langle \boldsymbol{r} \rangle \langle \boldsymbol{v} \rangle\) are output under D_XX, D_YY, and D_ZZ.
D_XX_bulk	(float) The diagonal components of the bulk diffusion tensor \(\overleftrightarrow{\boldsymbol{D}}^b = \frac{1}{2} \frac{\text{d}}{\text{d}t}\langle (\boldsymbol{r} - \langle \boldsymbol{r}\rangle)^2 \rangle\) are output under D_XX_bulk, D_YY_bulk, and D_ZZ_bulk.
E	(float) The electric field component (V/m) in the \(z\) direction, which can change in AC scenarios.
MEe	(float) The mean energy (eV) of the species at index \(0\) (usually electrons), computed as \(\langle\epsilon\rangle = \frac{m_0}{2N_0}\sum_{i=1}^{N_0}v_{0i}^2\) where \(m_0\) and \(N_0\) are the mass and particle count of the \(0^{\rm th}\) species, and \(v_{0i}\) is the velocity vector of the \(i^{\rm th}\) particle of species \(0\).
a_n	(float) The reduced flux Townshend ionization coefficient \((\text{m}^2)\) of the species at index \(0\), computed as \(\frac{\alpha^f}{n_{\rm gas}} = \frac{1}{n_0 n_{\rm gas}}\frac{dC_{\rm ion}}{dt}\times \left( \frac{1}{N_0}\sum_{i=1}^{N_0}v_{\parallel,0i}\right)^{-1}\) where \(N_0\) is the particle count of the \(0^{\rm th}\) species, \(C_{\rm ion}\) is the count of ionization events, \(n_0\) and \(n_{\rm gas}\) are the \(0^{\rm th}\) and background gas densities repectively, and \(v_{\parallel,0i}\) is velocity component parallel to the E field vector of the \(i^{\rm th}\) th particle of species \(0\).
a_n_bulk	(float) The reduced bulk Townshend ionization coefficient \((\text{m}^2)\) of the species at index \(0\), computed as \(\frac{\alpha^b}{n_{\rm gas}} = \frac{1}{n_0 n_{\rm gas}}\frac{dC_{\rm ion}}{dt}\times\left( \frac{d}{dt} \left[\frac{1}{N_0}\sum_{i=1}^{N_0}r_{\parallel,0i}\right] \right)^{-1}\), where \(N_0\) is the particle count of the \(0^{\rm th}\) species, \(C_{\rm ion}\) is the count of ionization events, \(n_0\) and \(n_{\rm gas}\) are the \(0^{\rm th}\) and background gas densities respectively, and \(r_{\parallel,0i}\) is displacement component parallel to the E field vector of the \(i^{\rm th}\) th particle of species \(0\).
k_1	(float) The rate coefficient for the first reaction, computed as \(\frac{1}{n_0n_{\rm gas}} \frac{dC_{\rm 1}}{dt}\).
k_ion	(float) The ionization rate coefficient, computed as \(\frac{1}{n_0n_{\rm gas}} \frac{dC_{\rm ion}}{dt}\).
mobN	(float) The reduced flux mobility \((\text{V}^{-1}\text{m}^{-1}\text{s}^{-1})\) of the species at index \(0\), computed as \(\mu^fn_{\rm gas}=\frac{n_{\rm gas}}{E}\frac{1}{N_0}\sum_{i=1}^{N_0}v_{\parallel,0i}\) where \(N_0\) is the particle count of the \(0^{\rm th}\) species, \(E\) is field magnitude, \(n_{\rm gas}\) is the density of the background gas, and \(v_{\parallel,0i}\) is the velocity component parallel to the E field vector of the \(i^{\rm th}\) th particle of species \(0\).
mobN_bulk	(float) The reduced bulk mobility \((\text{V}^{-1}\text{m}^{-1}\text{s}^{-1})\) of the species at index \(0\), computed as \(\mu^b n_{\rm gas}=\frac{n_{\rm gas}}{E}\frac{d}{dt}\left[\frac{1}{N_0}\sum_{i=1}^{N_0}r_{\parallel,0i}\right]\) where \(N_0\) is the particle count of the \(0^{\rm th}\) species, \(E\) is field magnitude, \(n_{\rm gas}\) is the density of the background gas, and \(r_{\parallel,0i}\) is displacement component parallel to the E field vector of the \(i^{\rm th}\) th particle of species \(0\).
n_gas	(float) \(n_{\rm gas}\), the number density of the background gas.
step	(int) The number of time steps elapsed in the simulation, with t \(=0\) corresponding to step \(=0\), and with t = DT corresponding to step \(=1\).
t	(float) The time (s) elapsed in the simulation.

Methods

get_params()

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