BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Lattice2DPositionBuilder Class Reference

Description

Definition at line 78 of file IPositionBuilder.h.

Inheritance diagram for Lattice2DPositionBuilder:
[legend]
Collaboration diagram for Lattice2DPositionBuilder:
[legend]

Public Member Functions

 Lattice2DPositionBuilder (const Interference2DLattice *p_iff)
 
 ~Lattice2DPositionBuilder () override
 
std::vector< std::vector< double > > generatePositions (double layer_size, double density=0.0) const
 

Private Member Functions

std::vector< std::vector< double > > generatePositionsImpl (double layer_size, double density=0.0) const override
 
double positionVariance () const override
 

Private Attributes

std::unique_ptr< Interference2DLattice > m_iff
 

Constructor & Destructor Documentation

◆ Lattice2DPositionBuilder()

Lattice2DPositionBuilder::Lattice2DPositionBuilder ( const Interference2DLattice *  p_iff)

Definition at line 123 of file IPositionBuilder.cpp.

124  : m_iff(p_iff->clone())
125 {
126 }
Lattice2DPositionBuilder::m_iff
std::unique_ptr< Interference2DLattice > m_iff
Definition: IPositionBuilder.h:87

◆ ~Lattice2DPositionBuilder()

Lattice2DPositionBuilder::~Lattice2DPositionBuilder ( )
overridedefault

Member Function Documentation

◆ generatePositions()

std::vector< std::vector< double > > IPositionBuilder::generatePositions ( double  layer_size,
double  density = 0.0 
) const
inherited

Definition at line 29 of file IPositionBuilder.cpp.

31 {
32  std::vector<std::vector<double>> positions = generatePositionsImpl(layer_size, density);
33  double pos_var = positionVariance();
34  if (pos_var > 0.0) {
35  // random generator and distribution
36  std::random_device rd; // Will be used to obtain a seed for the random number engine
37  std::mt19937 gen(rd()); // Standard mersenne_twister_engine seeded with rd()
38  std::normal_distribution<double> dis(0.0, std::sqrt(pos_var));
39  for (auto& position : positions) {
40  for (auto& coordinate : position)
41  coordinate += dis(gen);
42  }
43  }
44  return positions;
45 }
IPositionBuilder::generatePositionsImpl
virtual std::vector< std::vector< double > > generatePositionsImpl(double layer_size, double density=0.0) const =0
IPositionBuilder::positionVariance
virtual double positionVariance() const =0

References IPositionBuilder::generatePositionsImpl(), and IPositionBuilder::positionVariance().

Here is the call graph for this function:

◆ generatePositionsImpl()

std::vector< std::vector< double > > Lattice2DPositionBuilder::generatePositionsImpl ( double  layer_size,
double  density = 0.0 
) const
overrideprivatevirtual

Implements IPositionBuilder.

Definition at line 130 of file IPositionBuilder.cpp.

132 {
133  const auto& lattice = m_iff->lattice();
134  double l1 = lattice.length1();
135  double l2 = lattice.length2();
136  double alpha = lattice.latticeAngle();
137  double xi = lattice.rotationAngle();
138 
139  // Estimate the limits n1 and n2 of the maximum integer multiples of the lattice vectors
140  // required for populating particles correctly within the 3D model's boundaries
141  unsigned n1, n2;
142  double sina = std::abs(std::sin(alpha));
143  if (sina <= 1e-4) {
144  n1 = l1 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l1);
145  n2 = l2 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l2);
146  } else {
147  n1 = l1 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l1 / sina);
148  n2 = l2 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l2 / sina);
149  }
150  return Generate2DLatticePoints(l1, l2, alpha, xi, n1, n2);
151 }

References m_iff.

◆ positionVariance()

double Lattice2DPositionBuilder::positionVariance ( ) const
overrideprivatevirtual

Implements IPositionBuilder.

Definition at line 153 of file IPositionBuilder.cpp.

154 {
155  return m_iff->positionVariance();
156 }

References m_iff.

Member Data Documentation

◆ m_iff

std::unique_ptr<Interference2DLattice> Lattice2DPositionBuilder::m_iff
private

Definition at line 87 of file IPositionBuilder.h.

Referenced by generatePositionsImpl(), and positionVariance().

The documentation for this class was generated from the following files: