:autogenerated:

analysis.momentum
====================================

.. automodule:: PQAnalysis.analysis.momentum
    



    Submodules
    ----------

    .. toctree::
       :maxdepth: 1

       PQAnalysis.analysis.momentum.api
       PQAnalysis.analysis.momentum.exceptions
       PQAnalysis.analysis.momentum.momentum
       PQAnalysis.analysis.momentum.momentum_output_file_writer




    Summary
    -------

    ``__all__`` Classes:


    .. list-table::
    
       * - :class:`Momentum <PQAnalysis.analysis.momentum.momentum.Momentum>`
         - A class for calculating the norm of the total linear momentum of a selection of atoms for every frame of a velocity trajectory.
       * - :class:`MomentumDataWriter <PQAnalysis.analysis.momentum.momentum_output_file_writer.MomentumDataWriter>`
         - Class for writing the data of a :py:class:`~PQAnalysis.analysis.momentum.momentum.Momentum` analysis to a file.
    

    ``__all__`` Functions:


    .. list-table::
    
       * - :func:`check_momentum <PQAnalysis.analysis.momentum.api.check_momentum>`
         - Calculate the total linear momentum norm per frame and write it.