ILayerRTCoefficients.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/RT/ILayerRTCoefficients.h
//! @brief     Defines and implements class ILayerRTCoefficients.
//!
//! @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_RT_ILAYERRTCOEFFICIENTS_H
#define BORNAGAIN_SAMPLE_RT_ILAYERRTCOEFFICIENTS_H
 
#include "Base/Types/Complex.h"
#include "Base/Vector/EigenCore.h"
 
//! Interface to access reflection/transmission coefficients.
//! @ingroup algorithms_internal
 
class ILayerRTCoefficients {
public:
    virtual ~ILayerRTCoefficients() {}
 
    virtual ILayerRTCoefficients* clone() const = 0;
 
#ifndef SWIG
    //! The following functions return the transmitted and reflected amplitudes
    //! for different incoming beam polarizations and eigenmodes
    virtual Eigen::Vector2cd T1plus() const = 0;
    virtual Eigen::Vector2cd R1plus() const = 0;
    virtual Eigen::Vector2cd T2plus() const = 0;
    virtual Eigen::Vector2cd R2plus() const = 0;
    virtual Eigen::Vector2cd T1min() const = 0;
    virtual Eigen::Vector2cd R1min() const = 0;
    virtual Eigen::Vector2cd T2min() const = 0;
    virtual Eigen::Vector2cd R2min() const = 0;
    //! Returns z-part of the two wavevector eigenmodes
    virtual Eigen::Vector2cd getKz() const = 0;
    //! Scalar value getters; these throw errors by default as they should only
    //! be used when the derived object is really scalar
#endif
    virtual complex_t getScalarT() const
    {
        throw std::runtime_error("ILayerRTCoefficients::"
                                 "getScalarT(): coefficients are not scalar.");
    }
    virtual complex_t getScalarR() const
    {
        throw std::runtime_error("ILayerRTCoefficients::"
                                 "getScalarR(): coefficients are not scalar.");
    }
    virtual complex_t getScalarKz() const
    {
        throw std::runtime_error("ILayerRTCoefficients::"
                                 "getScalarKz(): coefficients are not scalar.");
    }
 
    virtual Eigen::Matrix2cd getReflectionMatrix() const
    {
        throw std::runtime_error("Only defined for Matrix coefficeints");
    }
};
 
#endif // BORNAGAIN_SAMPLE_RT_ILAYERRTCOEFFICIENTS_H
#endif // USER_API