BornAgain  1.19.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 reflection and scattering
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_SAMPLE_HARDPARTICLE_FORMFACTORANISOPYRAMID_H
16 #define BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORANISOPYRAMID_H
17 
19 
20 //! A frustum (truncated pyramid) with rectangular base.
21 //! @ingroup hardParticle
22 
24 public:
25  FormFactorAnisoPyramid(const std::vector<double> P);
26  FormFactorAnisoPyramid(double length, double width, double height, double alpha);
27 
29  {
31  }
32  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
33 
34  double getLength() const { return m_length; }
35  double getWidth() const { return m_width; }
36  double getHeight() const { return m_height; }
37  double getAlpha() const { return m_alpha; }
38 
39 protected:
40  IFormFactor* sliceFormFactor(ZLimits limits, const IRotation& rot,
41  kvector_t translation) const final;
42 
43  void onChange() final;
44 
45 private:
47 
48  const double& m_length;
49  const double& m_width;
50  const double& m_height;
51  const double& m_alpha;
52 };
53 
54 #endif // BORNAGAIN_SAMPLE_HARDPARTICLE_FORMFACTORANISOPYRAMID_H
Defines interface IFormFactorPolyhedron.
A frustum (truncated pyramid) with rectangular base.
void onChange() final
Action to be taken in inherited class when a parameter has changed.
FormFactorAnisoPyramid(const std::vector< double > P)
static const PolyhedralTopology topology
FormFactorAnisoPyramid * 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.
A polyhedron, for form factor computation.
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
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:45