wavepacketkinematics.h

Go to the documentation of this file.

/**
 * @file wavepacketkinematics.h
 * @brief Declares the wavepacketkinematics physics/numerical component used by QPE experiments.
 * @ingroup qpe_quantum
 *
 * Source: @c core/quantum/wavepacketkinematics.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
namespace qpe {
 
/**
 * @brief Implements the Wave Packet Kinematics component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class WavePacketKinematics
{
public:
    // Central kinetic energy of a 2D packet in non-relativistic mechanics:
    // E = (px^2 + py^2) / (2m)
    /**
     * @brief Performs kinetic energy.
     * @param momentumX The momentum x value used by the operation.
     * @param momentumY The momentum y value used by the operation.
     * @param mass The mass value used by the operation.
     */
    static double kineticEnergy(double momentumX,
                                double momentumY,
                                double mass) noexcept;
 
    // Longitudinal kinetic energy along X. For a vertical barrier V(x), py is
    // conserved and the 1D transmission formula must use Ex, not total E.
    /**
     * @brief Performs kinetic energy x.
     * @param momentumX The momentum x value used by the operation.
     * @param mass The mass value used by the operation.
     */
    static double kineticEnergyX(double momentumX,
                                 double mass) noexcept;
};
 
} // namespace qpe