Interference2DParaCrystalItem Class Reference

Description

Definition at line 97 of file InterferenceItems.h.

Inheritance diagram for Interference2DParaCrystalItem:

Collaboration diagram for Interference2DParaCrystalItem:

Public Member Functions
	Interference2DParaCrystalItem ()
std::unique_ptr< IInterference >	createInterference () const override
DoubleDescriptor	dampingLength () const
DoubleDescriptor	domainSize1 () const
DoubleDescriptor	domainSize2 () const
SelectionDescriptor< Lattice2DItem * >	latticeType () const
DoubleDescriptor	positionVariance () const
SelectionDescriptor< Profile2DItem * >	probabilityDistribution1 () const
SelectionDescriptor< Profile2DItem * >	probabilityDistribution2 () const
void	serialize (Streamer &s) override
void	setDampingLength (double dampingLength)
void	setDomainSize1 (double size)
void	setDomainSize2 (double size)
void	setLatticeType (Lattice2DItem *p)
void	setPDF1Type (Profile2DItem *p)
void	setPDF2Type (Profile2DItem *p)
void	setXiIntegration (bool xiIntegration)
bool	xiIntegration () const

Protected Attributes
SelectionProperty< Lattice2DItem * >	m_latticeType
DoubleProperty	m_positionVariance
bool	m_xiIntegration

Private Attributes
DoubleProperty	m_dampingLength
DoubleProperty	m_domainSize1
DoubleProperty	m_domainSize2
SelectionProperty< Profile2DItem * >	m_pdf1
SelectionProperty< Profile2DItem * >	m_pdf2

Constructor & Destructor Documentation

Interference2DParaCrystalItem()

Interference2DParaCrystalItem::Interference2DParaCrystalItem

(

)

Definition at line 164 of file InterferenceItems.cpp.

    : Interference2DAbstractLatticeItem(true)
{
    m_dampingLength.init("Damping length", "The damping (coherence) length of the paracrystal", 0.0,
                         Unit::nanometer, "dampingLen");
    m_domainSize1.init("Domain size 1", "Size of the coherent domain along the first basis vector",
                       20000.0, Unit::nanometer, "size1");
    m_domainSize2.init("Domain size 2", "Size of the coherent domain along the second basis vector",
                       20000.0, Unit::nanometer, "size2");
    m_pdf1.init<Profile2DItemCatalog>(
        "PDF 1", "Probability distribution in first lattice direction", "pdf1");
    m_pdf2.init<Profile2DItemCatalog>(
        "PDF 2", "Probability distribution in second lattice direction", "pdf2");
}

References SelectionProperty< T >::init(), DoubleProperty::init(), m_dampingLength, m_domainSize1, m_domainSize2, m_pdf1, m_pdf2, and nanometer.

Here is the call graph for this function:

Member Function Documentation

createInterference()

std::unique_ptr< IInterference > Interference2DParaCrystalItem::createInterference ( ) const

overridevirtual

Implements InterferenceItem.

Definition at line 179 of file InterferenceItems.cpp.

{
    Lattice2DItem* latticeItem = latticeType().currentItem();
 
    std::unique_ptr<Interference2DParaCrystal> result(
        new Interference2DParaCrystal(*latticeItem->createLattice(), 0, 0, 0));
 
    result->setDampingLength(m_dampingLength);
    result->setDomainSizes(m_domainSize1, m_domainSize2);
    result->setIntegrationOverXi(xiIntegration());
    result->setProbabilityDistributions(*m_pdf1->createProfile(), *m_pdf2->createProfile());
    result->setPositionVariance(positionVariance());
    return std::unique_ptr<IInterference>(result.release());
}

References Lattice2DItem::createLattice(), Profile2DItem::createProfile(), Interference2DAbstractLatticeItem::latticeType(), m_dampingLength, m_domainSize1, m_domainSize2, m_pdf1, m_pdf2, InterferenceItem::positionVariance(), and Interference2DAbstractLatticeItem::xiIntegration().

Here is the call graph for this function:

dampingLength()

DoubleDescriptor Interference2DParaCrystalItem::dampingLength

(

)

const

Definition at line 207 of file InterferenceItems.cpp.

{
    return m_dampingLength;
}

References m_dampingLength.

Referenced by setDampingLength().

domainSize1()

DoubleDescriptor Interference2DParaCrystalItem::domainSize1

(

)

const

Definition at line 217 of file InterferenceItems.cpp.

{
    return m_domainSize1;
}

