BornAgain  1.19.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 reflection and scattering
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_SAMPLE_HARDPARTICLE_FORMFACTORTRUNCATEDSPHERE_H
16 #define BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORTRUNCATEDSPHERE_H
17 
19 
20 //! A truncated Sphere.
21 //! @ingroup hardParticle
22 
24 public:
25  FormFactorTruncatedSphere(const std::vector<double> P);
26  FormFactorTruncatedSphere(double radius, double height, double dh);
27 
29  {
31  }
32  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
33 
34  double getHeight() const { return m_height; }
35  double getRadius() const { return m_radius; }
36  double getRemovedTop() const { return m_dh; }
37 
38  double radialExtension() const final { return m_radius; }
39 
40  complex_t evaluate_for_q(cvector_t q) const final;
41 
42 protected:
43  IFormFactor* sliceFormFactor(ZLimits limits, const IRotation& rot,
44  kvector_t translation) const final;
45 
46  void onChange() final;
47 
48 private:
49  bool check_initialization() const;
50  complex_t Integrand(double Z) const;
51 
52  const double& m_radius;
53  const double& m_height;
54  const double& m_dh;
55  mutable cvector_t m_q;
56 };
57 
58 #endif // BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORTRUNCATEDSPHERE_H
std::complex< double > complex_t
Definition: Complex.h:20
Defines interface IBornFF.
complex_t evaluate_for_q(cvector_t q) const final
Complex form factor.
complex_t Integrand(double Z) const
Integrand for complex form factor.
double radialExtension() const final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape.
void accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
void onChange() final
Action to be taken in inherited class when a parameter has changed.
FormFactorTruncatedSphere * clone() const final
Returns a clone of this ISampleNode object.
FormFactorTruncatedSphere(const std::vector< double > P)
IFormFactor * sliceFormFactor(ZLimits limits, const IRotation &rot, kvector_t translation) const final
Actually slices the form factor or throws an exception.
Abstract base class for Born form factors.
Definition: IBornFF.h:41
Abstract base class for all form factors.
Definition: IFormFactor.h:36
Visitor interface to visit ISampleNode objects.
Definition: INodeVisitor.h:146
Abstract base class for rotations.
Definition: Rotations.h:28
Class that contains upper and lower limits of the z-coordinate for the slicing of form factors.
Definition: ZLimits.h:45