BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorFullSpheroid.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/HardParticle/FormFactorFullSpheroid.h
6 //! @brief Defines class FormFactorFullSpheroid.
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_FORMFACTORFULLSPHEROID_H
16 #define BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORFULLSPHEROID_H
17 
19 
20 //! A full spheroid (an ellipsoid with two equal axes, hence with circular cross section)
21 //! @ingroup hardParticle
22 
24 {
25 public:
26  FormFactorFullSpheroid(const std::vector<double> P);
27  FormFactorFullSpheroid(double radius, double height);
28 
29  FormFactorFullSpheroid* 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 
38  double radialExtension() const override final { return m_radius; }
39 
40  complex_t evaluate_for_q(cvector_t q) const override final;
41 
42 protected:
43  IFormFactor* sliceFormFactor(ZLimits limits, const IRotation& rot,
44  kvector_t translation) const override final;
45 
46  void onChange() override final;
47 
48 private:
49  const double& m_radius;
50  const double& m_height;
51 };
52 
53 #endif // BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORFULLSPHEROID_H
std::complex< double > complex_t
Definition: Complex.h:20
Defines pure virtual interface class IFormFactorBorn.
A full spheroid (an ellipsoid with two equal axes, hence with circular cross section)
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
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f.
FormFactorFullSpheroid(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.
void accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
FormFactorFullSpheroid * 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.
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)