InterferenceRadialParaCrystalItem Class Reference

Description

Definition at line 161 of file InterferenceItems.h.

Inheritance diagram for InterferenceRadialParaCrystalItem:

Collaboration diagram for InterferenceRadialParaCrystalItem:

Public Member Functions
	InterferenceRadialParaCrystalItem ()
std::unique_ptr< IInterference >	createInterference () const override
DoubleDescriptor	dampingLength () const
DoubleDescriptor	domainSize () const
DoubleDescriptor	kappa () const
DoubleDescriptor	peakDistance () const
DoubleDescriptor	positionVariance () const
SelectionDescriptor< Profile1DItem * >	probabilityDistribution () const
void	serialize (Streamer &s) override
void	setPDFType (Profile1DItem *p)

Protected Attributes
DoubleProperty	m_positionVariance

Private Attributes
DoubleProperty	m_dampingLength
DoubleProperty	m_domainSize
DoubleProperty	m_kappa
SelectionProperty< Profile1DItem * >	m_pdf
DoubleProperty	m_peakDistance

Constructor & Destructor Documentation

InterferenceRadialParaCrystalItem()

InterferenceRadialParaCrystalItem::InterferenceRadialParaCrystalItem

(

)

Definition at line 346 of file InterferenceItems.cpp.

{
    m_peakDistance.init("Peak distance", "Average distance to the next neighbor", 20.0,
                        Unit::nanometer, "peak");
    m_dampingLength.init("Damping length", "The damping (coherence) length of the paracrystal",
                         1000.0, Unit::nanometer, "dampingLen");
    m_domainSize.init("Domain size", "Size of coherence domain along the lattice main axis", 0.0,
                      Unit::nanometer, "size");
    m_kappa.init("SizeSpaceCoupling",
                 "Size spacing coupling parameter of the Size Spacing Correlation Approximation",
                 0.0, Unit::unitless, "kappa");
    m_pdf.init<Profile1DItemCatalog>("PDF", "One-dimensional probability distribution", "pdf");
}

References SelectionProperty< T >::init(), DoubleProperty::init(), m_dampingLength, m_domainSize, m_kappa, m_pdf, m_peakDistance, nanometer, and unitless.

Here is the call graph for this function:

Member Function Documentation

createInterference()

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

overridevirtual

Implements InterferenceItem.

Definition at line 360 of file InterferenceItems.cpp.

{
    auto result = std::make_unique<InterferenceRadialParaCrystal>(m_peakDistance, m_dampingLength);
    result->setDomainSize(m_domainSize);
    result->setKappa(m_kappa);
    auto pdf = m_pdf->createProfile();
    result->setProbabilityDistribution(*pdf);
    result->setPositionVariance(positionVariance());
    return std::unique_ptr<IInterference>(result.release());
}

References Profile1DItem::createProfile(), m_dampingLength, m_domainSize, m_kappa, m_pdf, m_peakDistance, and InterferenceItem::positionVariance().

Here is the call graph for this function:

dampingLength()

DoubleDescriptor InterferenceRadialParaCrystalItem::dampingLength

(

)

const

Definition at line 387 of file InterferenceItems.cpp.

{
    return m_dampingLength;
}

References m_dampingLength.

domainSize()

DoubleDescriptor InterferenceRadialParaCrystalItem::domainSize

(

)

const

Definition at line 392 of file InterferenceItems.cpp.

{
    return m_domainSize;
}

References m_domainSize.

kappa()

DoubleDescriptor InterferenceRadialParaCrystalItem::kappa

(

)

const

Definition at line 397 of file InterferenceItems.cpp.

{
    return m_kappa;
}

References m_kappa.

peakDistance()

DoubleDescriptor InterferenceRadialParaCrystalItem::peakDistance

(

)

const

Definition at line 382 of file InterferenceItems.cpp.

{
    return m_peakDistance;
}

References m_peakDistance.

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(), Interference2DParaCrystalItem::createInterference(), InterferenceFinite2DLatticeItem::createInterference(), InterferenceHardDiskItem::createInterference(), and createInterference().

probabilityDistribution()

SelectionDescriptor< Profile1DItem * > InterferenceRadialParaCrystalItem::probabilityDistribution

(

)

const

Definition at line 403 of file InterferenceItems.cpp.

{
    return m_pdf;
}

References m_pdf.

serialize()

void InterferenceRadialParaCrystalItem::serialize ( Streamer &  s )

overridevirtual

Implements InterferenceItem.

Definition at line 371 of file InterferenceItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_positionVariance);
    Serialize::rwProperty(s, m_peakDistance);
    Serialize::rwProperty(s, m_dampingLength);
    Serialize::rwProperty(s, m_domainSize);
    Serialize::rwProperty(s, m_kappa);
    Serialize::rwSelected<Profile1DItemCatalog>(s, m_pdf);
}

References Streamer::assertVersion(), m_dampingLength, m_domainSize, m_kappa, m_pdf, m_peakDistance, InterferenceItem::m_positionVariance, and Serialize::rwProperty().

Here is the call graph for this function:

setPDFType()

void InterferenceRadialParaCrystalItem::setPDFType

(

Profile1DItem *

p

)

Definition at line 408 of file InterferenceItems.cpp.

{
    m_pdf.set(p);
}

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

Here is the call graph for this function:

Member Data Documentation

m_dampingLength

DoubleProperty InterferenceRadialParaCrystalItem::m_dampingLength

private

Definition at line 176 of file InterferenceItems.h.

Referenced by InterferenceRadialParaCrystalItem(), createInterference(), dampingLength(), and serialize().

m_domainSize

DoubleProperty InterferenceRadialParaCrystalItem::m_domainSize

private

Definition at line 177 of file InterferenceItems.h.

Referenced by InterferenceRadialParaCrystalItem(), createInterference(), domainSize(), and serialize().

m_kappa

DoubleProperty InterferenceRadialParaCrystalItem::m_kappa

private

Definition at line 178 of file InterferenceItems.h.

Referenced by InterferenceRadialParaCrystalItem(), createInterference(), kappa(), and serialize().

m_pdf

SelectionProperty<Profile1DItem*> InterferenceRadialParaCrystalItem::m_pdf

private

Definition at line 179 of file InterferenceItems.h.

Referenced by InterferenceRadialParaCrystalItem(), createInterference(), probabilityDistribution(), serialize(), and setPDFType().

m_peakDistance

DoubleProperty InterferenceRadialParaCrystalItem::m_peakDistance

private

Definition at line 175 of file InterferenceItems.h.

Referenced by InterferenceRadialParaCrystalItem(), createInterference(), peakDistance(), and serialize().

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(), Interference2DParaCrystalItem::serialize(), InterferenceFinite2DLatticeItem::serialize(), InterferenceHardDiskItem::serialize(), serialize(), and InterferenceItem::serialize().

---

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