BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
RipplesBuilder.cpp
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Sample/StandardSamples/RipplesBuilder.cpp
6 //! @brief Implement classes to build various ripples.
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 
27 {
28  Layer vacuum_layer(refMat::Vacuum);
29  FormFactorCosineRippleBox ff_ripple1(100.0, 20.0, 4.0);
30  Particle ripple(refMat::Particle, ff_ripple1);
31 
32  ParticleLayout particle_layout;
33  particle_layout.addParticle(ripple, 1.0);
34  InterferenceFunctionRadialParaCrystal interference_function(20.0, 1e7);
35  FTDistribution1DGauss pdf(4.0);
36  interference_function.setProbabilityDistribution(pdf);
37  particle_layout.setInterferenceFunction(interference_function);
38 
39  vacuum_layer.addLayout(particle_layout);
40 
41  Layer substrate_layer(refMat::Substrate);
42 
43  MultiLayer* multi_layer = new MultiLayer();
44  multi_layer->addLayer(vacuum_layer);
45  multi_layer->addLayer(substrate_layer);
46  return multi_layer;
47 }
48 
49 // ----------------------------------------------------------------------------
50 
52 {
53  registerParameter("asymmetry", &m_d);
54 }
55 
57 {
58  Layer vacuum_layer(refMat::Vacuum);
59  FormFactorSawtoothRippleBox ff_ripple2(100.0, 20.0, 4.0, m_d);
60  Particle ripple(refMat::Particle, ff_ripple2);
61 
62  ParticleLayout particle_layout;
63  particle_layout.addParticle(ripple, 1.0);
64  InterferenceFunctionRadialParaCrystal interference_function(20.0, 1e7);
65  FTDistribution1DGauss pdf(4.0);
66  interference_function.setProbabilityDistribution(pdf);
67  particle_layout.setInterferenceFunction(interference_function);
68 
69  vacuum_layer.addLayout(particle_layout);
70  Layer substrate_layer(refMat::Substrate);
71 
72  MultiLayer* multi_layer = new MultiLayer();
73  multi_layer->addLayer(vacuum_layer);
74  multi_layer->addLayer(substrate_layer);
75  return multi_layer;
76 }
77 
78 // ----------------------------------------------------------------------------
79 
81 {
83  builder.setParameterValue("asymmetry", -3.0);
84  return builder.buildSample();
85 }
Defines classes FormFactorCosineRipple*.
Defines classes FormFactorSawtoothRipple*.
Defines class InterferenceFunctionRadialParaCrystal.
Defines class Layer.
Defines class MultiLayer.
Defines class ParticleLayout.
Defines class Particle.
Defines materials in namespace refMat.
Defines classes to build various ripples.
Defines some unit conversion factors and other constants in namespace Units.
MultiLayer * buildSample() const
MultiLayer * buildSample() const
Gaussian IFTDistribution1D; its Fourier transform evaluate(q) is a Gaussian starting at evaluate(0)=1...
The form factor for a cosine ripple, with box profile in elongation direction.
The form factor for a cosine ripple, with box profile in elongation direction.
void setParameterValue(const std::string &name, double value)
RealParameter & registerParameter(const std::string &name, double *parpointer)
Interference function of radial paracrystal.
void setProbabilityDistribution(const IFTDistribution1D &pdf)
Sets one-dimensional probability distribution.
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
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
Builds sample: triangular ripple within the 1D-paracrystal model (from PRB 85, 235415,...
MultiLayer * buildSample() const
Constants and functions for physical unit conversions.
Definition: Units.h:30
static constexpr double nm
Definition: Units.h:39
static const Material Vacuum
static const Material Particle
static const Material Substrate