experimentpreset2d.h

Go to the documentation of this file.

/**
 * @file experimentpreset2d.h
 * @brief Declares the frozen catalog of 54 guided QPE experiment presets and their representative physical scales.
 * @ingroup qpe_experiments
 *
 * Source: @c core/experiments/experimentpreset2d.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
 
#include "core/quantum/potentialscene2d.h"
#include "core/quantum/timedependentpotential2d.h"
#include "core/quantum/ramseyinterferometry2d.h"
#include "core/quantum/quantumtalbot2d.h"
#include "core/quantum/quantumvortex2d.h"
#include "core/quantum/quantumanderson2d.h"
#include "core/quantum/quantumkickedrotor2d.h"
#include "core/quantum/quantumzeno2d.h"
#include "core/quantum/quantumscar2d.h"
#include "core/quantum/quantumberryphase2d.h"
#include "core/quantum/quantumloschmidt2d.h"
#include "core/quantum/quantummoshinsky2d.h"
#include "core/quantum/quantumkapitzadirac2d.h"
#include "core/quantum/quantumaharonovbohm2d.h"
#include "core/quantum/quantumlandau2d.h"
#include "core/quantum/quantumhalledge2d.h"
#include "core/quantum/quantumbackflow2d.h"
#include "core/quantum/quantumzitterbewegung2d.h"
#include "core/quantum/quantumkleintunneling2d.h"
 
namespace qpe {
 
// Display/help metadata only. These values provide an order-of-magnitude
// mapping from the Explorer's dimensionless coordinates to one representative
// laboratory platform. They never alter psi, V, the solver, observables or
// measurement probabilities.
/**
 * @brief Data structure used by the Real World Scale2D component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct RealWorldScale2D
{
    bool available = false;
    const char *referenceSystem = "";
    const char *mappingBasis = "";
    double metersPerSimulationLength = 0.0;
    double secondsPerSimulationTime = 0.0;
    const char *note = "";
};
 
/**
 * @brief Complete configuration of one guided QPE experiment preset.
 *
 * Presets are the reproducible didactic starting points for the 54 frozen experiments. A preset captures numerical parameters, preparation, geometry, potential, analysis defaults, and representative real-world scales.
 */
struct ExperimentPreset2D
{
    const char *name = "";
    const char *shortDescription = "";
    const char *helpItHtml = "";
    const char *helpEnHtml = "";
 
    // Approximate real-world scale shown in the Time dock/help. Display-only.
    RealWorldScale2D realWorldScale;
 
    double universeWidth = 40.96;
    double universeHeight = 40.96;
    int gridResolutionIndex = 1; // 0=256, 1=512, 2=1024
    int boundaryModeIndex = 1;   // 0=periodic, 1=absorbing
    double absorbingWidth = 0.15;
    double absorbingStrength = 8.0;
 
    double packetCenterX = -8.0;
    double packetCenterY = 0.0;
    double packetSigma = 1.0;
    double packetPx = 2.5;
    double packetPy = 0.0;
    double packetMass = 1.0;
 
    int geometryIndex = 0;
    double potentialHeight = 0.0;
    double potentialCenterX = 0.0;
    double potentialCenterY = 0.0;
    double sizeX = 0.0;
    double sizeY = 0.0;
    double aperture1 = 0.0;
    double aperture2 = 0.0;
 
    int graphicsPresetIndex = 0;
    int viewIndex = 0;
    int paletteIndex = 0;
    bool currentVisible = false;
    int currentModeIndex = 1; // 0=vectors, 1=streamlines, 2=both
 
    bool potentialSceneActive = false;
    PotentialScene2D potentialScene;
 
    // Step 18: optional preparation derived from stationary bound states.
    // 0 = ordinary Gaussian packet, 1 = one bound eigenstate,
    // 2 = equal coherent superposition of two bound eigenstates.
    int initialPreparationMode = 0;
    int boundStateA = 0;
    int boundStateB = 3;
    double boundRelativePhaseDegrees = 90.0;
 
