CLIUTILS.md

   1 Overview of QPMS command line utilities
   2 =======================================
   3
   4 The utilities are located in the `misc` directory. Run the
   5 utility with `-h` argument to get more info.
   6
   7
   8 Rectangular and square 2D lattices
   9 ----------------------------------
  10
  11 These scripts deal with simple 2D rectangular lattices,
  12 finite or infinite, one scatterer per unit cell.
  13 \f$ D_{2h} \f$ or \f$ D_{4h} \f$ symmetric adapted bases
  14 are used where applicable.
  15
  16 ### Finite lattices
  17
  18  * `finiterectlat-modes.py`:  Search for resonances using Beyn's algorithm.
  19  * `finiterectlat-scatter.py`:  Plane wave scattering.
  20  * `finiterectlat-constant-driving.py`: Rectangular array response to
  21    a driving where a subset of particles are excited by basis VSWFs with the
  22    same phase.
  23
  24 ### Infinite lattices
  25
  26  * `rectlat_simple_modes.py`: Search for lattice modes using Beyn's algorithm.
  27  * `infiniterectlat-k0realfreqsvd.py`:
  28     Evaluate the lattice mode problem singular values at the Γ point for a real frequency interval.
  29     Useful as a starting point in lattice mode search before using Beyn's algorithm.
  30  * `infiniterectlat-scatter.py`: Plane wave scattering.
  31
  32
  33 General 2D lattices
  34 -------------------
  35
  36 ### Infinite lattices
  37
  38 These can contain several scatterers per unit cell. Symmetry adapted bases currently not implemented.
  39
  40  * `lat2d_modes.py`: Search for lattice modes using Beyn's algorithm.
  41  * `lat2d_realfreqsvd.py`:
  42     Evaluate the lattice mode problem singular values at the Γ point for a real frequency interval.
  43     Useful as a starting point in lattice mode search before using Beyn's algorithm.