Description

An incident neutron or x-ray beam.

Definition at line 28 of file Beam.h.

Inheritance diagram for Beam:

Collaboration diagram for Beam:

Public Member Functions
	Beam (const Beam &other)

	Beam (double intensity, double wavelength, const Direction &direction)

	~Beam () override

void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...

std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...

Beam *	clone () const

Direction	direction () const

const IFootprintFactor *	footprintFactor () const
	Returns footprint factor. More...

double	intensity () const
	Returns the beam intensity in neutrons/sec. More...

std::vector< const INode * >	nodeChildren () const override
	Returns all children. More...

std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...

Beam &	operator= (const Beam &other)

virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...

SpinMatrix	polMatrix () const
	Returns the polarization density matrix (in spin basis along z-axis) More...

R3	polVector () const
	Returns polarization density as Bloch vector. More...

void	setAzimuthalAngleGuarded (double value)
	Check for limits, set the value if within limits. Throws if limits are violated. More...

void	setDirection (const Direction &direction)

void	setFootprintFactor (const IFootprintFactor &shape_factor)
	Sets footprint factor to the beam. More...

void	setInclination (double alpha)

void	setInclinationAngleGuarded (double value)
	Check for limits, set the value if within limits. Throws if limits are violated. More...

void	setInclinationLimits (const RealLimits &limits)

void	setIntensity (double intensity)
	Sets the beam intensity in neutrons/sec. More...

void	setPolarization (R3 bloch_vector)
	Sets the polarization density matrix according to the given Bloch vector. More...

void	setWavelength (double wavelength)

void	setWavelengthGuarded (double value)
	Check for limits, set the value if within limits. Throws if limits are violated. More...

double	wavelength () const

Static Public Member Functions
static Beam	horizontalBeam ()

Protected Attributes
std::vector< double >	m_P

Private Member Functions
	Beam ()

Private Attributes
double	m_alpha

RealLimits	m_alphaLimits

R3	m_beamPolarization
	Bloch vector encoding the beam's polarization. More...

double	m_intensity
	beam intensity (neutrons/sec) More...

double	m_phi

std::unique_ptr< IFootprintFactor >	m_shape_factor
	footprint correction handler More...

double	m_wavelength

Friends
class	DepthProbeSimulationTest

Constructor & Destructor Documentation

◆ Beam() [1/3]

Beam::Beam	(	double	intensity,
		double	wavelength,
		const Direction &	direction
	)

Definition at line 33 of file Beam.cpp.

     : m_intensity(intensity)
     , m_wavelength(wavelength)
     // , m_direction(direction)
     , m_alpha(direction.alpha())
     , m_phi(direction.phi())
     , m_alphaLimits(RealLimits::limited(-INCLINATION_LIMIT, INCLINATION_LIMIT))
 {
     RealLimits::nonnegative().check("Intensity", m_intensity);
  
     wavelengthLimits.check("Wavelength", m_wavelength);
     m_alphaLimits.check("InclinationAngle", m_alpha);
     phiLimits.check("AzimuthalAngle", m_phi);
 }

References RealLimits::check(), m_alpha, m_alphaLimits, m_intensity, m_phi, m_wavelength, and RealLimits::nonnegative().

Here is the call graph for this function:

◆ Beam() [2/3]

Beam::Beam ( const Beam & other )

Definition at line 53 of file Beam.cpp.

     : Beam(other.m_intensity, other.m_wavelength, other.direction())
 {
     m_beamPolarization = other.m_beamPolarization;
     if (other.m_shape_factor)
         m_shape_factor.reset(other.m_shape_factor->clone());
 }

References m_beamPolarization, and m_shape_factor.

◆ ~Beam()

Beam::~Beam ( )

overridedefault

◆ Beam() [3/3]

Beam::Beam ( )

private

Referenced by clone(), and horizontalBeam().

Member Function Documentation

