OscillatorBase.h

Go to the documentation of this file.

#ifndef __OSCILLATOR_BASE_H__
#define __OSCILLATOR_BASE_H__
 
#include "OscProbCalcer/OscProbCalcerBase.h"
#include "Constants/OscillatorConstants.h"
 
#include "yaml-cpp/yaml.h"
 
class OscillatorBase {
 public:
   virtual ~OscillatorBase();
 
  // ========================================================================================================================================================================
  // Public functions which are calculation implementation agnostic
 
  void SanityCheck();
 
  void CalculateProbabilities(const std::vector<FLOAT_T>& OscParams);
 
  void CalculateProbabilities();
 
  void DefineParameter(const std::string& ParName_, FLOAT_T* ParValue_) {
    if (!fOscProbCalcerSet) {
      std::cerr << "DefineParameter function called before OscProbCalcer set!" << std::endl;
      throw std::runtime_error("DefineParameter function called before OscProbCalcer set");
    }
    
    fOscProbCalcer->DefineParameter(ParName_,ParValue_);
  }
 
  int ReturnNOscParams();
 
  void PrintWeights();
 
  void Setup();
 
  std::string ReturnImplementationName();
 
  int ReturnNEnergyPoints();
 
  std::vector<FLOAT_T> ReturnEnergyArray();
 
  int ReturnNCosineZPoints();
 
  std::vector<FLOAT_T> ReturnCosineZArray();
 
  std::vector<NuOscillator::OscillationChannel> ReturnOscChannels();
 
  std::vector<int> ReturnNeutrinoTypes();
  
  bool HasOscProbCalcerGotOscillationChannel(int GeneratedFlavour, int DetectedFlavour);
 
  void SetEnergyArrayInCalcer(std::vector<FLOAT_T> Array);
 
  void SetCosineZArrayInCalcer(std::vector<FLOAT_T> Array);
 
  bool EvalPointsSetInConstructor() {return fEvalPointsSetInConstructor;}
 
  bool ReturnCosineZIgnored() {return fCosineZIgnored;}
 
  FLOAT_T ReturnOscillationProbability(int InitNuFlav, int FinalNuFlav, FLOAT_T EnergyVal, FLOAT_T CosineZVal=DUMMYVAL) {
    const FLOAT_T* Pointer = ReturnWeightPointer(InitNuFlav, FinalNuFlav, EnergyVal, CosineZVal);
    return *Pointer;
  }
  
  // ========================================================================================================================================================================
  // Public virtual functions which need calculater specific implementations
 
  virtual const FLOAT_T* ReturnWeightPointer(int InitNuFlav, int FinalNuFlav, FLOAT_T EnergyVal, FLOAT_T CosineZVal=DUMMYVAL) = 0;
 
  virtual std::vector<FLOAT_T> ReturnBinEdgesForPlotting(bool ReturnEnergy) = 0;
 
 protected:
  OscillatorBase(std::string ConfigName_);
  
  OscillatorBase(YAML::Node Config_);
 
  // ========================================================================================================================================================================
  // Protected functions which are calculation implementation agnostic
 
  const FLOAT_T* ReturnPointerToWeightinCalcer(int InitNuFlav, int FinalNuFlav, FLOAT_T EnergyVal, FLOAT_T CosineZVal=DUMMYVAL);
  
  // ========================================================================================================================================================================
  // Protected virtual functions which are calculation implementation agnostic
 
  virtual void PostCalculateProbabilities() {}
 
  virtual void SetupOscillatorImplementation() {}
 
  // ========================================================================================================================================================================
  // Basic protected variables required for oscillation probability calculation
 
  bool fCosineZIgnored;
 
  bool fEvalPointsSetInConstructor;
 
  OscProbCalcerBase* fOscProbCalcer;
 
  std::string fCalculationTypeName;
 
  int fVerbose;
 
  YAML::Node Config;
 
 private:
 
  void InitialiseOscProbCalcer();
 
  void Initialise(YAML::Node Config_);
 
  // ========================================================================================================================================================================
  // Basic private variables required for oscillation probability calculation
 
  bool fOscProbCalcerSet;
 
};
 
#endif