File: KzComputation.h

package info (click to toggle)
bornagain 23.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,948 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (51 lines) | stat: -rw-r--r-- 1,989 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Slice/KzComputation.h
//! @brief     Declares functions in namespace ComputateKz.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#ifdef SWIG
#error no need to expose this header to Swig
#endif // SWIG
#ifndef BORNAGAIN_RESAMPLE_SLICE_KZCOMPUTATION_H
#define BORNAGAIN_RESAMPLE_SLICE_KZCOMPUTATION_H

#include <heinz/Complex.h>
#include <heinz/Vectors3D.h>
#include <vector>

class SliceStack;

namespace Compute::Kz {

//! Computes kz values from known k vector and slices with the following assumptions:
//! - the beam penetrates fronting medium from a side
//! - the wavelength is known for a distant point in vacuum (ref. index = 1)
//! - the incident angle is known for the sample surface
//!
//! This function is used in GISAS and off-spec computations mainly for back-compatibility
//! reasons and should be replaced with computeKzFromRefIndices.

std::vector<complex_t> computeReducedKz(const SliceStack& slices, R3 k);

//! Computes kz values from kz of the incoming beam known at a distant point in vacuum.
//! It is assumed, that the beam penetrates fronting medium from a side.

std::vector<complex_t> computeKzFromSLDs(const SliceStack& slices, double kz);

//! Computes kz values from k-vector of the incoming beam known at a distant point in vacuum.
//! It is assumed, that the beam penetrates fronting medium from a side.

std::vector<complex_t> computeKzFromRefIndices(const SliceStack& slices, R3 k);

} // namespace Compute::Kz

#endif // BORNAGAIN_RESAMPLE_SLICE_KZCOMPUTATION_H