BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorCylinder.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/HardParticle/FormFactorCylinder.h
6 //! @brief Defines class FormFactorCylinder.
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_FORMFACTORCYLINDER_H
16 #define BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORCYLINDER_H
17 
19 
20 //! A circular cylinder.
21 //! @ingroup hardParticle
22 
23 class FormFactorCylinder : public IBornFF {
24 public:
25  FormFactorCylinder(const std::vector<double> P);
26  FormFactorCylinder(double radius, double height);
27 
28  FormFactorCylinder* clone() const final { return new FormFactorCylinder(m_radius, m_height); }
29  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
30 
31  double getHeight() const { return m_height; }
32  double getRadius() const { return m_radius; }
33 
34  double radialExtension() const final { return m_radius; }
35 
36  complex_t evaluate_for_q(cvector_t q) const final;
37 
38 protected:
39  IFormFactor* sliceFormFactor(ZLimits limits, const IRotation& rot,
40  kvector_t translation) const final;
41 
42  void onChange() final;
43 
44 private:
45  const double& m_radius;
46  const double& m_height;
47 };
48 
49 #endif // BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORCYLINDER_H
std::complex< double > complex_t
Definition: Complex.h:20
Defines interface IBornFF.
A circular cylinder.
double radialExtension() const final
Returns the (approximate in some cases) radial size of the particle of this form factor's shape.
FormFactorCylinder(const std::vector< double > P)
complex_t evaluate_for_q(cvector_t q) const final
Returns scattering amplitude for complex scattering wavevector q=k_i-k_f.
FormFactorCylinder * clone() const final
Returns a clone of this ISampleNode object.
void accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
IFormFactor * sliceFormFactor(ZLimits limits, const IRotation &rot, kvector_t translation) const final
Actually slices the form factor or throws an exception.
const double & m_height
double getHeight() const
double getRadius() const
const double & m_radius
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