Mantid::Algorithms::IMCInteractionVolume Class Reference

Defines a base class for objects describing a volume where interactions of Tracks and Objects can take place. More...

#include <IMCInteractionVolume.h>

Inheritance diagram for Mantid::Algorithms::IMCInteractionVolume:

Public Types
enum class	ScatteringPointVicinity { SAMPLEANDENVIRONMENT , SAMPLEONLY , ENVIRONMENTONLY }

Public Member Functions
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 Geometry::IObject_sptr	getGaugeVolume () const =0
virtual void	setActiveRegion (const Geometry::BoundingBox &region)=0
virtual void	setGaugeVolume (Geometry::IObject_sptr gaugeVolume)=0
virtual	~IMCInteractionVolume ()=default

Protected Member Functions
virtual void	init ()=0

Detailed Description

Defines a base class for objects describing a volume where interactions of Tracks and Objects can take place.

Definition at line 36 of file IMCInteractionVolume.h.

Member Enumeration Documentation

ScatteringPointVicinity

enum class Mantid::Algorithms::IMCInteractionVolume::ScatteringPointVicinity

strong

Enumerator
SAMPLEANDENVIRONMENT
SAMPLEONLY
ENVIRONMENTONLY

Definition at line 38 of file IMCInteractionVolume.h.

Constructor & Destructor Documentation

~IMCInteractionVolume()

virtual Mantid::Algorithms::IMCInteractionVolume::~IMCInteractionVolume ( )

virtualdefault

Member Function Documentation

calculateBeforeAfterTrack()

virtual TrackPair Mantid::Algorithms::IMCInteractionVolume::calculateBeforeAfterTrack ( Kernel::PseudoRandomNumberGenerator &  rng, const Kernel::V3D &  startPos, const Kernel::V3D &  endPos, MCInteractionStatistics &  stats  ) const

pure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

generatePoint()

virtual ComponentScatterPoint Mantid::Algorithms::IMCInteractionVolume::generatePoint ( Kernel::PseudoRandomNumberGenerator &  rng ) const

pure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

getFullBoundingBox()

virtual const Geometry::BoundingBox Mantid::Algorithms::IMCInteractionVolume::getFullBoundingBox ( ) const

pure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

getGaugeVolume()

virtual Geometry::IObject_sptr Mantid::Algorithms::IMCInteractionVolume::getGaugeVolume ( ) const

pure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

init()

virtual void Mantid::Algorithms::IMCInteractionVolume::init ( )

protectedpure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

setActiveRegion()

virtual void Mantid::Algorithms::IMCInteractionVolume::setActiveRegion ( const Geometry::BoundingBox &  region )

pure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

setGaugeVolume()

virtual void Mantid::Algorithms::IMCInteractionVolume::setGaugeVolume ( Geometry::IObject_sptr  gaugeVolume )

pure virtual

Implemented in Mantid::Algorithms::MCInteractionVolume.

---

The documentation for this class was generated from the following file:

• Framework/Algorithms/inc/MantidAlgorithms/SampleCorrections/IMCInteractionVolume.h