IFresnelMap.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Fresnel/IFresnelMap.h
//! @brief     Defines interface IFresnelMap.
//!
//! @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_SAMPLE_FRESNEL_IFRESNELMAP_H
#define BORNAGAIN_SAMPLE_FRESNEL_IFRESNELMAP_H
 
#include "Sample/Specular/ISpecularStrategy.h"
#include <memory>
#include <vector>
 
class SimulationElement;
 
//! Holds the necessary information to calculate the radiation wavefunction in every layer
//! for different incoming (outgoing) angles of the beam in the top layer
//! (these amplitudes correspond to the specular part of the wavefunction).
//! @ingroup algorithms_internal
 
class IFresnelMap {
public:
    IFresnelMap(std::unique_ptr<ISpecularStrategy> strategy);
    virtual ~IFresnelMap();
 
    //! Retrieves the amplitude coefficients for a (time-reversed) outgoing wavevector.
    virtual std::unique_ptr<const ILayerRTCoefficients>
    getOutCoefficients(const SimulationElement& sim_element, size_t layer_index) const = 0;
 
    //! Retrieves the amplitude coefficients for an incoming wavevector.
    template <typename T>
    std::unique_ptr<const ILayerRTCoefficients> getInCoefficients(const T& sim_element,
                                                                  size_t layer_index) const
    {
        return getCoefficients(sim_element.getKi(), layer_index);
    }
 
    virtual void setSlices(const std::vector<Slice>& slices);
    const std::vector<Slice>& slices() const;
 
    //! Disables caching of previously computed Fresnel coefficients
    void disableCaching();
 
protected:
    virtual std::unique_ptr<const ILayerRTCoefficients>
    getCoefficients(const kvector_t& kvec, size_t layer_index) const = 0;
 
    std::vector<Slice> m_slices;
    bool m_use_cache;
 
    std::unique_ptr<ISpecularStrategy> m_Strategy;
};
 
#endif // BORNAGAIN_SAMPLE_FRESNEL_IFRESNELMAP_H
#endif // USER_API