๐Ÿ”Ž Overview๏ƒ

Welcome to wakis documentation๏ƒ

wakis: 3D Time-domain Wake and Impedance Solver

wakis is a 3D Time-domain Electromagnetic solver that solves the Integral form of Maxwellโ€™s equations using the Finite Integration Technique (FIT) numerical method. It computes the longitudinal and transverse wake potential and beam-coupling impedance from the simulated electric and magnetic fields. It is hence focused on simulations for particle accelerator components, but it is also a multi-purpose solver; capable of simulating planewaves interaction with nano-structures, optical diffraction, and much more!

๐Ÿš€ Some of wakis features:

  • Wake potential and impedance calculations for particle beams with different relativistic \(\beta\)

  • Material tensors: permittivity \(\varepsilon\), permeability \(\mu\), conductivity \(\sigma\). Possibility of anisotropy.

  • CAD geometry importer (STL & STEP format) for definition of embedded boundaries and material regions, based on pyvista

  • Boundary conditions: PEC, PMC, Periodic, ABC-FOEXTRAP, Perfect Matched Layers (PML)

  • Different time-domain sources: particle beam, planewave, gaussian wavepacket

  • 100% python, fully exposed API (material tensors, fields \(E\), \(H\), \(J\)). Matrix operators based on numpy and scipy.sparse routines ensure fast calculations.

  • 1d, 2d, 3d built-in plotting on-the-fly

  • Optimized memory consumption

  • GPU acceleration using cupy/cupyx

  • CUDA-aware MPI parallelization with mpi4py and ipyparallel coming soon!

๐Ÿงฉ Other complementary tools in the ecosystem:

  • Wakefield extrapolation with PIML iddefix evolutionary algorithms

  • Non-equidistant Filon Fourier integration with neffint

  • Beam-induced heating estimation due to impedance with bihc

The source code is available in the wakis GitHub repository.

Table of Contents