IMCInteractionVolume.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAlgorithms/DllConfig.h"
#include "MantidAlgorithms/SampleCorrections/MCInteractionStatistics.h"
#include "MantidGeometry/Objects/BoundingBox.h"
 
namespace Mantid {
namespace Geometry {
class IObject;
class Track;
} // namespace Geometry
 
namespace Kernel {
class PseudoRandomNumberGenerator;
class V3D;
} // namespace Kernel
namespace Algorithms {
 
struct ComponentScatterPoint {
  int componentIndex;
  Kernel::V3D scatterPoint;
};
 
using TrackPair = std::tuple<bool, std::shared_ptr<Geometry::Track>, std::shared_ptr<Geometry::Track>>;
 
class MANTID_ALGORITHMS_DLL IMCInteractionVolume {
public:
  enum class ScatteringPointVicinity { SAMPLEANDENVIRONMENT, SAMPLEONLY, ENVIRONMENTONLY };
  virtual ~IMCInteractionVolume() = default;
  virtual TrackPair calculateBeforeAfterTrack(Kernel::PseudoRandomNumberGenerator &rng, const Kernel::V3D &startPos,
                                              const Kernel::V3D &endPos, MCInteractionStatistics &stats) const = 0;
  virtual ComponentScatterPoint generatePoint(Kernel::PseudoRandomNumberGenerator &rng) const = 0;
  virtual const Geometry::BoundingBox getFullBoundingBox() const = 0;
  virtual void setActiveRegion(const Geometry::BoundingBox &region) = 0;
  virtual Geometry::IObject_sptr getGaugeVolume() const = 0;
  virtual void setGaugeVolume(Geometry::IObject_sptr gaugeVolume) = 0;
 
protected:
  virtual void init() = 0;
};
} // namespace Algorithms
} // namespace Mantid