Coverage for dynasor / modes / __init__.py: 100%

1""" 

2The mode projection functionality in dynasor is mainly handled by two objects: 

3The :class:`~dynasor.ModeProjector` class and :func:`~dynasor.project_modes` 

4function. The :class:`~dynasor.ModeProjector` provides access to 

5data objects representing a q-point :attr:`~dynasor.modes.qpoint.QPoint` and 

6from the q-point there is access to an object representing a particular band 

7:class:`~dynasor.modes.band.Band` at that q-point. In addition, simple wrappers 

8around the coordinates `Q`, `P` and `F` exist via 

9:class:`~dynasor.modes.complex_coordinate.ComplexCoordinate` to easily set the 

10amplitude and phase of a mode while preserving the :math:`Q(-q)=Q^*(q)` 

11symmetries. Internally dynasor wraps the primitive cell 

12:class:`~dynasor.modes.atoms.Prim` and supercell 

13:class:`~dynasor.modes.atoms.Supercell`. As a user only the 

14:class:`~dynasor.ModeProjector` and :attr:`~dynasor.project_modes` should need 

15to be imported. 

16"""