MCGenerationInfo.h

Go to the documentation of this file.

/*
 * MCGenerationInfo.h
 *
 *  Created on: 5 Nov 2018
 *      Author: Nicola Mori
 */
 
#ifndef HERD_MCGENERATIONINFO_H_
#define HERD_MCGENERATIONINFO_H_
 
#include "herd/analysis/dataobjects/Point.h"
#include "herd/analysis/dataobjects/Rectangle.h"
 
#ifdef HS_USE_ROOT
#include "Rtypes.h"
#endif
 
namespace Herd {
 
class MCGenerationInfo {
public:
  MCGenerationInfo();
 
  virtual ~MCGenerationInfo() = default;
 
  void SetGeneratorName(std::string name);
 
  [[nodiscard]] std::string GeneratorName() const;
 
  void SetAcceptanceCheck(bool accChecked);
 
  [[nodiscard]] bool WasAcceptanceCheckActive() const;
 
  void SetParticlePDGCode(int pdgCode);
 
  [[nodiscard]] int ParticlePDGCode() const;
 
  /* ******* POSITION ******* */
 
  enum class Position { NONE, POINT, SPHERE, RECTANGLE };
 
  [[nodiscard]] Position PositionType() const { return _position; }
 
  void SetPositionType(Position pos);
 
  [[nodiscard]] Point FixedPoint() const;
 
  void SetFixedPoint(Point genPoint);
 
  [[nodiscard]] Point SphereCapCenter() const;
 
  [[nodiscard]] Vec3D SphereCapPosition() const;
 
  [[nodiscard]] float SphereCapExtension() const;
 
  void SetSphereCap(Point sphereCapCenter, Vec3D sphereCapPosition, float sphereCapExtension);
 
  [[nodiscard]] Herd::Rectangle Rectangle() const;
 
  void SetRectangle(std::array<Point, 3> points);
 
  /* ******* DIRECTION ******* */
 
  enum class Direction { NONE, FIXED, ISOTROPIC, UNIFORM };
 
  [[nodiscard]] Direction DirectionType() const { return _direction; }
 
  void SetDirectionType(Direction dir);
 
  [[nodiscard]] Vec3D FixedDirection() const;
 
  void SetFixedDirection(Vec3D dir);
 
  [[nodiscard]] std::pair<float, float> IsotropicPolarAngleRange() const;
 
  [[nodiscard]] std::pair<float, float> IsotropicAzimuthAngleRange() const;
 
  [[nodiscard]] std::pair<float, float> UniformAzimuthAngleRange() const;
 
  [[nodiscard]] std::pair<float, float> UniformPolarAngleRange() const;
 
  void SetIsotropicAnglesRanges(float minPolar, float maxPolar, float minAzimuth, float maxAzimuth);
 
  void SetUniformAnglesRanges(float minPolar, float maxPolar, float minAzimuth, float maxAzimuth);
 
  /* ******* SPECTRUM ******* */
 
  enum class Spectrum { NONE, MONOCHROMATIC, POWERLAW };
 
  [[nodiscard]] Spectrum SpectrumType() const { return _spectrum; }
 
  void SetSpectrumType(Spectrum sp);
 
  [[nodiscard]] float FixedEnergy() const;
 
  void SetFixedEnergy(float energy);
 
  [[nodiscard]] std::pair<float, float> EnergyRange() const;
 
  [[nodiscard]] float SpectralIndex() const;
 
  void SetPowerLawSpectrum(float minEnergy, float maxEnergy, float spectralIndex);
 
private:
  std::string _generatorName;
  bool _acceptanceCheck;
  int _particlePdgCode;
 
  /* *** Position ***/
  Position _position;
  // fixed
  Point _fixedShootingPoint; // cm
  // sphere
  Point _sphereCapCenter;    // cm
  Vec3D _sphereCapPosition;  // cm
  float _sphereCapExtension; // rad
  // rectangle
  Herd::Rectangle _rectangle;
 
  /* *** Direction *** */
  Direction _direction;
  // fixed
  Herd::Vec3D _fixedShootingDirection;
  // isotropic
  float _minPolar, _maxPolar, _minAzimuth, _maxAzimuth; // rad
 
  /* *** Spectrum *** */
  Spectrum _spectrum;
  // monochromatic
  float _fixedShootingEnergy; // GeV
  // power law
  float _minEnergy, _maxEnergy; // GeV
  float _spectralIndex;
 
#ifdef HS_USE_ROOT
  ClassDef(MCGenerationInfo, 1)
#endif
};
 
} // namespace Herd
 
#endif /* HERD_MCGENERATIONINFO_H_ */