potentialcontours2d.h

Go to the documentation of this file.

/**
 * @file potentialcontours2d.h
 * @brief Declares the potentialcontours2d physics/numerical component used by QPE experiments.
 * @ingroup qpe_quantum
 *
 * Source: @c core/quantum/potentialcontours2d.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 <cstddef>
#include <vector>
 
namespace qpe {
 
class PotentialField2D;
 
/**
 * @brief Data structure used by the Potential Contour Segment2D component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct PotentialContourSegment2D
{
    float x1 = 0.0f;
    float y1 = 0.0f;
    float x2 = 0.0f;
    float y2 = 0.0f;
    float level = 0.0f;
};
 
/**
 * @brief Data record containing Potential Contours2D Result.
 *
 * The structure carries computed data without coupling the numerical component to the GUI or renderer.
 */
struct PotentialContours2DResult
{
    std::vector<float> levels;
    std::vector<PotentialContourSegment2D> segments;
    float minimum = 0.0f;
    float maximum = 0.0f;
    bool binaryField = false;
 
    /**
     * @brief Returns whether the object contains no data.
     * @param empty The empty value used by the operation.
     */
    bool empty() const noexcept { return segments.empty(); }
};
 
/**
 * @brief Implements the Potential Contours2D component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class PotentialContours2D
{
public:
    // Extract V(x,y)=constant curves using marching squares.
    // For a binary field (only min/max values), all intermediate levels have
    // the same geometry, so a single midpoint contour is returned.
    /**
     * @brief Performs compute.
     * @param potential Potential field used by the operation.
     * @param requestedLevels The requested levels value used by the operation.
     */
    static PotentialContours2DResult compute(const PotentialField2D &potential,
                                             std::size_t requestedLevels);
};
 
} // namespace qpe