BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Prism.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/HardParticle/Prism.h
6 //! @brief Defines class Prism.
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 #ifdef SWIG
16 #error no need to expose this header to Swig
17 #endif
18 
19 #ifndef USER_API
20 #ifndef BORNAGAIN_SAMPLE_HARDPARTICLE_PRISM_H
21 #define BORNAGAIN_SAMPLE_HARDPARTICLE_PRISM_H
22 
25 #include <memory>
26 
27 class Prism {
28 public:
29  Prism() = delete;
30  Prism(const Prism&) = delete;
31  Prism(bool symmetry_Ci, double height, const std::vector<kvector_t>& vertices);
32  double area() const;
33  const std::vector<kvector_t>& vertices(); //! needed for topZ, bottomZ computation
34  complex_t evaluate_for_q(const cvector_t& q) const;
35  // complex_t evaluate_centered(const cvector_t& q) const;
36 private:
37  std::unique_ptr<PolyhedralFace> m_base;
38  double m_height;
39  std::vector<kvector_t> m_vertices; //! for topZ, bottomZ computation only
40 };
41 
42 #endif // BORNAGAIN_SAMPLE_HARDPARTICLE_PRISM_H
43 #endif // USER_API
std::complex< double > complex_t
Definition: Complex.h:20
Defines classes PolyhedralEdge, PolyhedralFace.
Defines classes PolygonalTopology, PolyhedralTopology.
Definition: Prism.h:27
Prism()=delete
complex_t evaluate_for_q(const cvector_t &q) const
needed for topZ, bottomZ computation
Definition: Prism.cpp:55
std::unique_ptr< PolyhedralFace > m_base
Definition: Prism.h:37
double m_height
Definition: Prism.h:38
Prism(const Prism &)=delete
double area() const
Definition: Prism.cpp:45
std::vector< kvector_t > m_vertices
Definition: Prism.h:39
const std::vector< kvector_t > & vertices()
Definition: Prism.cpp:50