Sphere.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/HardParticle/Sphere.h
//! @brief     Defines class Sphere.
//!
//! @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_SPHERE_H
#define BORNAGAIN_SAMPLE_HARDPARTICLE_SPHERE_H
 
#include "Sample/Particle/IFormFactor.h"
 
//! A full sphere.
//! @ingroup hardParticle
 
class Sphere : public IFormFactor {
public:
    Sphere(double radius, bool position_at_center = false);
#ifndef USER_API
    Sphere(std::vector<double> P, bool position_at_center = false);
 
    Sphere* clone() const override { return new Sphere(m_radius, m_position_at_center); }
    std::string className() const final { return "Sphere"; }
    // const auto tooltip = "sphere";
    std::vector<ParaMeta> parDefs() const final { return {{"Radius", "nm", "radius", 0, +INF, 0}}; }
 
    double radius() const { return m_radius; }
 
    double radialExtension() const override { return m_radius; }
 
    double bottomZ(const IRotation* rotation) const override;
 
    double topZ(const IRotation* rotation) const override;
 
    complex_t formfactor_at_bottom(C3 q) const override;
 
protected:
    bool canSliceAnalytically(const IRotation*) const override { return true; }
 
private:
    const double& m_radius;
    bool m_position_at_center;
#endif // USER_API
};
 
#endif // BORNAGAIN_SAMPLE_HARDPARTICLE_SPHERE_H