BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Lattice2D.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/Lattice/Lattice2D.h
6 //! @brief Defines classes of Lattice2D family.
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_LATTICE_LATTICE2D_H
16 #define BORNAGAIN_CORE_LATTICE_LATTICE2D_H
17 
18 #include "Base/Types/ICloneable.h"
19 #include "Param/Node/INode.h"
20 
21 class Lattice2D : public ICloneable, public INode
22 {
23 public:
24  Lattice2D(const NodeMeta& meta, const std::vector<double>& PValues);
25  explicit Lattice2D(double xi);
26 
27  virtual Lattice2D* clone() const = 0;
28 
29  struct ReciprocalBases {
30  double m_asx, m_asy; //!< x,y coordinates of a*
31  double m_bsx, m_bsy; //!< x,y coordinates of b*
32  };
33 
34  virtual double length1() const = 0;
35  virtual double length2() const = 0;
36  virtual double latticeAngle() const = 0;
37  virtual double unitCellArea() const = 0;
38 
39  double rotationAngle() const { return m_xi; }
40 
41  ReciprocalBases reciprocalBases() const;
42 
43  void setRotationEnabled(bool enabled);
44 
45 protected:
46  virtual void onChange();
47  double m_xi;
48 };
49 
50 class BasicLattice : public Lattice2D
51 {
52 public:
53  BasicLattice(double length1, double length2, double angle, double xi);
54 
55  BasicLattice* clone() const;
56 
57  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
58 
59  virtual double length1() const { return m_length1; }
60  virtual double length2() const { return m_length2; }
61  virtual double latticeAngle() const { return m_angle; }
62  virtual double unitCellArea() const;
63 
64 private:
65  double m_length1, m_length2;
66  double m_angle;
67 };
68 
69 class SquareLattice : public Lattice2D
70 {
71 public:
72  SquareLattice(double length, double xi = 0.0);
73 
74  SquareLattice* clone() const;
75 
76  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
77 
78  virtual double length1() const { return m_length; }
79  virtual double length2() const { return m_length; }
80  virtual double latticeAngle() const;
81  virtual double unitCellArea() const;
82 
83 private:
84  double m_length;
85 };
86 
87 class HexagonalLattice : public Lattice2D
88 {
89 public:
90  HexagonalLattice(double length, double xi);
91 
92  HexagonalLattice* clone() const;
93 
94  void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
95 
96  virtual double length1() const { return m_length; }
97  virtual double length2() const { return m_length; }
98  virtual double latticeAngle() const;
99  virtual double unitCellArea() const;
100 
101 private:
102  double m_length;
103 };
104 
105 #endif // BORNAGAIN_CORE_LATTICE_LATTICE2D_H
ICloneable.h
Defines and implements the standard mix-in ICloneable.
INode.h
Defines class INode.
BasicLattice::accept
void accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
Definition: Lattice2D.h:57
HexagonalLattice::accept
void accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
Definition: Lattice2D.h:94
ICloneable
Interface for polymorphic classes that should not be copied, except by explicit cloning.
Definition: ICloneable.h:25
INodeVisitor
Visitor interface to visit ISample objects.
Definition: INodeVisitor.h:149
INode
Base class for tree-like structures containing parameterized objects.
Definition: INode.h:49
Lattice2D::onChange
virtual void onChange()
Action to be taken in inherited class when a parameter has changed.
Definition: Lattice2D.cpp:47
SquareLattice::accept
void accept(INodeVisitor *visitor) const final
Calls the INodeVisitor's visit method.
Definition: Lattice2D.h:76
Lattice2D::ReciprocalBases::m_asy
double m_asy
x,y coordinates of a*
Definition: Lattice2D.h:30
Lattice2D::ReciprocalBases::m_bsy
double m_bsy
x,y coordinates of b*
Definition: Lattice2D.h:31
NodeMeta
Metadata of one model node.
Definition: INode.h:37