RandomInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "MooseTypes.h"
#include "MooseEnumItem.h"
 
// Forward declarations
class Assembly;
class FEProblemBase;
class InputParameters;
class MooseRandom;
class RandomData;
template <typename T>
InputParameters validParams();
 
class RandomInterface
{
public:
  RandomInterface(const InputParameters & parameters,
                  FEProblemBase & problem,
                  THREAD_ID tid,
                  bool is_nodal);
 
#ifdef MOOSE_KOKKOS_ENABLED
  RandomInterface(const RandomInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif
 
  ~RandomInterface();
 
  static InputParameters validParams();
 
  void setRandomResetFrequency(ExecFlagType exec_flag);
 
  unsigned long getRandomLong() const;
 
  Real getRandomReal() const;
 
  unsigned int getSeed(std::size_t id);
 
  /**************************************************
   *                Data Accessors                  *
   **************************************************/
  unsigned int getMasterSeed() const { return _master_seed; }
  bool isNodal() const { return _is_nodal; }
  ExecFlagType getResetOnTime() const { return _reset_on; }
 
  void setRandomDataPointer(RandomData * random_data);
 
private:
  RandomData * _random_data;
  mutable MooseRandom * _generator;
 
  FEProblemBase & _ri_problem;
  const std::string _ri_name;
 
  unsigned int _master_seed;
  bool _is_nodal;
  ExecFlagType _reset_on;
 
  const Node * const & _curr_node;
  const Elem * const & _curr_element;
 
  //  friend void FEProblemBase::registerRandomInterface(RandomInterface *random_interface, const
  //  std::string & name, ExecFlagType exec_flag);
};