thunderboltz.parameters.TBParameters

class thunderboltz.parameters.TBParameters[source]

The ThunderBoltz simulation settings and their default values.

Attributes

B

(list[int]) Magnetic field vector (Tesla), default is [0.0, 0.0, 0.0].

CR

(int) If 1, then the remainder of \(N_{\rm pairs}\) is carried into the next \(N_{\rm pairs}\) evaluation of the same process, default is 1.

DT

(float) Time increment interval (s), default is 5e-12.

E

(float) Electric field in z-direction (V/m), default is -24640.0.

ET

(float) E-field oscillation frequency (Hz), default is 0.

EX

(int) Cross section extrapolation — options are 0 (extrapolated cross sections are set to \(0\) m \(^2\)), or 1 (linearly extrapolated from last two points), default is 0.

FV

(list[int]) Output velocity dump settings [start, stride, species ID], default is [1000, 1000000, 0].

L

(float) Cell length (m), default is 1e-6.

LV

(list[str,int]) Optionally load particle velocities from a comma separated text file, default is None; specify the name of the file at index 0 and the particle species index it applies to at index 1.

MEM

(float) Request memory (GB) for particle arrays.

MP

(list[float]) Mass of each particle species (amu), default is [5.4857e-4, 28.0].

NP

(list[int]) Number of particles for each species, default is [10000, 1000].

NS

(int) Number of time steps, default is 1000001.

OS

(int) Time step stride for output parameters, default is 100.

QP

(list[int]) Charge (elementary units) of each particle species, default is [-1.0, 0.0].

SE

(int) When using a SLURM manager on HPC, auto dump particle velocity data before job allocation runs out — options are 0 (don't auto dump) | 1 (dump using SLURM setup).

SP

(int) Number of species, default is 2.

TP

(list[float]) Temperature (eV) of each particle species, default is [0.0, 0.0259].

VS

(int) Number of random samples used to find \(\max_\epsilon (v\sigma(\epsilon))\) for each process, default is 1000.

VV

(list[float]) Flow velocity for each particle, default is [0.0, 0.0].

Methods

get_params()

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