References m_domainSize1.

domainSize2()

DoubleDescriptor Interference2DParaCrystalItem::domainSize2

(

)

const

Definition at line 227 of file InterferenceItems.cpp.

{
    return m_domainSize2;
}

References m_domainSize2.

latticeType()

SelectionDescriptor< Lattice2DItem * > Interference2DAbstractLatticeItem::latticeType ( ) const

inherited

Definition at line 94 of file InterferenceItems.cpp.

{
    return m_latticeType;
}

References Interference2DAbstractLatticeItem::m_latticeType.

Referenced by LatticeTypeSelectionForm::LatticeTypeSelectionForm(), ParameterTreeBuilder::addLattice(), LatticeTypeSelectionForm::createContent(), Interference2DLatticeItem::createInterference(), createInterference(), and InterferenceFinite2DLatticeItem::createInterference().

positionVariance()

DoubleDescriptor InterferenceItem::positionVariance ( ) const

inherited

Definition at line 31 of file InterferenceItems.cpp.

{
    return m_positionVariance;
}

References InterferenceItem::m_positionVariance.

Referenced by Interference1DLatticeItem::createInterference(), Interference2DLatticeItem::createInterference(), createInterference(), InterferenceFinite2DLatticeItem::createInterference(), InterferenceHardDiskItem::createInterference(), and InterferenceRadialParaCrystalItem::createInterference().

probabilityDistribution1()

SelectionDescriptor< Profile2DItem * > Interference2DParaCrystalItem::probabilityDistribution1

(

)

const

Definition at line 237 of file InterferenceItems.cpp.

{
    return m_pdf1;
}

References m_pdf1.

probabilityDistribution2()

SelectionDescriptor< Profile2DItem * > Interference2DParaCrystalItem::probabilityDistribution2

(

)

const

Definition at line 247 of file InterferenceItems.cpp.

{
    return m_pdf2;
}

References m_pdf2.

serialize()

void Interference2DParaCrystalItem::serialize ( Streamer &  s )

overridevirtual

Implements InterferenceItem.

Definition at line 194 of file InterferenceItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_positionVariance);
    Serialize::rwValue(s, "integrate", m_xiIntegration);
    Serialize::rwSelected<Lattice2DItemCatalog>(s, m_latticeType);
    Serialize::rwProperty(s, m_dampingLength);
    Serialize::rwProperty(s, m_domainSize1);
    Serialize::rwProperty(s, m_domainSize2);
    Serialize::rwSelected<Profile2DItemCatalog>(s, m_pdf1);
    Serialize::rwSelected<Profile2DItemCatalog>(s, m_pdf2);
}

References Streamer::assertVersion(), m_dampingLength, m_domainSize1, m_domainSize2, Interference2DAbstractLatticeItem::m_latticeType, m_pdf1, m_pdf2, InterferenceItem::m_positionVariance, Interference2DAbstractLatticeItem::m_xiIntegration, Serialize::rwProperty(), and Serialize::rwValue().

Here is the call graph for this function:

setDampingLength()

void Interference2DParaCrystalItem::setDampingLength

(

double

dampingLength

)

Definition at line 212 of file InterferenceItems.cpp.

{
    m_dampingLength.set(dampingLength);
}

References dampingLength(), m_dampingLength, and DoubleProperty::set().

Here is the call graph for this function:

setDomainSize1()

void Interference2DParaCrystalItem::setDomainSize1

(

double

size

)

Definition at line 222 of file InterferenceItems.cpp.

{
    m_domainSize1.set(size);
}

References m_domainSize1, and DoubleProperty::set().

Here is the call graph for this function:

setDomainSize2()

void Interference2DParaCrystalItem::setDomainSize2

(

double

size

)

Definition at line 232 of file InterferenceItems.cpp.

{
    m_domainSize2.set(size);
}

References m_domainSize2, and DoubleProperty::set().

Here is the call graph for this function:

setLatticeType()

void Interference2DAbstractLatticeItem::setLatticeType ( Lattice2DItem *  p )

inherited

Definition at line 99 of file InterferenceItems.cpp.

{
    m_latticeType.set(p);
}

References Interference2DAbstractLatticeItem::m_latticeType, and SelectionProperty< T >::set().

Here is the call graph for this function:

setPDF1Type()

void Interference2DParaCrystalItem::setPDF1Type

(

Profile2DItem *

p

)

Definition at line 242 of file InterferenceItems.cpp.

{
    m_pdf1.set(p);
}

