API reference#

Everything importable from jaxincell is listed here, grouped by what it does. The top-level names are the public interface; the modules they come from start with an underscore and are not part of the documented API.

Overview#

name	purpose
`jaxincell.Simulation`	build, configure and run a simulation
`jaxincell.load_parameters()`	read a TOML parameter file
`jaxincell.diagnostics()`	energies, species split, dominant frequency
`jaxincell.plot()`	animated overview figure, optional MP4
`jaxincell._algorithms.Boris_step()`, `jaxincell._algorithms.CN_step()`	one time step of the explicit and implicit schemes
`jaxincell.boris_step()`, `jaxincell.boris_step_relativistic()`	the particle pushers
`jaxincell.fields_to_particles_grid()`	field interpolation with the quadratic spline
`jaxincell.calculate_charge_density()`, `jaxincell.current_density()`	source deposition
`jaxincell.curlE()`, `jaxincell.curlB()`, `jaxincell.field_update1()`, `jaxincell.field_update2()`	finite-difference field update
`jaxincell.E_from_Gauss_1D_FFT()`, `jaxincell.E_from_Poisson_1D_FFT()`, `jaxincell.E_from_Gauss_1D_Cartesian()`	electrostatic solvers
`jaxincell.set_BC_particles()`, `jaxincell.set_BC_positions()`	particle boundary conditions
`jaxincell.filter_scalar_field()`, `jaxincell.filter_vector_field()`	digital filter
`jaxincell.epsilon_0`, `jaxincell.speed_of_light`, …	physical constants