    // Step 19: finite-resolution single-system position measurement.
    double collapseResolution = 0.65;
 
    // Step 21: optional one-shot time-dependent potential recipe.
    QuantumQuench2DConfig quench;
 
    // Step 22: optional sinusoidal drive of one Potential Scene parameter.
    PeriodicPotentialDrive2DConfig periodicDrive;
 
    // Step 24: optional finite linear sweep through an avoided crossing.
    LinearPotentialSweep2DConfig linearSweep;
 
    // Step 26/27: optional Ramsey sequence with optional Hahn-echo pulse.
    RamseyPulseSequence2DConfig ramseySequence;
 
    // Step 28: analysis-only static-detuning ensemble. It never evolves psi.
    RamseyEnsemble2DConfig ramseyEnsemble;
 
    // Step 32: periodic transverse-comb initial state for Talbot self-imaging.
    QuantumTalbotInitialState2DConfig talbotInitialState;
 
    // Step 34: single-vortex initial state with an off-axis phase singularity.
    QuantumVortexInitialState2DConfig vortexInitialState;
 
    // Step 35: equal dual-lane preparation for clean/disordered lattice comparison.
    QuantumAndersonInitialState2DConfig andersonInitialState;
 
    // Step 36: instantaneous periodic kick train plus rotor-mode initial state.
    QuantumKickedRotor2DConfig kickedRotor;
    QuantumKickedRotorInitialState2DConfig kickedRotorInitialState;
 
    // Step 37: repeated survival measurements plus equal control/watched lanes.
    QuantumZeno2DConfig quantumZeno;
    QuantumZenoInitialState2DConfig quantumZenoInitialState;
 
    // Step 38: analysis-only finite-time spectral projection for stadium scars.
    QuantumScarConfig2D quantumScar;
 
    // Step 39: cyclic quadrupole loop around the first-excited-state degeneracy.
    QuantumBerryLoop2DConfig quantumBerry;
 
    // Step 40: one-shot anti-unitary time reversal with optional momentum error.
    QuantumLoschmidt2DConfig quantumLoschmidt;
 
    // Step 41: truncated matter-wave preparation and sudden shutter release.
    QuantumMoshinskyInitialState2DConfig moshinskyInitialState;
    QuantumMoshinsky2DConfig quantumMoshinsky;
 
    // Step 42: anisotropic atomic beam plus short standing-wave light pulse.
    QuantumKapitzaDiracInitialState2DConfig kapitzaDiracInitialState;
    QuantumKapitzaDirac2DConfig quantumKapitzaDirac;
 
    // Step 43: finite-radius magnetic flux tube represented by U(1) links.
    QuantumAharonovBohm2DConfig quantumAharonovBohm;
 
    // Step 44: uniform magnetic field, cyclotron orbit and Landau eigenstates.
    QuantumLandau2DConfig quantumLandau;
 
    // Step 45: chiral skipping-orbit / quantum Hall edge transport.
    QuantumHallEdge2DConfig quantumHallEdge;
 
    // Step 46: positive-momentum state with transient negative probability current.
    QuantumBackflow2DConfig quantumBackflow;
 
    // Step 47: free two-component Dirac wave packet and Zitterbewegung.
    QuantumZitterbewegung2DConfig quantumZitterbewegung;
 
    // Step 48: positive-energy Dirac packet incident on a supercritical scalar barrier.
    QuantumKleinTunneling2DConfig quantumKleinTunneling;
};
 
/**
 * @brief Implements the Experiment Preset Library2D component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class ExperimentPresetLibrary2D
{
public:
    /**
     * @brief Returns count.
     */
    static int count();
    /**
     * @brief Returns whether valid index.
     * @param index Zero-based index of the selected item.
     */
    static bool isValidIndex(int index);
    /**
     * @brief Performs preset.
     * @param index Zero-based index of the selected item.
     */
    static ExperimentPreset2D preset(int index);
};
 
} // namespace qpe