wavepacketkinematics_tests.cpp

Go to the documentation of this file.

/**
 * @file wavepacketkinematics_tests.cpp
 * @brief Implements regression and invariant tests for wavepacketkinematics tests.
 * @ingroup qpe_tests
 *
 * Source: @c tests/wavepacketkinematics_tests.cpp. 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.
 */
 
#include "wavepacketkinematics_tests.h"
 
#include "core/quantum/wavepacketkinematics.h"
 
#include <cmath>
 
namespace qpe {
namespace tests {
namespace {
 
/**
 * @brief Performs nearly equal.
 * @param a The a value used by the operation.
 * @param b The b value used by the operation.
 * @param tolerance The tolerance value used by the operation.
 */
bool nearlyEqual(double a, double b, double tolerance)
{
    return std::abs(a - b) <= tolerance;
}
 
/**
 * @brief Performs fail.
 * @param errorMessage The error message value used by the operation.
 * @param message The message value used by the operation.
 */
bool fail(std::string &errorMessage, const char *message)
{
    errorMessage = message;
    return false;
}
 
} // namespace
 
/**
 * @brief Runs wave packet kinematics tests.
 * @param errorMessage The error message value used by the operation.
 */
bool runWavePacketKinematicsTests(std::string &errorMessage)
{
    errorMessage.clear();
 
    if (!nearlyEqual(WavePacketKinematics::kineticEnergy(3.0, 4.0, 2.0),
                     6.25, 1.0e-12)) {
        return fail(errorMessage, "2D kinetic energy is incorrect");
    }
 
    if (!nearlyEqual(WavePacketKinematics::kineticEnergyX(3.0, 2.0),
                     2.25, 1.0e-12)) {
        return fail(errorMessage, "longitudinal X kinetic energy is incorrect");
    }
 
    if (WavePacketKinematics::kineticEnergy(1.0, 2.0, 0.0) != 0.0 ||
        WavePacketKinematics::kineticEnergyX(1.0, -1.0) != 0.0) {
        return fail(errorMessage, "invalid mass was not handled safely");
    }
 
    return true;
}
 
} // namespace tests
} // namespace qpe