◆ checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

 {
     size_t nP = m_P.size();
     if (parDefs().size() != nP) {
         std::cerr << "BUG in class " << className() << std::endl;
         std::cerr << "#m_P = " << nP << std::endl;
         std::cerr << "#PDf = " << parDefs().size() << std::endl;
         for (const ParaMeta& pm : parDefs())
             std::cerr << "  PDf: " << pm.name << std::endl;
         ASSERT(0);
     }
     ASSERT(parDefs().size() == nP);
     for (size_t i = 0; i < nP; ++i) {
         const ParaMeta pm = parDefs()[i];
  
         RealLimits limits = RealLimits::limitless();
         if (pm.vMin == -INF) {
             ASSERT(pm.vMax == +INF);
             // nothing to do
         } else if (pm.vMax == +INF) {
             ASSERT(pm.vMin == 0);
             limits = RealLimits::nonnegative();
         } else {
             limits = RealLimits::limited(pm.vMin, pm.vMax);
         }
         limits.check(pm.name, m_P[i]);
     }
 }

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

◆ className()

std::string Beam::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 36 of file Beam.h.

36 { return "Beam"; }

◆ clone()

Beam * Beam::clone ( ) const

Definition at line 80 of file Beam.cpp.

 {
     return new Beam(*this);
 }

References Beam().

Here is the call graph for this function:

◆ direction()

Direction Beam::direction ( ) const

inline

Definition at line 46 of file Beam.h.

46 { return {m_alpha, m_phi}; } // TODO -> const .. &

References m_alpha, and m_phi.

Referenced by DepthProbeSimulation::generateElements(), ISimulation2D::generateElements(), RectangularDetector::indexOfSpecular(), SphericalDetector::indexOfSpecular(), RectangularDetector::scatteringCoords(), SphericalDetector::scatteringCoords(), and setDirection().

◆ footprintFactor()

const IFootprintFactor * Beam::footprintFactor ( ) const

Returns footprint factor.

Definition at line 112 of file Beam.cpp.

 {
     return m_shape_factor.get();
 }

References m_shape_factor.

Referenced by DepthProbeSimulation::normalize().

◆ horizontalBeam()

Beam Beam::horizontalBeam ( )

static

Definition at line 48 of file Beam.cpp.

 {
     return Beam(1.0, 1.0, {0, 0});
 }

References Beam().

Here is the call graph for this function:

◆ intensity()

double Beam::intensity ( ) const

inline

Returns the beam intensity in neutrons/sec.

Definition at line 43 of file Beam.h.

43 { return m_intensity; }

References m_intensity.

Referenced by DepthProbeSimulation::normalize(), ISimulation2D::normalize(), and setIntensity().

◆ nodeChildren()

std::vector< const INode * > Beam::nodeChildren ( ) const

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 160 of file Beam.cpp.

 {
     if (m_shape_factor)
         return {m_shape_factor.get()};
     return {};
 }

References m_shape_factor.

◆ nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

 {
     std::vector<const INode*> result;
     result.push_back(this);
     for (const auto* child : nodeChildren()) {
         for (const auto* p : child->nodeOffspring())
             result.push_back(p);
     }
     return result;
 }

References INode::nodeChildren().

Here is the call graph for this function:

◆ operator=()

Beam & Beam::operator= ( const Beam & other )

Definition at line 61 of file Beam.cpp.

 {
     if (&other == this)
         return *this;
     m_intensity = other.m_intensity;
     m_wavelength = other.m_wavelength;
     // m_direction = other.m_direction;
     m_alpha = other.m_alpha;
     m_phi = other.m_phi;
     m_beamPolarization = other.m_beamPolarization;
     if (other.m_shape_factor)
         m_shape_factor.reset(other.m_shape_factor->clone());
     else
         m_shape_factor.release();
     return *this;
 }

References m_alpha, m_beamPolarization, m_intensity, m_phi, m_shape_factor, and m_wavelength.

◆ parDefs()

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

