BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorAnisoPyramid.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/HardParticle/FormFactorAnisoPyramid.h
6 //! @brief Defines class FormFactorAnisoPyramid
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_FORMFACTORANISOPYRAMID_H
16 #define BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORANISOPYRAMID_H
17 
19 
20 //! A frustum (truncated pyramid) with rectangular base.
21 //! @ingroup hardParticle
22 
24 {
25 public:
26  FormFactorAnisoPyramid(const std::vector<double> P);
27  FormFactorAnisoPyramid(double length, double width, double height, double alpha);
28 
29  FormFactorAnisoPyramid* clone() const override final
30  {
32  }
33  void accept(INodeVisitor* visitor) const override final { visitor->visit(this); }
34 
35  double getLength() const { return m_length; }
36  double getWidth() const { return m_width; }
37  double getHeight() const { return m_height; }
38  double getAlpha() const { return m_alpha; }
39 
40 protected:
41  IFormFactor* sliceFormFactor(ZLimits limits, const IRotation& rot,
42  kvector_t translation) const override final;
43 
44  void onChange() override final;
45 
46 private:
48 
49  const double& m_length;
50  const double& m_width;
51  const double& m_height;
52  const double& m_alpha;
53 };
54 
55 #endif // BORNAGAIN_CORE_HARDPARTICLE_FORMFACTORANISOPYRAMID_H
Defines class IFormFactorPolyhedron.
A frustum (truncated pyramid) with rectangular base.
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.
void onChange() override final
Action to be taken in inherited class when a parameter has changed.
FormFactorAnisoPyramid(const std::vector< double > P)
FormFactorAnisoPyramid * clone() const override final
Returns a clone of this ISample object.
static const PolyhedralTopology topology
A polyhedron, for form factor computation.
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
For internal use in IFormFactorPolyhedron.
Class that contains upper and lower limits of the z-coordinate for the slicing of form factors.
Definition: ZLimits.h:41