References m_pdf1, and SelectionProperty< T >::set().

Here is the call graph for this function:

setPDF2Type()

void Interference2DParaCrystalItem::setPDF2Type

(

Profile2DItem *

p

)

Definition at line 252 of file InterferenceItems.cpp.

{
    m_pdf2.set(p);
}

References m_pdf2, and SelectionProperty< T >::set().

Here is the call graph for this function:

setXiIntegration()

void Interference2DAbstractLatticeItem::setXiIntegration ( bool  xiIntegration )

inherited

Definition at line 109 of file InterferenceItems.cpp.

{
    m_xiIntegration = xiIntegration;
}

References Interference2DAbstractLatticeItem::m_xiIntegration, and Interference2DAbstractLatticeItem::xiIntegration().

Referenced by SampleEditorController::setIntegrateOverXi().

Here is the call graph for this function:

xiIntegration()

bool Interference2DAbstractLatticeItem::xiIntegration ( ) const

inherited

Definition at line 104 of file InterferenceItems.cpp.

{
    return m_xiIntegration;
}

References Interference2DAbstractLatticeItem::m_xiIntegration.

Referenced by ParameterTreeBuilder::addLattice(), LatticeTypeSelectionForm::createContent(), Interference2DLatticeItem::createInterference(), createInterference(), InterferenceFinite2DLatticeItem::createInterference(), LatticeTypeSelectionForm::onIntegrateOverXiChanged(), Interference2DAbstractLatticeItem::setXiIntegration(), and LatticeTypeSelectionForm::updateXiVisibility().

Member Data Documentation

m_dampingLength

DoubleProperty Interference2DParaCrystalItem::m_dampingLength

private

Definition at line 118 of file InterferenceItems.h.

Referenced by Interference2DParaCrystalItem(), createInterference(), dampingLength(), serialize(), and setDampingLength().

m_domainSize1

DoubleProperty Interference2DParaCrystalItem::m_domainSize1

private

Definition at line 119 of file InterferenceItems.h.

Referenced by Interference2DParaCrystalItem(), createInterference(), domainSize1(), serialize(), and setDomainSize1().

m_domainSize2

DoubleProperty Interference2DParaCrystalItem::m_domainSize2

private

Definition at line 120 of file InterferenceItems.h.

Referenced by Interference2DParaCrystalItem(), createInterference(), domainSize2(), serialize(), and setDomainSize2().

m_latticeType

SelectionProperty<Lattice2DItem*> Interference2DAbstractLatticeItem::m_latticeType

protectedinherited

Definition at line 77 of file InterferenceItems.h.

Referenced by Interference2DAbstractLatticeItem::Interference2DAbstractLatticeItem(), Interference2DAbstractLatticeItem::latticeType(), Interference2DLatticeItem::serialize(), serialize(), InterferenceFinite2DLatticeItem::serialize(), and Interference2DAbstractLatticeItem::setLatticeType().

m_pdf1

SelectionProperty<Profile2DItem*> Interference2DParaCrystalItem::m_pdf1

private

Definition at line 121 of file InterferenceItems.h.

Referenced by Interference2DParaCrystalItem(), createInterference(), probabilityDistribution1(), serialize(), and setPDF1Type().

m_pdf2

SelectionProperty<Profile2DItem*> Interference2DParaCrystalItem::m_pdf2

private

Definition at line 122 of file InterferenceItems.h.

Referenced by Interference2DParaCrystalItem(), createInterference(), probabilityDistribution2(), serialize(), and setPDF2Type().

m_positionVariance

DoubleProperty InterferenceItem::m_positionVariance

protectedinherited

Definition at line 39 of file InterferenceItems.h.

Referenced by InterferenceItem::InterferenceItem(), InterferenceItem::positionVariance(), Interference1DLatticeItem::serialize(), Interference2DLatticeItem::serialize(), serialize(), InterferenceFinite2DLatticeItem::serialize(), InterferenceHardDiskItem::serialize(), InterferenceRadialParaCrystalItem::serialize(), and InterferenceItem::serialize().

m_xiIntegration

bool Interference2DAbstractLatticeItem::m_xiIntegration

protectedinherited

Definition at line 76 of file InterferenceItems.h.

Referenced by Interference2DLatticeItem::serialize(), serialize(), InterferenceFinite2DLatticeItem::serialize(), Interference2DAbstractLatticeItem::setXiIntegration(), and Interference2DAbstractLatticeItem::xiIntegration().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/InterferenceItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/InterferenceItems.cpp