QPMS
/
qpms
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update features in README.md 

Former-commit-id: bb142ce1812d0d9330f8e60286820aaf105c505a
This commit is contained in:
Marek Nečada 2020-06-23 15:16:23 +03:00
parent 42497939c1
commit e0e572db3c
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,10 +1,12 @@
QPMS README QPMS README
=========== ===========
QPMS is a toolkit for frequency-domain simulations of photonic systems QPMS (standing for QPMS Photonic Multiple Scattering)
is a toolkit for frequency-domain simulations of photonic systems
consisting of compact objects (particles) inside a homogeneous medium. Scattering consisting of compact objects (particles) inside a homogeneous medium. Scattering
properties of the individual particles are described by their T-matrices properties of the individual particles are described by their T-matrices
(which can be obtained e.g. with the `scuff-tmatrix` tool from (which can be obtained using one of the built-in generators or
e.g. with the `scuff-tmatrix` tool from
the [SCUFF-EM] suite). the [SCUFF-EM] suite).
QPMS handles the multiple scattering of electromagnetic radiation between QPMS handles the multiple scattering of electromagnetic radiation between
@ -17,21 +19,24 @@ Features
Finite systems Finite systems
-------------- --------------
* Computing multipole excitations *and fields (TODO)* scattered from nanoparticle * Computing multipole excitations and fields scattered from nanoparticle
clusters illuminated by plane, spherical or *cylindrical (TODO)* waves. clusters illuminated by plane, spherical or *cylindrical (TODO)* waves.
* Finding eigenmodes. * Finding eigenmodes (optical resonances).
* *Calculating cross sections (TODO).* * Calculating cross sections.
* Reducing numerical complexity of the computations by exploiting * Reducing numerical complexity of the computations by exploiting
symmetries of the cluster (decomposition to irreducible representations). symmetries of the cluster (decomposition to irreducible representations).
Infinite systems (lattices) Infinite systems (lattices)
--------------------------- ---------------------------
* 2D-periodic systems supported. (TODO 1D and 3D.) * 2D-periodic systems with arbitrary unit cell geometry supported. (TODO 1D and 3D.)
* *Calculation of transmission and reflection properties (TODO).* * Computing multipole excitations and fields scattered from nanoparticle
arrays illuminated by plane (or other periodic) waves.
* Finding eigenmodes and calculating dispersion relations. * Finding eigenmodes and calculating dispersion relations.
* *Calculation of far-field radiation patterns of an excited array (TODO).* * Calculation of the scattered fields.
* Reducing numerical complexity of the computations by exploiting * *Calculation of total transmission and reflection properties (TODO).*
symmetries of the lattice (decomposition to irreducible representations). * *Reducing numerical complexity of the computations by exploiting
symmetries of the lattice (decomposition to irreducible representations) (in development).*
Installation Installation
@ -66,6 +71,7 @@ Special care might need to be taken when installing QPMS in cluster environments
Specific installation instructions for Aalto University's Triton cluster Specific installation instructions for Aalto University's Triton cluster
can be found in a [separate document][TRITON-README]. can be found in a [separate document][TRITON-README].
Documentation Documentation
============= =============
@ -87,6 +93,8 @@ Tutorials
* [Infinite system (lattice) tutorial][tutorial-infinite] * [Infinite system (lattice) tutorial][tutorial-infinite]
* [Finite system tutorial][tutorial-finite] * [Finite system tutorial][tutorial-finite]
See also the examples directory.
[SCUFF-EM]: https://homerreid.github.io/scuff-em-documentation/ [SCUFF-EM]: https://homerreid.github.io/scuff-em-documentation/
[OpenBLAS]: https://www.openblas.net/ [OpenBLAS]: https://www.openblas.net/
[GSL]: https://www.gnu.org/software/gsl/ [GSL]: https://www.gnu.org/software/gsl/