BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorTruncatedSphere.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/HardParticle/FormFactorTruncatedSphere.h
6 //! @brief Defines class FormFactorTruncatedSphere.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************** //
14 
15 #ifndef BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORTRUNCATEDSPHERE_H
16 #define BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORTRUNCATEDSPHERE_H
17 
19 
20 //! A truncated Sphere.
21 //! @ingroup hardParticle
22 
24 {
25 public:
26  FormFactorTruncatedSphere(const std::vector<double> P);
27  FormFactorTruncatedSphere(double radius, double height, double dh);
28 
29  FormFactorTruncatedSphere* clone() const override final
30  {
32  }
33  void accept(INodeVisitor* visitor) const override final { visitor->visit(this); }
34 
35  double getHeight() const { return m_height; }
36  double getRadius() const { return m_radius; }
37  double getRemovedTop() const { return m_dh; }
38 
39  double radialExtension() const override final { return m_radius; }
40 
41  complex_t evaluate_for_q(cvector_t q) const override final;
42 
43 protected:
44  IFormFactor* sliceFormFactor(ZLimits limits, const IRotation& rot,
45  kvector_t translation) const override final;
46 
47  void onChange() override final;
48 
49 private:
50  bool check_initialization() const;
51  complex_t Integrand(double Z) const;
52 
53  const double& m_radius;
54  const double& m_height;
55  const double& m_dh;
56  mutable cvector_t m_q;
57 };
58 
59 #endif // BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORTRUNCATEDSPHERE_H
std::complex< double > complex_t
Definition: Complex.h:20
Defines pure virtual interface class IFormFactorBorn.
FormFactorTruncatedSphere * clone() const override final
Returns a clone of this ISample object.
void onChange() override final
Action to be taken in inherited class when a parameter has changed.
complex_t Integrand(double Z) const
Integrand for complex form factor.
double radialExtension() const override final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape.
complex_t evaluate_for_q(cvector_t q) const override final
Complex form factor.
void accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
FormFactorTruncatedSphere(const std::vector< double > P)
IFormFactor * sliceFormFactor(ZLimits limits, const IRotation &rot, kvector_t translation) const override final
Actually slices the form factor or throws an exception.
Pure virtual base class for Born form factors.
Pure virtual base class for all form factors.
Definition: IFormFactor.h:40
Visitor interface to visit ISample objects.
Definition: INodeVisitor.h:149
Pure virtual interface for rotations.
Definition: Rotations.h:27
Class that contains upper and lower limits of the z-coordinate for the slicing of form factors.
Definition: ZLimits.h:41
const double radius(5 *Units::nanometer)