51 { return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

◆ polMatrix()

SpinMatrix Beam::polMatrix ( ) const

Returns the polarization density matrix (in spin basis along z-axis)

Definition at line 155 of file Beam.cpp.

 {
     return SpinMatrix::FromBlochVector(m_beamPolarization);
 }

References SpinMatrix::FromBlochVector(), and m_beamPolarization.

Referenced by ISimulation2D::generateElements().

Here is the call graph for this function:

◆ polVector()

R3 Beam::polVector ( ) const

Returns polarization density as Bloch vector.

Definition at line 150 of file Beam.cpp.

 {
     return m_beamPolarization;
 }

References m_beamPolarization.

◆ setAzimuthalAngleGuarded()

void Beam::setAzimuthalAngleGuarded ( double value )

Check for limits, set the value if within limits. Throws if limits are violated.

Definition at line 123 of file Beam.cpp.

 {
     phiLimits.check("azimuthal angle", value);
     m_phi = value;
 }

References m_phi.

Referenced by ISimulation2D::initDistributionHandler().

◆ setDirection()

void Beam::setDirection ( const Direction & direction )

Definition at line 92 of file Beam.cpp.

 {
     if (direction.alpha() < 0.0)
         throw std::runtime_error(
             "Invalid beam parameter: Inclination angle alpha_i can't be negative.");
     // m_direction = direction;
     m_alpha = direction.alpha();
     m_phi = direction.phi();
 }

References Direction::alpha(), direction(), m_alpha, m_phi, and Direction::phi().

Referenced by DepthProbeSimulation::setBeamParameters(), and OffspecSimulation::setBeamParameters().

Here is the call graph for this function:

◆ setFootprintFactor()

void Beam::setFootprintFactor ( const IFootprintFactor & shape_factor )

Sets footprint factor to the beam.

Definition at line 135 of file Beam.cpp.

 {
     m_shape_factor.reset(shape_factor.clone());
 }

References IFootprintFactor::clone(), and m_shape_factor.

Referenced by DepthProbeSimulation::setBeamParameters().

Here is the call graph for this function:

◆ setInclination()

void Beam::setInclination ( double alpha )

Definition at line 102 of file Beam.cpp.

 {
     m_alpha = alpha;
 }

References m_alpha.

Referenced by OffspecSimulation::initElementVector().

◆ setInclinationAngleGuarded()

void Beam::setInclinationAngleGuarded ( double value )

Check for limits, set the value if within limits. Throws if limits are violated.

Definition at line 117 of file Beam.cpp.

 {
     m_alphaLimits.check("inclination angle", value);
     m_alpha = value;
 }

References RealLimits::check(), m_alpha, and m_alphaLimits.

Referenced by ISimulation2D::initDistributionHandler().

Here is the call graph for this function:

◆ setInclinationLimits()

void Beam::setInclinationLimits ( const RealLimits & limits )

Definition at line 107 of file Beam.cpp.

 {
     m_alphaLimits = limits;
 }

References m_alphaLimits.

Referenced by DepthProbeSimulation::DepthProbeSimulation().

◆ setIntensity()

void Beam::setIntensity ( double intensity )

inline

Sets the beam intensity in neutrons/sec.

Definition at line 74 of file Beam.h.

74 { m_intensity = intensity; }

References intensity(), and m_intensity.

Here is the call graph for this function:

◆ setPolarization()

void Beam::setPolarization ( R3 bloch_vector )

Sets the polarization density matrix according to the given Bloch vector.

Definition at line 140 of file Beam.cpp.

 {
     if (bloch_vector.mag() > 1.0) {
         throw std::runtime_error(
             "Beam::setPolarization: "
             "The given Bloch vector cannot represent a real physical ensemble");
     }
     m_beamPolarization = bloch_vector;
 }

References m_beamPolarization.

◆ setWavelength()

void Beam::setWavelength ( double wavelength )

Definition at line 85 of file Beam.cpp.

 {
     if (wavelength <= 0.0)
         throw std::runtime_error("Invalid beam parameter: Wavelength can't be negative or zero.");
     m_wavelength = wavelength;
 }

References m_wavelength, and wavelength().

Referenced by DepthProbeSimulation::setBeamParameters(), and OffspecSimulation::setBeamParameters().

Here is the call graph for this function:

◆ setWavelengthGuarded()

void Beam::setWavelengthGuarded ( double value )

Check for limits, set the value if within limits. Throws if limits are violated.

Definition at line 129 of file Beam.cpp.

 {
     wavelengthLimits.check("wavelength", value);
     m_wavelength = value;
 }

References m_wavelength.

Referenced by ISimulation2D::initDistributionHandler().

◆ wavelength()

double Beam::wavelength ( ) const

inline

Definition at line 44 of file Beam.h.

44 { return m_wavelength; }

References m_wavelength.

Referenced by DepthProbeSimulation::generateElements(), ISimulation2D::generateElements(), RectangularDetector::indexOfSpecular(), RectangularDetector::scatteringCoords(), SphericalDetector::scatteringCoords(), and setWavelength().

Friends And Related Function Documentation

◆ DepthProbeSimulationTest

friend class DepthProbeSimulationTest

friend

Definition at line 92 of file Beam.h.

Member Data Documentation

◆ m_alpha

double Beam::m_alpha

private

Definition at line 85 of file Beam.h.

Referenced by Beam(), direction(), operator=(), setDirection(), setInclination(), and setInclinationAngleGuarded().

◆ m_alphaLimits

RealLimits Beam::m_alphaLimits

private

Definition at line 90 of file Beam.h.

Referenced by Beam(), setInclinationAngleGuarded(), and setInclinationLimits().

◆ m_beamPolarization

R3 Beam::m_beamPolarization

private

Bloch vector encoding the beam's polarization.

Definition at line 88 of file Beam.h.

Referenced by Beam(), operator=(), polMatrix(), polVector(), and setPolarization().

◆ m_intensity

double Beam::m_intensity

private

beam intensity (neutrons/sec)

Definition at line 82 of file Beam.h.

Referenced by Beam(), intensity(), operator=(), and setIntensity().

◆ m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

◆ m_phi

double Beam::m_phi

private

Definition at line 86 of file Beam.h.

Referenced by Beam(), direction(), operator=(), setAzimuthalAngleGuarded(), and setDirection().

◆ m_shape_factor

std::unique_ptr<IFootprintFactor> Beam::m_shape_factor

private

footprint correction handler

Definition at line 87 of file Beam.h.

Referenced by Beam(), footprintFactor(), nodeChildren(), operator=(), and setFootprintFactor().

◆ m_wavelength

double Beam::m_wavelength

private

Definition at line 83 of file Beam.h.

Referenced by Beam(), operator=(), setWavelength(), setWavelengthGuarded(), and wavelength().

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

/home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Beam/Beam.h
/home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Beam/Beam.cpp

Description

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ Beam() [1/3]

◆ Beam() [2/3]

◆ ~Beam()

◆ Beam() [3/3]

Member Function Documentation

◆ checkNodeArgs()

◆ className()

◆ clone()

◆ direction()

◆ footprintFactor()

◆ horizontalBeam()

◆ intensity()

◆ nodeChildren()

◆ nodeOffspring()

◆ operator=()

◆ parDefs()

◆ polMatrix()

◆ polVector()

◆ setAzimuthalAngleGuarded()

◆ setDirection()

◆ setFootprintFactor()

◆ setInclination()

◆ setInclinationAngleGuarded()

◆ setInclinationLimits()

◆ setIntensity()

◆ setPolarization()

◆ setWavelength()

◆ setWavelengthGuarded()

◆ wavelength()

Friends And Related Function Documentation

◆ DepthProbeSimulationTest

Member Data Documentation

◆ m_alpha

◆ m_alphaLimits

◆ m_beamPolarization

◆ m_intensity

◆ m_P

◆ m_phi

◆ m_shape_factor

◆ m_wavelength