DepthProbeElement.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Base/Element/DepthProbeElement.h
//! @brief     Defines class DepthProbeElement.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_BASE_ELEMENT_DEPTHPROBEELEMENT_H
#define BORNAGAIN_BASE_ELEMENT_DEPTHPROBEELEMENT_H
 
#include "Base/Element/IElement.h"
#include <heinz/Vectors3D.h>
#include <valarray>
 
class IAxis;
 
class DepthProbeElement : public IElement {
public:
    DepthProbeElement(double wavelength, double alpha_i, const IAxis* z_positions);
    DepthProbeElement(const DepthProbeElement& other) = delete;
    DepthProbeElement(DepthProbeElement&& other);
 
    ~DepthProbeElement();
 
    double wavelength() const { return m_wavelength; }
    double alphaI() const { return m_alpha_i; }
    R3 getKi() const;
 
    template <typename T>
    void setIntensities(T&& intensities)
    {
        static_assert(
            std::is_assignable<std::valarray<double>, typename std::decay<T>::type>::value,
            "Error in DepthProbeElement::setIntensities: wrong type of input data.");
        m_intensities = std::forward<T>(intensities);
    }
 
    const std::valarray<double>& getIntensities() const { return m_intensities; }
 
    void setZPositions(const IAxis* z_positions) { m_z_positions = z_positions; }
    const IAxis* getZPositions() const { return m_z_positions; }
 
    size_t size() const { return m_intensities.size(); }
 
    //! Set calculation flag (if it's false, zero intensity is assigned to the element)
    void setCalculationFlag(bool calculation_flag) { m_calculation_flag = calculation_flag; }
    bool isCalculated() const { return m_calculation_flag; }
 
private:
    double m_wavelength, m_alpha_i;      //!< the wavelength and the incident angle of the beam
    std::valarray<double> m_intensities; //!< simulated intensity for the set of z positions
    const IAxis* m_z_positions;          //!< positions (lower z corresponds to a greater depth)
    bool m_calculation_flag;
};
 
#endif // BORNAGAIN_BASE_ELEMENT_DEPTHPROBEELEMENT_H
#endif // USER_API