SpecularSimulation.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sim/Simulation/SpecularSimulation.h
//! @brief     Defines class SpecularSimulation.
//!
//! @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)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_SIM_SIMULATION_SPECULARSIMULATION_H
#define BORNAGAIN_SIM_SIMULATION_SPECULARSIMULATION_H
 
#include "Sim/Simulation/ISimulation.h"
 
class IAxis;
class IFootprintFactor;
class ISpecularScan;
class PolMatrices;
class SpecularElement;
 
 
//! Specular reflectometry simulation.
//!
//! Holds an instrument and sample model.
//! Computes detected intensity as function of the glancing angles alpha_i=alpha_f.
//! @ingroup simulation
 
class SpecularSimulation : public ISimulation {
public:
    SpecularSimulation(const ISpecularScan& scan, const MultiLayer& sample);
    ~SpecularSimulation() override;
    SpecularSimulation(SpecularSimulation&&);
 
    std::string className() const final { return "SpecularSimulation"; }
 
    //! Returns the total number of the intensity values in the simulation result
    size_t intensityMapSize() const override;
 
    bool force_polarized() const override;
 
#ifndef SWIG
    //! Put into a clean state for running a simulation.
    void prepareSimulation() override {}
 
    ICoordSystem* createCoordSystem() const override;
    //! Returns internal data handler
    const ISpecularScan* scan() const { return m_scan.get(); }
 
private:
    SimulationResult pack_result() override;
 
    //! Initializes the vector of ISimulation elements
    void initElementVector() override;
 
    //! Generate a single threaded computation for a given range of simulation elements
    //! @param re_sample Preprocessed version of our sample
    //! @param start Index of the first element to include into computation
    //! @param n_elements Number of elements to process
    std::unique_ptr<IComputation> createComputation(const reSample& re_sample, size_t start,
                                                    size_t n_elements) override;
 
    void checkCache() const;
 
    //! Checks the distribution validity for simulation.
    void validateParametrization(const ParameterDistribution& par_distr) const override;
 
    //! Normalize the detector counts to beam intensity, to solid angle, and to exposure angle.
    //! @param start_ind Index of the first element to operate on
    //! @param n_elements Number of elements to process
    void normalize(size_t start_ind, size_t n_elements) override;
 
    void addBackgroundIntensity(size_t start_ind, size_t n_elements) override;
 
    void addDataToCache(double weight) override;
 
    void moveDataFromCache() override;
 
    //! Gets the number of elements this simulation needs to calculate
    size_t numberOfElements() const override;
 
    std::unique_ptr<const ISpecularScan> m_scan;
    std::vector<SpecularElement> m_eles;
    std::vector<double> m_cache;
#endif // USER_API
};
 
#endif // BORNAGAIN_SIM_SIMULATION_SPECULARSIMULATION_H