ComputeBAPol.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/FFCompute/ComputeBAPol.h
//! @brief     Defines class ComputeBAPol.
//!
//! @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_FFCOMPUTE_COMPUTEBAPOL_H
#define BORNAGAIN_SAMPLE_FFCOMPUTE_COMPUTEBAPOL_H
 
#include "Sample/FFCompute/IComputeFF.h"
#include "Sample/Scattering/IFormFactor.h"
#include <memory>
 
//! Provides polarized form factor evaluation in Born Approximation for given IFormFactor.
 
//! @ingroup formfactors_internal
 
class ComputeBAPol : public IComputeFF {
public:
    ComputeBAPol(const IFormFactor& ff);
    ~ComputeBAPol() override;
 
    ComputeBAPol* clone() const override;
 
    //! Throws not-implemented exception
    complex_t evaluate(const WavevectorInfo& wavevectors) const override;
 
    //! Calculates and returns a polarized form factor calculation in BA
    Eigen::Matrix2cd evaluatePol(const WavevectorInfo& wavevectors) const override;
};
 
#endif // BORNAGAIN_SAMPLE_FFCOMPUTE_COMPUTEBAPOL_H
#endif // USER_API