BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ParticleCompositionBuilder.cpp
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/StandardSamples/ParticleCompositionBuilder.cpp
6 //! @brief Implements class ParticleCompositionBuilder.
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 
16 #include "Base/Const/Units.h"
25 
26 // --- ParticleCompositionBuilder ---
27 
29 {
30  Layer vacuum_layer(refMat::Vacuum);
31  Layer substrate_layer(refMat::Substrate);
32 
33  double radius(10.0 * Units::nm);
34  FormFactorFullSphere sphere_ff(radius);
35  Particle sphere(refMat::Particle, sphere_ff);
36  ParticleLayout particle_layout;
37 
38  std::vector<kvector_t> positions = {
39  {}, {radius, radius / std::sqrt(3.0), std::sqrt(8.0 / 3.0) * radius}};
40 
41  ParticleComposition basis;
42 
43  basis.addParticles(sphere, positions);
44  particle_layout.addParticle(basis);
45 
47  FTDecayFunction2DCauchy pdf(10 * Units::nm, 10 * Units::nm, 0);
48  iff.setDecayFunction(pdf);
49 
50  particle_layout.setInterferenceFunction(iff);
51 
52  vacuum_layer.addLayout(particle_layout);
53 
54  MultiLayer* multi_layer = new MultiLayer();
55  multi_layer->addLayer(vacuum_layer);
56  multi_layer->addLayer(substrate_layer);
57  return multi_layer;
58 }
Defines class FormFactorFullSphere.
Defines class InterferenceFunction2DLattice.
Defines class Layer.
Defines class MultiLayer.
Defines class ParticleCompositionBuilder.
Defines class ParticleComposition.
Defines class ParticleLayout.
Defines class Particle.
Defines materials in namespace refMat.
Defines some unit conversion factors and other constants in namespace Units.
Two-dimensional Cauchy decay function in reciprocal space; corresponds to exp(-r) in real space,...
Definition: FTDecay2D.h:65
A two-dimensional Bravais lattice with hexagonal symmetry.
Definition: Lattice2D.h:92
Interference function of a 2D lattice.
void setDecayFunction(const IFTDecayFunction2D &decay)
Sets two-dimensional decay function.
A layer in a MultiLayer sample.
Definition: Layer.h:27
void addLayout(const ParticleLayout &decoration)
Definition: Layer.cpp:58
Our sample model: a stack of layers one below the other.
Definition: MultiLayer.h:41
void addLayer(const Layer &layer)
Adds layer with default (zero) roughness.
Definition: MultiLayer.cpp:53
A composition of particles at fixed positions.
void addParticles(const IParticle &particle, std::vector< kvector_t > positions)
Decorator class that adds particles to ISampleNode objects.
void setInterferenceFunction(const IInterferenceFunction &interference_function)
Adds interference functions.
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.
A particle with a form factor and refractive index.
Definition: Particle.h:24
static constexpr double nm
Definition: Units.h:39
static const Material Vacuum
static const Material Particle
static const Material Substrate