Lattice2DPositionBuilder Class Reference

Inheritance diagram for Lattice2DPositionBuilder:

Collaboration diagram for Lattice2DPositionBuilder:

Public Member Functions
	Lattice2DPositionBuilder (const InterferenceFunction2DLattice *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< InterferenceFunction2DLattice >	m_iff

Detailed Description

Definition at line 78 of file IPositionBuilder.h.

Constructor & Destructor Documentation

Lattice2DPositionBuilder()

Lattice2DPositionBuilder::Lattice2DPositionBuilder

(

const InterferenceFunction2DLattice *

p_iff

)

Definition at line 122 of file IPositionBuilder.cpp.

    : m_iff(p_iff->clone())
{
}

~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 28 of file IPositionBuilder.cpp.

{
    std::vector<std::vector<double>> positions = generatePositionsImpl(layer_size, density);
    double pos_var = positionVariance();
    if (pos_var > 0.0) {
        // random generator and distribution
        std::random_device rd;  // Will be used to obtain a seed for the random number engine
        std::mt19937 gen(rd()); // Standard mersenne_twister_engine seeded with rd()
        std::normal_distribution<double> dis(0.0, std::sqrt(pos_var));
        for (auto& position : positions) {
            for (auto& coordinate : position)
                coordinate += dis(gen);
        }
    }
    return positions;
}

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 129 of file IPositionBuilder.cpp.

{
    auto& lattice = m_iff->lattice();
    double l1 = lattice.length1();
    double l2 = lattice.length2();
    double alpha = lattice.latticeAngle();
    double xi = lattice.rotationAngle();
 
    // Estimate the limits n1 and n2 of the maximum integer multiples of the lattice vectors
    // required for populating particles correctly within the 3D model's boundaries
    unsigned n1, n2;
    double sina = std::abs(std::sin(alpha));
    if (sina <= 1e-4) {
        n1 = l1 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l1);
        n2 = l2 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l2);
    } else {
        n1 = l1 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l1 / sina);
        n2 = l2 == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / l2 / sina);
    }
    return Generate2DLatticePoints(l1, l2, alpha, xi, n1, n2);
}

References m_iff.

positionVariance()

double Lattice2DPositionBuilder::positionVariance ( ) const

overrideprivatevirtual

Implements IPositionBuilder.

Definition at line 152 of file IPositionBuilder.cpp.

{
    return m_iff->positionVariance();
}

References m_iff.

Member Data Documentation

m_iff

std::unique_ptr<InterferenceFunction2DLattice> 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:

• /home/www/ba/GUI/coregui/Views/RealSpaceWidgets/IPositionBuilder.h
• /home/www/ba/GUI/coregui/Views/RealSpaceWidgets/IPositionBuilder.cpp