LayerBasicRoughnessItem Class Reference

Description

Definition at line 24 of file LayerRoughnessItems.h.

Collaboration diagram for LayerBasicRoughnessItem:

Public Member Functions
	LayerBasicRoughnessItem ()
DoubleDescriptor	hurst () const
DoubleDescriptor	lateralCorrelationLength () const
void	serialize (Streamer &s)
DoubleDescriptor	sigma () const

Private Attributes
DoubleProperty	m_hurst
DoubleProperty	m_lateralCorrelationLength
DoubleProperty	m_sigma

Constructor & Destructor Documentation

LayerBasicRoughnessItem()

LayerBasicRoughnessItem::LayerBasicRoughnessItem

(

)

Definition at line 26 of file LayerRoughnessItems.cpp.

{
    m_sigma.init("Sigma", "rms of the roughness", 1.0, Unit::nanometer, "sigma");
    m_hurst.init("Hurst",
                 "Hurst parameter which describes how jagged the interface,\n "
                 "dimensionless [0.0, 1.0], where 0.0 gives more spikes, \n1.0 more smoothness.",
                 0.3, Unit::unitless, 3, RealLimits::limited(0.0, 1.0), "hurst");
    m_lateralCorrelationLength.init("Correlation length",
                                    "Lateral correlation length of the roughness", 5.0,
                                    Unit::nanometer, "corrLen");
}

References DoubleProperty::init(), m_hurst, m_lateralCorrelationLength, m_sigma, nanometer, and unitless.

Here is the call graph for this function:

Member Function Documentation

hurst()

DoubleDescriptor LayerBasicRoughnessItem::hurst

(

)

const

Definition at line 43 of file LayerRoughnessItems.cpp.

{
    return m_hurst;
}

References m_hurst.

Referenced by LayerEditorUtils::doubleDescriptorsOfItem().

lateralCorrelationLength()

DoubleDescriptor LayerBasicRoughnessItem::lateralCorrelationLength

(

)

const

Definition at line 48 of file LayerRoughnessItems.cpp.

{
    return m_lateralCorrelationLength;
}

References m_lateralCorrelationLength.

Referenced by LayerEditorUtils::doubleDescriptorsOfItem().

serialize()

void LayerBasicRoughnessItem::serialize

(

Streamer &

s

)

Definition at line 53 of file LayerRoughnessItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_sigma);
    Serialize::rwProperty(s, m_hurst);
    Serialize::rwProperty(s, m_lateralCorrelationLength);
}

References Streamer::assertVersion(), m_hurst, m_lateralCorrelationLength, m_sigma, and Serialize::rwProperty().

Here is the call graph for this function:

sigma()

DoubleDescriptor LayerBasicRoughnessItem::sigma

(

)

const

Definition at line 38 of file LayerRoughnessItems.cpp.

{
    return m_sigma;
}

References m_sigma.

Referenced by LayerEditorUtils::doubleDescriptorsOfItem().

Member Data Documentation

m_hurst

DoubleProperty LayerBasicRoughnessItem::m_hurst

private

Definition at line 35 of file LayerRoughnessItems.h.

Referenced by LayerBasicRoughnessItem(), hurst(), and serialize().

m_lateralCorrelationLength

DoubleProperty LayerBasicRoughnessItem::m_lateralCorrelationLength

private

Definition at line 36 of file LayerRoughnessItems.h.

Referenced by LayerBasicRoughnessItem(), lateralCorrelationLength(), and serialize().

m_sigma

DoubleProperty LayerBasicRoughnessItem::m_sigma

private

Definition at line 34 of file LayerRoughnessItems.h.

Referenced by LayerBasicRoughnessItem(), serialize(), and sigma().

---

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

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