blochoscillations2d_tests.cpp

Go to the documentation of this file.

/**
 * @file blochoscillations2d_tests.cpp
 * @brief Implements regression and invariant tests for blochoscillations2d tests.
 * @ingroup qpe_tests
 *
 * Source: @c tests/blochoscillations2d_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 "blochoscillations2d_tests.h"
 
#include "core/quantum/blochoscillations2d.h"
 
#include <cmath>
 
namespace qpe {
namespace tests {
namespace {
 
/**
 * @brief Performs close.
 * @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 close(double a, double b, double tolerance = 1.0e-9)
{
    return std::fabs(a - b) <= tolerance;
}
 
/**
 * @brief Creates scene.
 */
PotentialScene2D makeScene()
{
    PotentialScene2D scene;
    for (int i = -4; i <= 4; ++i) {
        PotentialObject2D well;
        well.type = PotentialObjectType2D::Rectangle;
        well.value = -1.0f;
        well.centerX = static_cast<float>(2.56 * i);
        well.centerY = 0.0f;
        well.width = 1.28f;
        well.height = 40.96f;
        scene.add(well);
    }
    PotentialObject2D force;
    force.type = PotentialObjectType2D::Linear;
    force.value = 0.0f;
    force.slopeX = 0.08f;
    force.slopeY = 0.0f;
    scene.add(force);
    return scene;
}
 
} // namespace
 
/**
 * @brief Runs bloch oscillations2 d tests.
 * @param errorMessage The error message value used by the operation.
 */
bool runBlochOscillations2DTests(std::string &errorMessage)
{
    errorMessage.clear();
    const PotentialScene2D scene = makeScene();
    BlochLatticeGeometry2D geometry;
    if (!BlochOscillations2D::identify(scene, geometry, nullptr)) { errorMessage = "failed to identify valid lattice"; return false; }
    if (geometry.wellCount != 9) { errorMessage = "wrong lattice well count"; return false; }
    if (!close(geometry.spacing, 2.56, 1.0e-6)) { errorMessage = "wrong lattice spacing"; return false; }
    if (!close(geometry.wellWidth, 1.28, 1.0e-6)) { errorMessage = "wrong well width"; return false; }
    if (!close(geometry.wellDepth, 1.0, 1.0e-9)) { errorMessage = "wrong well depth"; return false; }
    if (!close(geometry.forceX, -0.08, 1.0e-7)) { errorMessage = "wrong force sign/magnitude"; return false; }
 
    const double period = BlochOscillations2D::blochPeriod(geometry, 1.0);
    const double expected = 2.0 * 3.14159265358979323846 / (0.08 * 2.56);
    if (!close(period, expected, 1.0e-5)) { errorMessage = "wrong Bloch period"; return false; }
 
    const double edge = BlochOscillations2D::zoneEdgeMomentum(geometry, 1.0);
    if (!close(edge, 3.14159265358979323846 / 2.56, 1.0e-6)) { errorMessage = "wrong Brillouin-zone edge"; return false; }
 
    const double p0 = 0.0;
    if (!close(BlochOscillations2D::reducedZoneMomentum(geometry, p0, 0.0), 0.0, 1.0e-12)) { errorMessage = "wrong initial reduced momentum"; return false; }
    if (!close(BlochOscillations2D::reducedZoneMomentum(geometry, p0, period), 0.0, 1.0e-6)) { errorMessage = "reduced momentum does not repeat after one period"; return false; }
    if (!close(std::fabs(BlochOscillations2D::reducedZoneMomentum(geometry, p0, 0.5 * period)),
               edge, 1.0e-6)) { errorMessage = "reduced momentum does not reach zone edge at half period"; return false; }
 
    PotentialScene2D invalid = scene;
    PotentialObject2D extra;
    extra.type = PotentialObjectType2D::Circle;
    extra.radius = 1.0f;
    extra.value = 1.0f;
    invalid.add(extra);
    BlochLatticeGeometry2D invalidGeometry;
    if (BlochOscillations2D::identify(invalid, invalidGeometry, nullptr)) { errorMessage = "invalid mixed scene accepted"; return false; }
 
    return true;
}
 
} // namespace tests
} // namespace qpe