BasicLattice2D Class Reference

Description

A two-dimensional Bravais lattice with no special symmetry.

Definition at line 51 of file Lattice2D.h.

Inheritance diagram for BasicLattice2D:

Collaboration diagram for BasicLattice2D:

Public Member Functions
	BasicLattice2D (double length1, double length2, double angle, double xi)
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
BasicLattice2D *	clone () const override
double	latticeAngle () const override
double	length1 () const override
double	length2 () const override
virtual std::vector< const INode * >	nodeChildren () const
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
std::vector< ParaMeta >	parDefs () const final
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
ReciprocalBases	reciprocalBases () const
double	rotationAngle () const
void	setRotationEnabled (bool enabled)
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
double	unitCellArea () const override

Protected Attributes
std::vector< double >	m_P
double	m_xi

Private Attributes
double	m_angle
double	m_length1
double	m_length2

Constructor & Destructor Documentation

BasicLattice2D()

BasicLattice2D::BasicLattice2D	(	double	length1,
		double	length2,
		double	angle,
		double	xi
	)

Definition at line 56 of file Lattice2D.cpp.

    : Lattice2D(xi)
    , m_length1(length1)
    , m_length2(length2)
    , m_angle(angle)
{
    if (m_length1 <= 0.0 || m_length2 <= 0.0)
        throw std::runtime_error(
            "BasicLattice2D::BasicLattice2D() -> Error. Lattice length can't be "
            "negative or zero.");
    RealLimits::positive().check("LatticeLength1", m_length1);
    RealLimits::positive().check("LatticeLength2", m_length2);
}

References RealLimits::check(), m_length1, m_length2, and RealLimits::positive().

Referenced by clone().

Here is the call graph for this function:

Member Function Documentation

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string BasicLattice2D::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 56 of file Lattice2D.h.

{ return "BasicLattice2D"; }

clone()

BasicLattice2D * BasicLattice2D::clone ( ) const

overridevirtual

Implements Lattice2D.

Definition at line 70 of file Lattice2D.cpp.

{
    return new BasicLattice2D(m_length1, m_length2, m_angle, m_xi);
}

References BasicLattice2D(), m_angle, m_length1, m_length2, and Lattice2D::m_xi.

Here is the call graph for this function:

latticeAngle()

double BasicLattice2D::latticeAngle ( ) const

inlineoverridevirtual

Implements Lattice2D.

Definition at line 66 of file Lattice2D.h.

{ return m_angle; }

References m_angle.

length1()

double BasicLattice2D::length1 ( ) const

inlineoverridevirtual

Implements Lattice2D.

Definition at line 64 of file Lattice2D.h.

{ return m_length1; }

References m_length1.

length2()

double BasicLattice2D::length2 ( ) const

inlineoverridevirtual

Implements Lattice2D.

Definition at line 65 of file Lattice2D.h.

{ return m_length2; }

References m_length2.

nodeChildren()

std::vector< const INode * > INode::nodeChildren ( ) const

virtualinherited

Returns all children.

Reimplemented in ISimulation2D, ISimulation, ParticleCoreShell, ParticleComposition, Particle, MesoCrystal, IParticle, Crystal, MultiLayer, Layer, LayerInterface, ParticleLayout, InterferenceRadialParaCrystal, InterferenceFinite3DLattice, InterferenceFinite2DLattice, Interference3DLattice, Interference2DSuperLattice, Interference2DParaCrystal, Interference2DLattice, Interference1DLattice, ConvolutionDetectorResolution, IDetector, and Beam.

Definition at line 56 of file INode.cpp.

{
    return {};
}

Referenced by NodeUtils::AllDescendantsOfType(), NodeUtils::ChildNodesOfType(), ISampleNode::containedMaterials(), and INode::nodeOffspring().

nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : nodeChildren()) {
        for (const auto* p : child->nodeOffspring())
            result.push_back(p);
    }
    return result;
}

References INode::nodeChildren().

Here is the call graph for this function:

parDefs()

std::vector<ParaMeta> BasicLattice2D::parDefs ( ) const

inlinefinalvirtual

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented from INode.

Definition at line 57 of file Lattice2D.h.

    {
        return {{"Length1", "nm", "lattice constant 1", 0, +INF, 0},
                {"Length2", "nm", "lattice constant 2", 0, +INF, 0},
                {"Alpha", "rad", "angle between lattice vectors 1 and 2", -INF, +INF, 0}};
    }

References INF.

reciprocalBases()

Lattice2D::ReciprocalBases Lattice2D::reciprocalBases ( ) const

inherited

Definition at line 34 of file Lattice2D.cpp.

{
    const double sinalpha = std::sin(latticeAngle());
    const double ainv = M_TWOPI / length1() / sinalpha;
    const double binv = M_TWOPI / length2() / sinalpha;
    const double xi = rotationAngle();
    const double xialpha = xi + latticeAngle();
 
    return {+ainv * std::sin(xialpha), -ainv * std::cos(xialpha), -binv * std::sin(xi),
            +binv * std::cos(xi)};
}

References Lattice2D::latticeAngle(), Lattice2D::length1(), Lattice2D::length2(), M_TWOPI, and Lattice2D::rotationAngle().

Referenced by Interference2DLattice::Interference2DLattice().

Here is the call graph for this function:

rotationAngle()

double Lattice2D::rotationAngle ( ) const

inlineinherited

Definition at line 39 of file Lattice2D.h.

{ return m_xi; }

References Lattice2D::m_xi.

Referenced by Lattice2D::reciprocalBases().

setRotationEnabled()

void Lattice2D::setRotationEnabled ( bool  enabled )

inherited

Definition at line 46 of file Lattice2D.cpp.

{
    // #bapool enabling/disabling was done by register/unregister m_xi. Any equivalent
    // implementation necessary?
}

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

unitCellArea()

double BasicLattice2D::unitCellArea ( ) const

overridevirtual

Implements Lattice2D.

Definition at line 75 of file Lattice2D.cpp.

{
    return std::abs(m_length1 * m_length2 * std::sin(m_angle));
}

References m_angle, m_length1, and m_length2.

Member Data Documentation

m_angle

double BasicLattice2D::m_angle

private

Definition at line 71 of file Lattice2D.h.

Referenced by clone(), latticeAngle(), and unitCellArea().

m_length1

double BasicLattice2D::m_length1

private

Definition at line 70 of file Lattice2D.h.

Referenced by BasicLattice2D(), clone(), length1(), and unitCellArea().

m_length2

double BasicLattice2D::m_length2

private

Definition at line 70 of file Lattice2D.h.

Referenced by BasicLattice2D(), clone(), length2(), and unitCellArea().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_xi

double Lattice2D::m_xi

protectedinherited

Definition at line 46 of file Lattice2D.h.

Referenced by clone(), SquareLattice2D::clone(), HexagonalLattice2D::clone(), and Lattice2D::rotationAngle().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Lattice/Lattice2D.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sample/Lattice/Lattice2D.cpp