BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
SpecularScalarTanhStrategy.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/Specular/SpecularScalarTanhStrategy.h
6 //! @brief Defines class SpecularScalarTanhStrategy.
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_SPECULAR_SPECULARSCALARTANHSTRATEGY_H
21 #define BORNAGAIN_SAMPLE_SPECULAR_SPECULARSCALARTANHSTRATEGY_H
22 
24 
25 class Slice;
26 
27 //! Implements an tanh transition function to model roughness in a scaler computation.
28 //!
29 //! Implements the transition function that includes the analytical roughness model
30 //! of an tanh interface transition in the computation of the coefficients for
31 //! coherent wave propagation in a multilayer by applying modified Fresnel coefficients.
32 //!
33 //! @ingroup algorithms_internal
35 private:
36  //! Roughness is modelled by tanh profile [see e.g. Phys. Rev. B, vol. 47 (8), p. 4385 (1993)].
37  virtual std::pair<complex_t, complex_t> transition(complex_t kzi, complex_t kzi1,
38  double sigma) const override;
39 };
40 
41 #endif // BORNAGAIN_SAMPLE_SPECULAR_SPECULARSCALARTANHSTRATEGY_H
42 #endif // USER_API
std::complex< double > complex_t
Definition: Complex.h:20
Defines class SpecularScalarStrategy.
Data structure containing the data of a single slice, for calculating the Fresnel coefficients.
Definition: Slice.h:32
Implements the scalar Fresnel computation.
Implements an tanh transition function to model roughness in a scaler computation.
virtual std::pair< complex_t, complex_t > transition(complex_t kzi, complex_t kzi1, double sigma) const override
Roughness is modelled by tanh profile [see e.g. Phys. Rev. B, vol. 47 (8), p. 4385 (1993)].