grid.hpp

Go to the documentation of this file.

#pragma once
/**
 * @file grid.hpp
 * @brief Uniform 1D spatial grid.
 */
 
#include <vector>
#include <cstddef>
 
/**
 * @brief Uniform 1D grid on x ∈ [0, L], including both boundary nodes.
 *
 * Builds Nx = round(L/dx) + 1 nodes with coordinates x[i] = i * dx.
 */
struct Grid {
    double L;                 ///< Domain length [cm]
    double dx;                ///< Spatial step [cm]
    std::size_t Nx;           ///< Number of nodes (including boundaries)
    std::vector<double> x;    ///< Node coordinates [cm]
 
    /**
     * @brief Construct a grid with given length and spacing.
     * @param L_cm Domain length [cm]
     * @param dx_cm Spatial step [cm]
     */
    Grid(double L_cm, double dx_cm);
};
 
/**
 * @brief Validate grid consistency (assertions in Debug mode).
 *
 * Checks endpoints, monotonicity, uniform spacing and Nx consistency.
 * @param g Grid to validate
 * @param tol Tolerance for floating-point comparisons (default 1e-12)
 * @return true if all assertions pass
 */
bool validate_grid(const Grid& g, double tol = 1e-12);