FormFactorDWBAPol.h

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Sample/Scattering/FormFactorDWBAPol.h
//! @brief     Defines class FormFactorDWBAPol.
//!
//! @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_CORE_MULTILAYER_FORMFACTORDWBAPOL_H
#define BORNAGAIN_CORE_MULTILAYER_FORMFACTORDWBAPOL_H
 
#include "Sample/Scattering/IFormFactor.h"
#include <memory>
 
class ILayerRTCoefficients;
 
//! Evaluates the coherent sum of the 16 matrix DWBA terms in a polarized IFormFactor.
 
//! @ingroup formfactors_internal
 
class FormFactorDWBAPol final : public IFormFactor
{
public:
    FormFactorDWBAPol(const IFormFactor& form_factor);
    ~FormFactorDWBAPol() override;
 
    FormFactorDWBAPol* clone() const override;
 
    void accept(INodeVisitor* visitor) const override { visitor->visit(this); }
 
    void setAmbientMaterial(const Material& material) override
    {
        mP_form_factor->setAmbientMaterial(material);
    }
 
    //! Throws not-implemented exception
    complex_t evaluate(const WavevectorInfo& wavevectors) const override;
 
    //! Calculates and returns a polarized form factor calculation in DWBA
    Eigen::Matrix2cd evaluatePol(const WavevectorInfo& wavevectors) const override;
 
    double volume() const override { return mP_form_factor->volume(); }
 
    double radialExtension() const override { return mP_form_factor->radialExtension(); }
 
    double bottomZ(const IRotation& rotation) const override;
 
    double topZ(const IRotation& rotation) const override;
 
    void setSpecularInfo(std::unique_ptr<const ILayerRTCoefficients> p_in_coeffs,
                         std::unique_ptr<const ILayerRTCoefficients> p_out_coeffs) override;
 
    friend class TestPolarizedDWBATerms;
 
private:
    //! The form factor for BA
    std::unique_ptr<IFormFactor> mP_form_factor;
 
    std::unique_ptr<const ILayerRTCoefficients> mp_in_coeffs;
    std::unique_ptr<const ILayerRTCoefficients> mp_out_coeffs;
};
 
#endif // BORNAGAIN_CORE_MULTILAYER_FORMFACTORDWBAPOL_H