simulationdomain2d.h

Go to the documentation of this file.

/**
 * @file simulationdomain2d.h
 * @brief Declares the simulationdomain2d physics/numerical component used by QPE experiments.
 * @ingroup qpe_quantum
 *
 * Source: @c core/quantum/simulationdomain2d.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>
 
namespace qpe {
 
/**
 * @brief Data structure used by the Simulation Domain2D component.
 *
 * The structure keeps related values explicit and testable across the QPE physics, analysis, or persistence layers.
 */
struct SimulationDomain2D
{
    std::size_t gridWidth = 0;
    std::size_t gridHeight = 0;
    float physicalWidth = 0.0f;
    float physicalHeight = 0.0f;
    float dx = 0.0f;
    float dy = 0.0f;
 
    /**
     * @brief Performs valid.
     */
    bool valid() const noexcept;
};
 
/**
 * @brief Implements the Simulation Domain2D Builder component.
 *
 * The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.
 */
class SimulationDomain2DBuilder
{
public:
    /**
     * @brief Performs make.
     * @param gridWidth The grid width value used by the operation.
     * @param gridHeight The grid height value used by the operation.
     * @param physicalWidth The physical width value used by the operation.
     * @param physicalHeight The physical height value used by the operation.
     */
    static SimulationDomain2D make(std::size_t gridWidth,
                                   std::size_t gridHeight,
                                   float physicalWidth,
                                   float physicalHeight);
    /**
     * @brief Returns whether power of two.
     * @param value Value to assign or evaluate.
     */
    static bool isPowerOfTwo(std::size_t value) noexcept;
};
 
} // namespace qpe