BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
FormFactorDecoratorRotation.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/Scattering/FormFactorDecoratorRotation.h
6 //! @brief Defines class FormFactorDecoratorRotation.
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_SCATTERING_FORMFACTORDECORATORROTATION_H
16 #define BORNAGAIN_CORE_SCATTERING_FORMFACTORDECORATORROTATION_H
17 
21 
22 //! Equips a form factor with a rotation.
23 //! @ingroup formfactors_internal
24 
26 {
27 public:
28  //! Constructor, setting form factor and rotation.
29  FormFactorDecoratorRotation(const IFormFactor& form_factor, const IRotation& rotation);
30 
31  FormFactorDecoratorRotation* clone() const override final;
32 
33  void accept(INodeVisitor* visitor) const override final { visitor->visit(this); }
34 
35  double bottomZ(const IRotation& rotation) const override final;
36 
37  double topZ(const IRotation& rotation) const override final;
38 
39  complex_t evaluate(const WavevectorInfo& wavevectors) const override final;
40 #ifndef SWIG
41  Eigen::Matrix2cd evaluatePol(const WavevectorInfo& wavevectors) const override final;
42 #endif
43 
44 private:
46  //! Private constructor for cloning.
47  FormFactorDecoratorRotation(const IFormFactor& form_factor, const Transform3D& transform);
48 };
49 
50 #endif // BORNAGAIN_CORE_SCATTERING_FORMFACTORDECORATORROTATION_H
std::complex< double > complex_t
Definition: Complex.h:20
Defines and implements pure virtual interface class IFormFactorDecorator.
Defines IRotation classes.
Declares class Transform3D.
Equips a form factor with a rotation.
complex_t evaluate(const WavevectorInfo &wavevectors) const override final
Returns scattering amplitude for complex wavevectors ki, kf.
void accept(INodeVisitor *visitor) const override final
Calls the INodeVisitor's visit method.
double topZ(const IRotation &rotation) const override final
Returns the z-coordinate of the lowest point in this shape after a given rotation.
FormFactorDecoratorRotation * clone() const override final
Returns a clone of this ISample object.
double bottomZ(const IRotation &rotation) const override final
Returns the z-coordinate of the lowest point in this shape after a given rotation.
Eigen::Matrix2cd evaluatePol(const WavevectorInfo &wavevectors) const override final
Returns scattering amplitude for matrix interactions.
FormFactorDecoratorRotation(const IFormFactor &form_factor, const IRotation &rotation)
Constructor, setting form factor and rotation.
Encapsulates another formfactor and adds extra functionality (a scalar factor, a position-dependent p...
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
Vector transformations in three dimensions.
Definition: Transform3D.h:28
Holds all wavevector information relevant for calculating form factors.