BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorEllipsoidalCylinder.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/HardParticle/FormFactorEllipsoidalCylinder.h
6 //! @brief Defines class FormFactorEllipsoidalCylinder
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_FORMFACTORELLIPSOIDALCYLINDER_H
16 #define BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORELLIPSOIDALCYLINDER_H
17 
19 
20 //! A cylinder with elliptical base.
21 //! @ingroup hardParticle
22 
24 public:
25  FormFactorEllipsoidalCylinder(const std::vector<double> P);
26  FormFactorEllipsoidalCylinder(double radius_x, double radius_y, double height);
27 
29  {
31  }
32  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
33 
34  double getRadiusX() const { return m_radius_x; }
35  double getRadiusY() const { return m_radius_y; }
36  double getHeight() const { return m_height; }
37 
38  double radialExtension() const final;
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  const double& m_radius_x;
50  const double& m_radius_y;
51  const double& m_height;
52 };
53 
54 #endif // BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORELLIPSOIDALCYLINDER_H
std::complex< double > complex_t
Definition: Complex.h:20
Defines interface IBornFF.
A cylinder with elliptical base.
FormFactorEllipsoidalCylinder * clone() const final
Returns a clone of this ISampleNode object.
double radialExtension() const final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape.
IFormFactor * sliceFormFactor(ZLimits limits, const IRotation &rot, kvector_t translation) const final
Actually slices the form factor or throws an exception.
complex_t evaluate_for_q(cvector_t q) const final
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f.
void accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
FormFactorEllipsoidalCylinder(const std::vector< double > P)
void onChange() final
Action to be taken in inherited class when a parameter has changed.
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