wavepacketobservables2d.h

Go to the documentation of this file.

/**
 * @file wavepacketobservables2d.h
 * @brief Declares the wavepacketobservables2d physics/numerical component used by QPE experiments.
 * @ingroup qpe_quantum
 *
 * Source: @c core/quantum/wavepacketobservables2d.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/math/complexfield2d.h"
 
namespace qpe {
 
/**
 * @brief Data structure used by the Spatial Observables2D component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct SpatialObservables2D
{
    double norm2 = 0.0;
    double meanX = 0.0;
    double meanY = 0.0;
    double sigmaX = 0.0;
    double sigmaY = 0.0;
};
 
// Lightweight diagnostics in position space. These observables do not modify
// the wavefunction and are useful both for validation and for the live UI.
/**
 * @brief Implements the Wave Packet Observables2D component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class WavePacketObservables2D
{
public:
    /**
     * @brief Performs spatial.
     * @param field Field data to read or modify.
     */
    static SpatialObservables2D spatial(const ComplexField2D &field) noexcept;
};
 
} // namespace qpe