BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
MagneticParticlesBuilder.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/StandardSamples/MagneticParticlesBuilder.h
6 //! @brief Defines class to build magnetic samples
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 #ifndef BORNAGAIN_CORE_STANDARDSAMPLES_MAGNETICPARTICLESBUILDER_H
16 #define BORNAGAIN_CORE_STANDARDSAMPLES_MAGNETICPARTICLESBUILDER_H
17 
19 
20 //! Builds sample: cylinders with magnetic material and zero magnetic field.
21 //! @ingroup standard_samples
22 
24 {
25 public:
26  MultiLayer* buildSample() const;
27 };
28 
29 //! Builds sample: cylinders with magnetic material and non-zero magnetic field.
30 //! @ingroup standard_samples
31 
33 {
34 public:
35  MultiLayer* buildSample() const;
36 };
37 
38 //! Builds sample: spheres with magnetization inside substrate.
39 //! @ingroup standard_samples
40 
42 {
43 public:
44  MultiLayer* buildSample() const;
45 };
46 
47 #endif // BORNAGAIN_CORE_STANDARDSAMPLES_MAGNETICPARTICLESBUILDER_H
Defines pure virtual base class ISampleBuilder.
Interface to the class capable to build samples to simulate.
Builds sample: cylinders with magnetic material and non-zero magnetic field.
Builds sample: cylinders with magnetic material and zero magnetic field.
Builds sample: spheres with magnetization inside substrate.
MultiLayer * buildSample() const
Our sample model: a stack of layers one below the other.
Definition: MultiLayer.h:42