BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Ripples.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/HardParticle/Ripples.h
6 //! @brief Declares computations in namespace ripples.
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_RIPPLES_H
21 #define BORNAGAIN_SAMPLE_HARDPARTICLE_RIPPLES_H
22 
23 #include "Base/Types/Complex.h"
24 
25 //! Computations for elongated particles.
26 namespace ripples {
27 
28 complex_t factor_x_box(complex_t q, double l);
31 
32 complex_t profile_yz_bar(complex_t qy, complex_t qz, double width, double height);
33 complex_t profile_yz_cosine(complex_t qy, complex_t qz, double width, double height);
34 complex_t profile_yz_triangular(complex_t qy, complex_t qz, double width, double height,
35  double asymmetry);
36 
37 } // namespace ripples
38 
39 #endif // BORNAGAIN_SAMPLE_HARDPARTICLE_RIPPLES_H
40 #endif // USER_API
Defines complex_t, and a few elementary functions.
std::complex< double > complex_t
Definition: Complex.h:20
Computations for elongated particles.
Definition: Ripples.h:26
complex_t profile_yz_cosine(complex_t qy, complex_t qz, double width, double height)
Complex form factor of cosine ripple.
Definition: Ripples.cpp:45
complex_t profile_yz_bar(complex_t qy, complex_t qz, double width, double height)
Complex form factor of rectangular ripple (bar).
Definition: Ripples.cpp:36
complex_t factor_x_box(complex_t q, double l)
Definition: Ripples.cpp:20
complex_t factor_x_Lorentz(complex_t q, double l)
Definition: Ripples.cpp:30
complex_t profile_yz_triangular(complex_t qy, complex_t qz, double width, double height, double asymmetry)
Complex form factor of triangular ripple.
Definition: Ripples.cpp:72
complex_t factor_x_Gauss(complex_t q, double l)
Definition: Ripples.cpp:25