File: MagneticLayersBuilder.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 (66 lines) | stat: -rw-r--r-- 1,971 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/StandardSample/MagneticLayersBuilder.h
//! @brief    Defines class to build samples with magnetic layers.
//!
//! @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_SAMPLE_STANDARDSAMPLE_MAGNETICLAYERSBUILDER_H
#define BORNAGAIN_SAMPLE_STANDARDSAMPLE_MAGNETICLAYERSBUILDER_H

class Sample;

#include "Sample/Interface/TransientModels.h"
#include <string>

//! Builds sample: spheres in substrate layer with a zero magnetic field.

namespace ExemplarySamples {

Sample* createMagneticSubstrateZeroField();

} // namespace ExemplarySamples

//! Builds sample: ambient and one magnetized layer on a non-magnetized substrate.

namespace ExemplarySamples {

Sample* createSimpleMagneticLayer();

} // namespace ExemplarySamples

//! Builds sample: magnetic spheres in a magnetized layer on a non-magnetized substrate.

namespace ExemplarySamples {

Sample* createMagneticLayer();

} // namespace ExemplarySamples

//! Builds sample: magnetic layer on a magnetic substrate with the fields rotated by 90°

namespace ExemplarySamples {

Sample* createSimpleMagneticRotationWithRoughness(const std::string& roughnessKey);

} // namespace ExemplarySamples

//! Builds sample: rotated magnetic spheres in substrate layer with a unit magnetic field.

namespace ExemplarySamples {

Sample* createMagneticRotation();

} // namespace ExemplarySamples

#endif // BORNAGAIN_SAMPLE_STANDARDSAMPLE_MAGNETICLAYERSBUILDER_H