Bar.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/HardParticle/Bar.h
//! @brief     Defines classes Bar*.
//!
//! @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_BAR_H
#define BORNAGAIN_SAMPLE_HARDPARTICLE_BAR_H
 
#include "Sample/HardParticle/IProfileRipple.h"
 
//! The form factor of an elongated bar, with Gaussian profile in elongation direction.
//! @ingroup legacyGrating
class BarGauss : public IProfileRectangularRipple {
public:
    BarGauss(double length, double width, double height);
#ifndef USER_API
    BarGauss(std::vector<double> P);
    BarGauss* clone() const override;
    std::string className() const final { return "BarGauss"; }
    // 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.}};
    }
#endif // USER_API
 
private:
    complex_t factor_x(complex_t qx) const override;
};
 
//! The form factor of an elongated, with Lorentz form factor in elongation direction.
//! @ingroup legacyGrating
class BarLorentz : public IProfileRectangularRipple {
public:
    BarLorentz(double length, double width, double height);
#ifndef USER_API
    BarLorentz(std::vector<double> P);
    BarLorentz* clone() const override;
    std::string className() const final { return "BarLorentz"; }
    // 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.}};
    }
#endif // USER_API
 
private:
    complex_t factor_x(complex_t qx) const override;
};
 
#endif // BORNAGAIN_SAMPLE_HARDPARTICLE_BAR_H