TruncatedSpheroid.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/HardParticle/TruncatedSpheroid.h
//! @brief     Defines class TruncatedSpheroid.
//!
//! @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_TRUNCATEDSPHEROID_H
#define BORNAGAIN_SAMPLE_HARDPARTICLE_TRUNCATEDSPHEROID_H
 
#include "Sample/Particle/IFormFactor.h"
 
//! A truncated spheroid.
//! An ellipsoid with two equal axis, truncated by a plane perpendicular to the third axis.
//! @ingroup hardParticle
 
class TruncatedSpheroid : public IFormFactor {
public:
    TruncatedSpheroid(double radius, double height, double height_flattening, double dh);
#ifndef USER_API
    TruncatedSpheroid(std::vector<double> P);
 
    TruncatedSpheroid* clone() const override
    {
        return new TruncatedSpheroid(m_radius, m_height, m_height_flattening, m_dh);
    }
    std::string className() const final { return "TruncatedSpheroid"; }
    // const auto tooltip = "class_tooltip";
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"Radius", "nm", "horizontal radius", 0, +INF, 0},
                {"Height", "nm", "height before removal of cap", 0, +INF, 0},
                {"HeightFlattening", "", "ratio of vertical to horizontal radius", 0, +INF, 0},
                {"DeltaHeight", "nm", "height of removed cap", 0, +INF, 0}};
    }
 
    double radius() const { return m_radius; }
    double height() const { return m_height; }
    double heightFlattening() const { return m_height_flattening; }
    double removedTop() const { return m_dh; }
 
    double radialExtension() const override { return m_radius; }
 
    complex_t formfactor_at_bottom(C3 q) const override;
 
private:
    const double& m_radius;
    const double& m_height;
    const double& m_height_flattening;
    const double& m_dh;
#endif // USER_API
};
 
#endif // BORNAGAIN_SAMPLE_HARDPARTICLE_TRUNCATEDSPHEROID_H