BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
MagneticParticlesBuilder.cpp
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Sample/StandardSamples/MagneticParticlesBuilder.cpp
6 //! @brief Implements classes 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 #include "Sample/StandardSamples/MagneticParticlesBuilder.h"
16 #include "Base/Const/Units.h"
17 #include "Sample/Aggregate/ParticleLayout.h"
18 #include "Sample/HardParticle/FormFactorCylinder.h"
19 #include "Sample/HardParticle/FormFactorFullSphere.h"
20 #include "Sample/Material/MaterialFactoryFuncs.h"
21 #include "Sample/Multilayer/Layer.h"
22 #include "Sample/Multilayer/MultiLayer.h"
23 #include "Sample/Particle/Particle.h"
24 #include "Sample/Slice/LayerInterface.h"
25 #include "Sample/Slice/LayerRoughness.h"
26 
27 // ----------------------------------------------------------------------------
28 // Magnetic cylinders and zero magnetic field
29 // ----------------------------------------------------------------------------
30 
31 MultiLayer* MagneticParticleZeroFieldBuilder::buildSample() const
32 {
33  const double m_cylinder_radius(5 * Units::nanometer);
34  const double m_cylinder_height(5 * Units::nanometer);
35 
36  Material vacuum_material = HomogeneousMaterial("Vacuum", 0.0, 0.0);
37  Material substrate_material = HomogeneousMaterial("Substrate", 6e-6, 2e-8);
38  kvector_t magnetic_field(0.0, 0.0, 0.0);
39  Material particle_material = HomogeneousMaterial("MagParticle", 6e-4, 2e-8, magnetic_field);
40 
41  Layer vacuum_layer(vacuum_material);
42  Layer substrate_layer(substrate_material);
43 
44  FormFactorCylinder ff_cylinder(m_cylinder_radius, m_cylinder_height);
45 
46  Particle particle(particle_material, ff_cylinder);
47  ParticleLayout particle_layout(particle);
48 
49  vacuum_layer.addLayout(particle_layout);
50 
51  MultiLayer* multi_layer = new MultiLayer();
52  multi_layer->addLayer(vacuum_layer);
53  multi_layer->addLayer(substrate_layer);
54  return multi_layer;
55 }
56 
57 // ----------------------------------------------------------------------------
58 // Magnetic cylinders and non-zero magnetization
59 // ----------------------------------------------------------------------------
60 
61 MultiLayer* MagneticCylindersBuilder::buildSample() const
62 {
63  const double m_cylinder_radius(5 * Units::nanometer);
64  const double m_cylinder_height(5 * Units::nanometer);
65 
66  Material vacuum_material = HomogeneousMaterial("Vacuum", 0.0, 0.0);
67  Material substrate_material = HomogeneousMaterial("Substrate", 15e-6, 0.0);
68  kvector_t magnetization(0.0, 1e6, 0.0);
69  Material particle_material = HomogeneousMaterial("MagParticle2", 5e-6, 0.0, magnetization);
70 
71  Layer vacuum_layer(vacuum_material);
72  Layer substrate_layer(substrate_material);
73 
74  FormFactorCylinder ff_cylinder(m_cylinder_radius, m_cylinder_height);
75 
76  Particle particle(particle_material, ff_cylinder);
77  ParticleLayout particle_layout(particle);
78 
79  vacuum_layer.addLayout(particle_layout);
80 
81  MultiLayer* multi_layer = new MultiLayer();
82  multi_layer->addLayer(vacuum_layer);
83  multi_layer->addLayer(substrate_layer);
84  return multi_layer;
85 }
86 
87 // ----------------------------------------------------------------------------
88 // Magnetic spheres inside substrate
89 // ----------------------------------------------------------------------------
90 
91 MultiLayer* MagneticSpheresBuilder::buildSample() const
92 {
93  const double m_sphere_radius(5 * Units::nanometer);
94 
95  kvector_t magnetization(0.0, 0.0, 1e7);
96  Material particle_material = HomogeneousMaterial("Particle", 2e-5, 4e-7, magnetization);
97  Material vacuum_material = HomogeneousMaterial("Vacuum", 0.0, 0.0);
98  Material substrate_material = HomogeneousMaterial("Substrate", 7e-6, 1.8e-7);
99 
100  FormFactorFullSphere ff_sphere(m_sphere_radius);
101  Particle particle(particle_material, ff_sphere);
102  kvector_t position(0.0, 0.0, -2.0 * m_sphere_radius);
103 
104  ParticleLayout particle_layout;
105  particle_layout.addParticle(particle, 1.0, position);
106 
107  Layer vacuum_layer(vacuum_material);
108  Layer substrate_layer(substrate_material);
109  substrate_layer.addLayout(particle_layout);
110 
111  MultiLayer* multi_layer = new MultiLayer();
112  multi_layer->addLayer(vacuum_layer);
113  multi_layer->addLayer(substrate_layer);
114  return multi_layer;
115 }
FormFactorCylinder.h
Defines class FormFactorCylinder.
FormFactorFullSphere.h
Defines class FormFactorFullSphere.
LayerInterface.h
Defines class LayerInterface.
LayerRoughness.h
Defines class LayerRoughness.
Layer.h
Defines class Layer.
MagneticParticlesBuilder.h
Defines class to build magnetic samples.
MaterialFactoryFuncs.h
Factory functions used to create material instances.
MultiLayer.h
Defines class MultiLayer.
ParticleLayout.h
Defines class ParticleLayout.
Particle.h
Defines class Particle.
Units.h
Defines some unit conversion factors and other constants in namespace Units.
FormFactorCylinder
A circular cylinder.
Definition: FormFactorCylinder.h:24
Layer
A layer, with thickness (in nanometer) and material.
Definition: Layer.h:28
Material
A wrapper for underlying material implementation.
Definition: Material.h:29
MultiLayer
Our sample model: a stack of layers one below the other.
Definition: MultiLayer.h:42
MultiLayer::addLayer
void addLayer(const Layer &layer)
Adds object to multilayer.
Definition: MultiLayer.cpp:54
ParticleLayout
Decorator class that adds particles to ISample objects.
Definition: ParticleLayout.h:30
ParticleLayout::addParticle
void addParticle(const IAbstractParticle &particle, double abundance=-1.0, const kvector_t position={}, const IRotation &rotation=IdentityRotation())
Adds particle to the layout with abundance, position and the rotation defined.
Definition: ParticleLayout.cpp:76
Particle
A particle with a form factor and refractive index.
Definition: Particle.h:26
HomogeneousMaterial
Material HomogeneousMaterial(const std::string &name, complex_t refractive_index, kvector_t magnetization)
Constructs a material with name, refractive_index and magnetization (in A/m).
Definition: MaterialFactoryFuncs.cpp:21