File: MultiLayerFuncs.h

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 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 (42 lines) | stat: -rw-r--r-- 1,600 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
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Resample/Swig/MultiLayerFuncs.h
//! @brief     Global functions related to MultiLayers.
//!
//! @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)
//
//  ************************************************************************************************

#ifndef BORNAGAIN_RESAMPLE_SWIG_MULTILAYERFUNCS_H
#define BORNAGAIN_RESAMPLE_SWIG_MULTILAYERFUNCS_H

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

class Sample;

//! Functions that are only used in the swig *.i files
namespace swigAPI {

std::vector<double> generateZValues(int n_points, double z_min, double z_max);

//! Calculate average material profile for given sample
std::vector<complex_t> materialProfileSLD(const Sample& sample, int n_points, double z_min,
                                          double z_max);

//! Calculate average magnetization profile for given sample
std::vector<double> magnetizationProfile(const Sample& sample, std::string xyz, int n_points,
                                         double z_min, double z_max);

//! Get default z limits for generating a material profile
std::pair<double, double> defaultMaterialProfileLimits(const Sample& sample);

} // namespace swigAPI

#endif // BORNAGAIN_RESAMPLE_SWIG_MULTILAYERFUNCS_H