CD_Random.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_RANDOM_H
#define CD_RANDOM_H
 
// Std includes
#include <random>
#include <memory>
#include <mutex>
#include <type_traits>
#ifdef _OPENMP
#include <omp.h>
#endif
 
// Chombo includes
#include <REAL.H>
#include <RealVect.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
class Random
{
public:
  Random() = delete;
 
  Random(const Random& a_other) = delete;
 
  Random(const Random&& a_other) = delete;
 
  Random&
  operator=(const Random& a_other) = delete;
 
  Random&
  operator=(const Random&& a_other) = delete;
 
  template <typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  inline static T
  getPoisson(const Real a_mean);
 
  template <typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  inline static T
  getBinomial(const T a_N, const Real a_p) noexcept;
 
  inline static Real
  getUniformReal01();
 
  inline static Real
  getUniformReal11();
 
  inline static Real
  getNormal01();
 
  inline static RealVect
  getDirection();
 
  template <typename T>
  inline static Real
  get(T& a_distribution);
 
  template <typename T>
  inline static size_t
  getDiscrete(T& a_distribution);
 
  inline static void
  seed();
 
  inline static void
  setSeed(const int a_seed);
 
  inline static void
  setRandomSeed();
 
  inline static RealVect
  randomPosition(const RealVect& a_lo, const RealVect& a_hi) noexcept;
 
  inline static RealVect
  randomPosition(const RealVect& a_cellPos,
                 const RealVect& a_lo,
                 const RealVect& a_hi,
                 const RealVect& a_bndryCentroid,
                 const RealVect& a_bndryNormal,
                 const Real      a_dx,
                 const Real      a_kappa) noexcept;
 
  inline static RealVect
  randomPosition(const RealVect& a_lo,
                 const RealVect& a_hi,
                 const RealVect& a_bndryCentroid,
                 const RealVect& a_bndryNormal) noexcept;
 
private:
  static bool s_seeded;
 
  static thread_local std::mt19937_64 s_rng;
 
  static thread_local std::uniform_real_distribution<Real> s_uniform01;
 
  static thread_local std::uniform_real_distribution<Real> s_uniform11;
 
  static thread_local std::normal_distribution<Real> s_normal01;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_RandomImplem.H>
 
#endif