constants.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 VTT Technical Research Centre of Finland Ltd
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#ifndef PFC_CONSTANTS_HPP
#define PFC_CONSTANTS_HPP
 
namespace pfc {
 
namespace constants {
 
// ============================================================================
// Mathematical Constants
// ============================================================================
 
constexpr double pi = 3.14159265358979323846;
 
constexpr double two_pi = 2.0 * pi;
 
constexpr double pi_2 = pi / 2.0;
 
constexpr double pi_4 = pi / 4.0;
 
constexpr double inv_pi = 1.0 / pi;
 
constexpr double sqrt_pi = 1.77245385090551602729;
 
constexpr double sqrt2 = 1.41421356237309504880;
 
constexpr double sqrt3 = 1.73205080756887729352;
 
constexpr double e = 2.71828182845904523536;
 
constexpr double ln2 = 0.69314718055994530941;
 
constexpr double ln10 = 2.30258509299404568401;
 
constexpr double phi = 1.61803398874989484820;
 
// ============================================================================
// Phase Field Crystal Lattice Constants
// ============================================================================
 
constexpr double a1D = 2 * pi;
 
constexpr double a2D = 2 * pi * 2 / sqrt3;
 
constexpr double a3D = 2 * pi * sqrt2;
 
// ============================================================================
// FFT Configuration Constants
// ============================================================================
 
constexpr int r2c_direction = 0;
 
} // namespace constants
 
// ============================================================================
// Convenience: Import Common Constants into pfc Namespace
// ============================================================================
// This allows both pfc::pi and pfc::constants::pi to work
 
using constants::e;
using constants::pi;
using constants::sqrt2;
using constants::sqrt3;
using constants::two_pi;
 
} // namespace pfc
 
#endif // PFC_CONSTANTS_HPP