CosineRipple.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/HardParticle/CosineRipple.h
//! @brief     Defines classes CosineRipple*.
//!
//! @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_SAMPLE_HARDPARTICLE_COSINERIPPLE_H
#define BORNAGAIN_SAMPLE_HARDPARTICLE_COSINERIPPLE_H
 
#include "Sample/HardParticle/IProfileRipple.h"
 
//! The form factor for a cosine ripple, with box profile in elongation direction.
//! @ingroup legacyGrating
class CosineRippleBox : public ICosineRipple {
public:
    CosineRippleBox(double length, double width, double height);
#ifndef USER_API
    CosineRippleBox(std::vector<double> P);
    CosineRippleBox* clone() const override;
    std::string className() const final { return "CosineRippleBox"; }
    // const auto tooltip = "class_tooltip";
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"Length", "nm", "Characteristic length", 0, INF, 1.},
                {"Width", "nm", "Width", 0, INF, 1.},
                {"Height", "nm", "Height", 0, INF, 1.}};
    }
 
private:
    complex_t factor_x(complex_t qx) const override;
#endif // USER_API
};
 
//! The form factor for a cosine ripple, with Gaussian profile in elongation direction.
//! @ingroup legacyGrating
class CosineRippleGauss : public ICosineRipple {
public:
    CosineRippleGauss(double length, double width, double height);
#ifndef USER_API
    CosineRippleGauss(std::vector<double> P);
    CosineRippleGauss* clone() const override;
    std::string className() const final { return "CosineRippleGauss"; }
    // const auto tooltip = "class_tooltip";
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"Length", "nm", "Characteristic length", 0, INF, 1.},
                {"Width", "nm", "Width", 0, INF, 1.},
                {"Height", "nm", "Height", 0, INF, 1.}};
    }
 
private:
    complex_t factor_x(complex_t qx) const override;
#endif // USER_API
};
 
//! The form factor for a cosine ripple, with Lorentz form factor in elongation direction.
//! @ingroup legacyGrating
class CosineRippleLorentz : public ICosineRipple {
public:
    CosineRippleLorentz(double length, double width, double height);
#ifndef USER_API
    CosineRippleLorentz(std::vector<double> P);
    CosineRippleLorentz* clone() const override;
    std::string className() const final { return "CosineRippleLorentz"; }
    // const auto tooltip = "class_tooltip";
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"Length", "nm", "Characteristic length", 0, INF, 1.},
                {"Width", "nm", "Width", 0, INF, 1.},
                {"Height", "nm", "Height", 0, INF, 1.}};
    }
 
private:
    complex_t factor_x(complex_t qx) const override;
#endif // USER_API
};
 
#endif // BORNAGAIN_SAMPLE_HARDPARTICLE_COSINERIPPLE_H