Lattice1DPositionBuilder Class Reference

Inheritance diagram for Lattice1DPositionBuilder:

Collaboration diagram for Lattice1DPositionBuilder:

Public Member Functions
	Lattice1DPositionBuilder (const InterferenceFunction1DLattice *p_iff)
	~Lattice1DPositionBuilder () 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< InterferenceFunction1DLattice >	m_iff

Detailed Description

Definition at line 66 of file IPositionBuilder.h.

Constructor & Destructor Documentation

Lattice1DPositionBuilder()

Lattice1DPositionBuilder::Lattice1DPositionBuilder

(

const InterferenceFunction1DLattice *

p_iff

)

Definition at line 96 of file IPositionBuilder.cpp.

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

~Lattice1DPositionBuilder()

Lattice1DPositionBuilder::~Lattice1DPositionBuilder ( )

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 > > Lattice1DPositionBuilder::generatePositionsImpl ( double  layer_size, double  density = 0.0  ) const

overrideprivatevirtual

Implements IPositionBuilder.

Definition at line 103 of file IPositionBuilder.cpp.

{
    const double length = m_iff->getLength();
    const double xi = m_iff->getXi();
 
    // Take the maximum possible integer multiple of the lattice vector required
    // for populating particles correctly within the 3D model's boundaries
    unsigned n1 =
        length == 0.0 ? 2 : static_cast<unsigned>(2.0 * layer_size * std::sqrt(2.0) / length);
 
    return Generate2DLatticePoints(length, 0.0, 0.0, xi, n1, 1u);
}

References m_iff.

positionVariance()

double Lattice1DPositionBuilder::positionVariance ( ) const

overrideprivatevirtual

Implements IPositionBuilder.

Definition at line 117 of file IPositionBuilder.cpp.

{
    return m_iff->positionVariance();
}

References m_iff.

Member Data Documentation

m_iff

std::unique_ptr<InterferenceFunction1DLattice> Lattice1DPositionBuilder::m_iff

private

Definition at line 75 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