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
18
#include "
Sample/SampleBuilderEngine/ISampleBuilder.h
"
19
20
//! Builds sample: cylinders with magnetic material and zero magnetic field.
21
//! @ingroup standard_samples
22
23
class
MagneticParticleZeroFieldBuilder
:
public
ISampleBuilder
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
32
class
MagneticCylindersBuilder
:
public
ISampleBuilder
33
{
34
public
:
35
MultiLayer
* buildSample()
const
;
36
};
37
38
//! Builds sample: spheres with magnetization inside substrate.
39
//! @ingroup standard_samples
40
41
class
MagneticSpheresBuilder
:
public
ISampleBuilder
42
{
43
public
:
44
MultiLayer
* buildSample()
const
;
45
};
46
47
#endif
// BORNAGAIN_CORE_STANDARDSAMPLES_MAGNETICPARTICLESBUILDER_H
ISampleBuilder.h
Defines pure virtual base class ISampleBuilder.
ISampleBuilder
Interface to the class capable to build samples to simulate.
Definition:
ISampleBuilder.h:26
MagneticCylindersBuilder
Builds sample: cylinders with magnetic material and non-zero magnetic field.
Definition:
MagneticParticlesBuilder.h:33
MagneticParticleZeroFieldBuilder
Builds sample: cylinders with magnetic material and zero magnetic field.
Definition:
MagneticParticlesBuilder.h:24
MagneticSpheresBuilder
Builds sample: spheres with magnetization inside substrate.
Definition:
MagneticParticlesBuilder.h:42
MultiLayer
Our sample model: a stack of layers one below the other.
Definition:
MultiLayer.h:42
Sample
StandardSamples
MagneticParticlesBuilder.h
Generated by
1.9.1