nml_random.h

// -*-c++-*-
#ifndef STORMM_NML_RANDOM_H
#define STORMM_NML_RANDOM_H
 
#include "copyright.h"
#include "Parsing/textfile.h"
#include "input.h"
#include "namelist_emulator.h"
 
namespace stormm {
namespace namelist {
 
using parse::WrapTextSearch;

constexpr int default_random_seed    = 30965871;
#ifdef STORMM_USE_HPC
constexpr int default_random_streams = 1048576;
#else
constexpr int default_random_streams = 1;
#endif
constexpr int default_random_stride  = 64;
constexpr int default_random_warmup  = 96;

class RandomControls {
public:

  RandomControls(ExceptionResponse policy_in = ExceptionResponse::DIE,
                 WrapTextSearch wrap = WrapTextSearch::NO);
  RandomControls(const TextFile &tf, int *start_line, bool *found_nml,
                 ExceptionResponse policy_in = ExceptionResponse::DIE,
                 WrapTextSearch wrap = WrapTextSearch::NO);

  RandomControls(const RandomControls &original) = default;
  RandomControls(RandomControls &&original) = default;
  RandomControls& operator=(const RandomControls &original) = default;
  RandomControls& operator=(RandomControls &&original) = default;

  int getRandomSeed() const;

  int getStreamCount() const;

  int getProductionStride() const;

  int getWarmupCycleCount() const;

  const NamelistEmulator& getTranscript() const;
  
  void setRandomSeed(const int igseed_in);

  void setStreamCount(const int streams_in);

  void setProductionStride(const int stride_in);

  void setWarmupCycles(const int cycles_in);
  
private:
  ExceptionResponse policy;  
  int igseed;                
  int stream_count;          
  int production_stride;     
  int warmup_cycles;         

  NamelistEmulator nml_transcript;
  
  void validateRandomSeed();

  void validateStreamCount();

  void validateProductionStride();
};
  
NamelistEmulator randomInput(const TextFile &tf, int *start_line, bool *found,
                             ExceptionResponse policy = ExceptionResponse::DIE,
                             WrapTextSearch wrap = WrapTextSearch::NO);

void validateRandomSeed(int igseed, int *warmup_cycles);
 
} // namespace namelist
} // namespace stormm
 
#endif