InterferenceFunction2DSuperLattice Class Reference

Interference function of a 2D superlattice with a configurable interference function for each lattice site. More...

Inheritance diagram for InterferenceFunction2DSuperLattice:

Collaboration diagram for InterferenceFunction2DSuperLattice:

Public Member Functions
	InterferenceFunction2DSuperLattice (const Lattice2D &lattice, unsigned size_1, unsigned size_2)
	InterferenceFunction2DSuperLattice (double length_1, double length_2, double alpha, double xi, unsigned size_1, unsigned size_2)
	Constructor of two-dimensional interference function. More...
	~InterferenceFunction2DSuperLattice () override
void	accept (INodeVisitor *visitor) const override
	Calls the INodeVisitor's visit method. More...
InterferenceFunction2DSuperLattice *	clone () const override
	Returns a clone of this ISampleNode object. More...
std::vector< const Material * >	containedMaterials () const
	Returns set of unique materials contained in this ISampleNode. More...
int	copyNumber (const INode *node) const
	Returns copyNumber of child, which takes into account existence of children with same name. More...
ParameterPool *	createParameterTree () const
	Creates new parameter pool, with all local parameters and those of its children. More...
std::string	displayName () const
	Returns display name, composed from the name of node and it's copy number. More...
unsigned	domainSize1 () const
unsigned	domainSize2 () const
double	DWfactor (kvector_t q) const
	Evaluates the Debye-Waller factor for a given wavevector transfer. More...
double	evaluate (const kvector_t q, double outer_iff=1.0) const override
	Evaluates the interference function for a given wavevector transfer. More...
std::vector< const INode * >	getChildren () const override
	Returns a vector of children. More...
const std::string &	getName () const
virtual double	getParticleDensity () const
	If defined by this interference function's parameters, returns the particle density (per area). More...
bool	integrationOverXi () const
bool	isMagnetic () const
	Returns true if there is any magnetic material in this ISampleNode. More...
const Lattice2D &	lattice () const
virtual const Material *	material () const
	Returns nullptr, unless overwritten to return a specific material. More...
virtual void	onChange ()
	Action to be taken in inherited class when a parameter has changed. More...
RealParameter *	parameter (const std::string &name) const
	Returns parameter with given 'name'. More...
ParameterPool *	parameterPool () const
	Returns pointer to the parameter pool. More...
std::string	parametersToString () const
	Returns multiline string representing available parameters. More...
INode *	parent ()
const INode *	parent () const
double	positionVariance () const
	Returns the position variance. More...
std::vector< const INode * >	progeny () const
	Returns a vector of all descendants. More...
void	registerChild (INode *node)
RealParameter &	registerParameter (const std::string &name, double *parpointer)
void	registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setIntegrationOverXi (bool integrate_xi)
void	setName (const std::string &name)
void	setParameterValue (const std::string &name, double value)
virtual void	setParent (const INode *newParent)
void	setPositionVariance (double var)
	Sets the variance of the position for the calculation of the DW factor It is defined as the variance in each relevant dimension. More...
void	setSubstructureIFF (const IInterferenceFunction &sub_iff)
void	setVectorValue (const std::string &base_name, kvector_t value)
const IInterferenceFunction &	substructureIFF () const
virtual bool	supportsMultilayer () const
	Indicates if this interference function can be used with a multilayer (DWBA mode) More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
virtual std::string	treeToString () const
	Returns multiline string representing tree structure below the node. More...

Static Public Member Functions
static std::string	XComponentName (const std::string &base_name)
static std::string	YComponentName (const std::string &base_name)
static std::string	ZComponentName (const std::string &base_name)

Protected Member Functions
double	iff_no_inner (const kvector_t q, double outer_iff) const
	Calculates the structure factor in the absence of extra inner structure. More...

Protected Attributes
const size_t	m_NP
std::vector< double >	m_P
double	m_position_var

Private Member Functions
double	iff_without_dw (const kvector_t q) const override
	Calculates the structure factor without Debye-Waller factor. More...
double	interferenceForXi (double xi) const

Private Attributes
bool	m_integrate_xi
	Integrate over the orientation xi. More...
std::unique_ptr< Lattice2D >	m_lattice
std::string	m_name
double	m_outer_iff
const INode *	m_parent {nullptr}
std::unique_ptr< ParameterPool >	m_pool
	parameter pool (kind of pointer-to-implementation) More...
double	m_qx
double	m_qy
unsigned	m_size_1
unsigned	m_size_2
	Size of the finite lattice in lattice units. More...
std::unique_ptr< IInterferenceFunction >	m_substructure
	IFF of substructure. More...
double	m_xi

Detailed Description

Interference function of a 2D superlattice with a configurable interference function for each lattice site.

Definition at line 25 of file InterferenceFunction2DSuperLattice.h.

Constructor & Destructor Documentation

InterferenceFunction2DSuperLattice() [1/2]

InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice	(	const Lattice2D &	lattice,
		unsigned	size_1,
		unsigned	size_2
	)

Definition at line 24 of file InterferenceFunction2DSuperLattice.cpp.

    : IInterferenceFunction(0)
    , m_integrate_xi(false)
    , m_substructure(nullptr)
    , m_size_1(size_1)
    , m_size_2(size_2)
{
    setName("Interference2DSuperLattice");
    m_lattice.reset(lattice.clone());
    registerChild(m_lattice.get());
    setSubstructureIFF(InterferenceFunctionNone());
}

References Lattice2D::clone(), lattice(), m_lattice, INode::registerChild(), IParametricComponent::setName(), and setSubstructureIFF().

Referenced by clone().

Here is the call graph for this function:

InterferenceFunction2DSuperLattice() [2/2]

InterferenceFunction2DSuperLattice::InterferenceFunction2DSuperLattice	(	double	length_1,
		double	length_2,
		double	alpha,
		double	xi,
		unsigned	size_1,
		unsigned	size_2
	)

Constructor of two-dimensional interference function.

Parameters

length_1	length of first lattice vector in nanometers
length_2	length of second lattice vector in nanometers
alpha	angle between lattice vectors in radians
xi	rotation of lattice with respect to x-axis (beam direction) in radians
size_1	correlation length in direction 1
size_2	correlation length in direction 2

Definition at line 46 of file InterferenceFunction2DSuperLattice.cpp.

    : InterferenceFunction2DSuperLattice(BasicLattice2D(length_1, length_2, alpha, xi), size_1,
                                         size_2)
{
}

~InterferenceFunction2DSuperLattice()

InterferenceFunction2DSuperLattice::~InterferenceFunction2DSuperLattice ( )

overridedefault

Member Function Documentation

accept()

void InterferenceFunction2DSuperLattice::accept ( INodeVisitor *  visitor ) const

inlineoverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 34 of file InterferenceFunction2DSuperLattice.h.

{ visitor->visit(this); }

References INodeVisitor::visit().

Here is the call graph for this function:

clone()

InterferenceFunction2DSuperLattice * InterferenceFunction2DSuperLattice::clone ( ) const

overridevirtual

Returns a clone of this ISampleNode object.

Implements IInterferenceFunction.

Definition at line 55 of file InterferenceFunction2DSuperLattice.cpp.

{
    auto* ret = new InterferenceFunction2DSuperLattice(*m_lattice, m_size_1, m_size_2);
    ret->setPositionVariance(m_position_var);
    ret->setSubstructureIFF(*m_substructure);
    ret->setIntegrationOverXi(integrationOverXi());
    return ret;
}

References InterferenceFunction2DSuperLattice(), integrationOverXi(), m_lattice, IInterferenceFunction::m_position_var, m_size_1, m_size_2, and m_substructure.

Here is the call graph for this function:

containedMaterials()

std::vector< const Material * > ISampleNode::containedMaterials ( ) const

inherited

Returns set of unique materials contained in this ISampleNode.

Definition at line 26 of file ISampleNode.cpp.

{
    std::vector<const Material*> result;
    if (const Material* p_material = material())
        result.push_back(p_material);
    for (const auto* child : getChildren()) {
        if (const ISampleNode* sample = dynamic_cast<const ISampleNode*>(child)) {
            for (const Material* p_material : sample->containedMaterials())
                result.push_back(p_material);
        }
    }
    return result;
}

References INode::getChildren(), and ISampleNode::material().

Referenced by MultiLayerUtils::ContainsCompatibleMaterials(), SampleToPython::initLabels(), and ISampleNode::isMagnetic().

Here is the call graph for this function:

copyNumber()

int INode::copyNumber ( const INode *  node ) const

inherited

Returns copyNumber of child, which takes into account existence of children with same name.

Definition at line 94 of file INode.cpp.

{
    if (node->parent() != this)
        return -1;
 
    int result(-1), count(0);
    for (auto child : getChildren()) {
 
        if (child == nullptr)
            throw std::runtime_error("INode::copyNumber() -> Error. Nullptr as child.");
 
        if (child == node)
            result = count;
 
        if (child->getName() == node->getName())
            ++count;
    }
 
    return count > 1 ? result : -1;
}

References INode::getChildren(), IParametricComponent::getName(), and INode::parent().

Referenced by INode::displayName().

Here is the call graph for this function:

createParameterTree()

ParameterPool * INode::createParameterTree ( ) const

virtualinherited

Creates new parameter pool, with all local parameters and those of its children.

Reimplemented from IParametricComponent.

Definition at line 126 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    for (const INode* child : progeny()) {
        const std::string path = NodeUtils::nodePath(child, parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
    }
 
    return result.release();
}

References NodeUtils::nodePath(), INode::parent(), and INode::progeny().

Referenced by ISimulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecularSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

displayName()

std::string INode::displayName ( ) const

inherited

Returns display name, composed from the name of node and it's copy number.

Definition at line 115 of file INode.cpp.

{
    std::string result = getName();
    if (m_parent) {
        int index = m_parent->copyNumber(this);
        if (index >= 0)
            result = result + std::to_string(index);
    }
    return result;
}

References INode::copyNumber(), IParametricComponent::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath().

Here is the call graph for this function:

domainSize1()

unsigned InterferenceFunction2DSuperLattice::domainSize1 ( ) const

inline

Definition at line 40 of file InterferenceFunction2DSuperLattice.h.

{ return m_size_1; }

References m_size_1.

domainSize2()

unsigned InterferenceFunction2DSuperLattice::domainSize2 ( ) const

inline

Definition at line 41 of file InterferenceFunction2DSuperLattice.h.

{ return m_size_2; }

References m_size_2.

DWfactor()

double IInterferenceFunction::DWfactor ( kvector_t  q ) const

inherited

Evaluates the Debye-Waller factor for a given wavevector transfer.

Definition at line 48 of file IInterferenceFunction.cpp.

{
    // remove z component for two dimensional interference functions:
    if (supportsMultilayer())
        q.setZ(0.0);
    return std::exp(-q.mag2() * m_position_var);
}

References IInterferenceFunction::m_position_var, BasicVector3D< T >::mag2(), BasicVector3D< T >::setZ(), and IInterferenceFunction::supportsMultilayer().

Referenced by IInterferenceFunction::iff_no_inner().

Here is the call graph for this function:

evaluate()

double InterferenceFunction2DSuperLattice::evaluate ( const kvector_t  q, double  outer_iff = 1.0  ) const

overridevirtual

Evaluates the interference function for a given wavevector transfer.

Reimplemented from IInterferenceFunction.

Definition at line 75 of file InterferenceFunction2DSuperLattice.cpp.

{
    m_outer_iff = outer_iff;
    m_qx = q.x();
    m_qy = q.y();
    if (!m_integrate_xi)
        return interferenceForXi(m_lattice->rotationAngle());
    return RealIntegrator().integrate([&](double xi) -> double { return interferenceForXi(xi); },
                                      0.0, M_TWOPI)
           / M_TWOPI;
}

References RealIntegrator::integrate(), interferenceForXi(), m_integrate_xi, m_lattice, m_outer_iff, m_qx, m_qy, M_TWOPI, BasicVector3D< T >::x(), and BasicVector3D< T >::y().

Here is the call graph for this function:

getChildren()

std::vector< const INode * > InterferenceFunction2DSuperLattice::getChildren ( ) const

overridevirtual

Returns a vector of children.

Reimplemented from INode.

Definition at line 101 of file InterferenceFunction2DSuperLattice.cpp.

{
    return std::vector<const INode*>() << m_lattice << m_substructure;
}

References m_lattice, and m_substructure.

getName()

const std::string& IParametricComponent::getName ( ) const

inlineinherited

Definition at line 70 of file IParametricComponent.h.

{ return m_name; }

References IParametricComponent::m_name.

Referenced by Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), IDetector::IDetector(), Instrument::Instrument(), IParametricComponent::IParametricComponent(), SampleBuilderNode::SampleBuilderNode(), Layer::clone(), INode::copyNumber(), IParametricComponent::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), Beam::operator=(), SampleBuilderNode::operator=(), GUIObjectBuilder::populateInstrumentModel(), PyImportAssistant::populateModels(), GUIDomainSampleVisitor::populateSampleModel(), IParametricComponent::registerParameter(), IFormFactor::sliceFormFactor(), and GUIDomainSampleVisitor::visit().

getParticleDensity()

virtual double IInterferenceFunction::getParticleDensity ( ) const

inlinevirtualinherited

If defined by this interference function's parameters, returns the particle density (per area).

Otherwise, returns zero or a user-defined value

Reimplemented in InterferenceFunctionHardDisk, InterferenceFunctionFinite2DLattice, InterferenceFunction2DParaCrystal, and InterferenceFunction2DLattice.

Definition at line 43 of file IInterferenceFunction.h.

{ return 0.0; }

iff_no_inner()

double IInterferenceFunction::iff_no_inner ( const kvector_t  q, double  outer_iff  ) const

protectedinherited

Calculates the structure factor in the absence of extra inner structure.

Definition at line 56 of file IInterferenceFunction.cpp.

{
    return DWfactor(q) * (iff_without_dw(q) * outer_iff - 1.0) + 1.0;
}

References IInterferenceFunction::DWfactor(), and IInterferenceFunction::iff_without_dw().

Referenced by IInterferenceFunction::evaluate(), and interferenceForXi().

Here is the call graph for this function:

iff_without_dw()

double InterferenceFunction2DSuperLattice::iff_without_dw ( const kvector_t  q ) const

overrideprivatevirtual

Calculates the structure factor without Debye-Waller factor.

Implements IInterferenceFunction.

Definition at line 106 of file InterferenceFunction2DSuperLattice.cpp.

{
    using Math::Laue;
 
    const double a = m_lattice->length1();
    const double b = m_lattice->length2();
    const double xialpha = m_xi + m_lattice->latticeAngle();
 
    const double qadiv2 = (q.x() * a * std::cos(m_xi) + q.y() * a * std::sin(m_xi)) / 2.0;
    const double qbdiv2 = (q.x() * b * std::cos(xialpha) + q.y() * b * std::sin(xialpha)) / 2.0;
    const double ampl = Laue(qadiv2, m_size_1) * Laue(qbdiv2, m_size_2);
    return ampl * ampl / (m_size_1 * m_size_2);
}

References Math::Laue(), m_lattice, m_size_1, m_size_2, m_xi, BasicVector3D< T >::x(), and BasicVector3D< T >::y().

Here is the call graph for this function:

integrationOverXi()

bool InterferenceFunction2DSuperLattice::integrationOverXi ( ) const

inline

Definition at line 44 of file InterferenceFunction2DSuperLattice.h.

{ return m_integrate_xi; }

References m_integrate_xi.

Referenced by clone().

interferenceForXi()

double InterferenceFunction2DSuperLattice::interferenceForXi ( double  xi ) const

private

Definition at line 120 of file InterferenceFunction2DSuperLattice.cpp.

{
    m_xi = xi; // TODO ASAP don't set as collateratel effect; rm mutable
    const kvector_t q = kvector_t(m_qx, m_qy, 0.0);
    const double outer_iff = iff_no_inner(q, m_outer_iff);
    const double delta_xi = xi - m_lattice->rotationAngle();
    return m_substructure->evaluate(q.rotatedZ(-delta_xi), outer_iff);
}

References IInterferenceFunction::iff_no_inner(), m_lattice, m_outer_iff, m_qx, m_qy, m_substructure, m_xi, and BasicVector3D< T >::rotatedZ().

Referenced by evaluate().

Here is the call graph for this function:

isMagnetic()

bool ISampleNode::isMagnetic ( ) const

inherited

Returns true if there is any magnetic material in this ISampleNode.

Definition at line 40 of file ISampleNode.cpp.

{
    const auto materials = containedMaterials();
    return std::any_of(materials.cbegin(), materials.cend(),
                       [](const Material* mat) { return mat->isMagneticMaterial(); });
}

References ISampleNode::containedMaterials().

Referenced by ProcessedSample::initLayouts().

Here is the call graph for this function:

lattice()

const Lattice2D & InterferenceFunction2DSuperLattice::lattice

(

)

const

Definition at line 93 of file InterferenceFunction2DSuperLattice.cpp.

{
    if (!m_lattice)
        throw std::runtime_error("InterferenceFunctionFinite2DLattice::lattice() -> Error. "
                                 "No lattice defined.");
    return *m_lattice;
}

References m_lattice.

Referenced by InterferenceFunction2DSuperLattice().

material()

virtual const Material* ISampleNode::material ( ) const

inlinevirtualinherited

Returns nullptr, unless overwritten to return a specific material.

Reimplemented in Particle, and Layer.

Definition at line 37 of file ISampleNode.h.

{ return nullptr; }

Referenced by ISampleNode::containedMaterials(), FormFactorCoreShell::setAmbientMaterial(), FormFactorCrystal::setAmbientMaterial(), FormFactorWeighted::setAmbientMaterial(), FormFactorDecoratorMaterial::setAmbientMaterial(), IFormFactorDecorator::setAmbientMaterial(), and FormFactorDecoratorMaterial::setMaterial().

onChange()

virtual void IParametricComponent::onChange ( )

inlinevirtualinherited

Action to be taken in inherited class when a parameter has changed.

Reimplemented in IProfileRipple, Lattice3D, InterferenceFunction3DLattice, InterferenceFunction2DLattice, FormFactorSphereLogNormalRadius, FormFactorSphereGaussianRadius, FormFactorGaussSphere, ISawtoothRipple, ICosineRipple, IProfileRectangularRipple, FormFactorTruncatedSpheroid, FormFactorTruncatedSphere, FormFactorTruncatedCube, FormFactorTetrahedron, FormFactorPyramid, FormFactorPrism6, FormFactorPrism3, FormFactorLongBoxLorentz, FormFactorLongBoxGauss, FormFactorIcosahedron, FormFactorHollowSphere, FormFactorHemiEllipsoid, FormFactorFullSpheroid, FormFactorFullSphere, FormFactorEllipsoidalCylinder, FormFactorDodecahedron, FormFactorCylinder, FormFactorCuboctahedron, FormFactorCone6, FormFactorCone, FormFactorCantellatedCube, FormFactorBox, FormFactorAnisoPyramid, and Lattice2D.

Definition at line 59 of file IParametricComponent.h.

{}

Referenced by Lattice2D::onChange(), and IParametricComponent::registerParameter().

parameter()

RealParameter * IParametricComponent::parameter ( const std::string &  name ) const

inherited

Returns parameter with given 'name'.

Definition at line 86 of file IParametricComponent.cpp.

{
    return m_pool->parameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

Referenced by DepthProbeSimulation::initialize(), SpecularSimulation::initialize(), Lattice3D::initialize(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), IParticle::registerPosition(), Layer::registerThickness(), Lattice2D::setRotationEnabled(), and DistributionLogNormal::setUnits().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParametricComponent::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 39 of file IParametricComponent.h.

{ return m_pool.get(); } // has non-const usages!

References IParametricComponent::m_pool.

Referenced by INode::INode(), IParametricComponent::IParametricComponent(), pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParametricComponent::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 43 of file IParametricComponent.cpp.

{
    std::ostringstream result;
    std::unique_ptr<ParameterPool> P_pool(createParameterTree());
    result << *P_pool << "\n";
    return result.str();
}

References IParametricComponent::createParameterTree().

Here is the call graph for this function:

parent() [1/2]

INode * INode::parent ( )

inherited

Definition at line 89 of file INode.cpp.

{
    return const_cast<INode*>(m_parent);
}

References INode::m_parent.

parent() [2/2]

const INode * INode::parent ( ) const

inherited

Definition at line 84 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

Referenced by INode::copyNumber(), INode::createParameterTree(), ParticleDistribution::generateParticles(), NodeUtils::nodePath(), Lattice2D::onChange(), SampleProvider::setBuilder(), SampleProvider::setParent(), and SampleProvider::setSample().

positionVariance()

double IInterferenceFunction::positionVariance ( ) const

inlineinherited

Returns the position variance.

Definition at line 39 of file IInterferenceFunction.h.

{ return m_position_var; }

References IInterferenceFunction::m_position_var.

Referenced by TransformFromDomain::setFinite2DLatticeItem().

progeny()

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

inherited

Returns a vector of all descendants.

Definition at line 68 of file INode.cpp.

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

References INode::getChildren().

Referenced by INode::createParameterTree(), and ParticleDistribution::generateParticles().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 57 of file INode.cpp.

{
    ASSERT(node);
    node->setParent(this);
}

References ASSERT, and INode::setParent().

Referenced by Beam::Beam(), Crystal::Crystal(), IDetector::IDetector(), Instrument::Instrument(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), Particle::Particle(), ParticleDistribution::ParticleDistribution(), ParticleLayout::addAndRegisterAbstractParticle(), ParticleCoreShell::addAndRegisterCore(), MultiLayer::addAndRegisterInterface(), MultiLayer::addAndRegisterLayer(), ParticleCoreShell::addAndRegisterShell(), Layer::addLayout(), ParticleComposition::addParticlePointer(), ISimulation::initialize(), MesoCrystal::initialize(), Beam::operator=(), Instrument::operator=(), IParticle::rotate(), ParticleLayout::setAndRegisterInterferenceFunction(), ISimulation::setBackground(), InterferenceFunction1DLattice::setDecayFunction(), InterferenceFunction2DLattice::setDecayFunction(), Instrument::setDetector(), IDetector::setDetectorResolution(), Beam::setFootprintFactor(), Particle::setFormFactor(), InterferenceFunctionFinite3DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), InterferenceFunction2DParaCrystal::setProbabilityDistributions(), ConvolutionDetectorResolution::setResolutionFunction(), IParticle::setRotation(), LayerInterface::setRoughness(), and setSubstructureIFF().

Here is the call graph for this function:

registerParameter()

RealParameter & IParametricComponent::registerParameter ( const std::string &  name, double *  parpointer  )

inherited

Definition at line 51 of file IParametricComponent.cpp.

{
    return m_pool->addParameter(
        new RealParameter(name, data, getName(), [&]() -> void { onChange(); }));
}

References IParametricComponent::getName(), IParametricComponent::m_pool, RealSpace::Particles::name(), and IParametricComponent::onChange().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), CylindersInBABuilder::CylindersInBABuilder(), DetectionProperties::DetectionProperties(), HexagonalLattice2D::HexagonalLattice2D(), IInterferenceFunction::IInterferenceFunction(), INode::INode(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), Lattice2D::Lattice2D(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleDistribution::ParticleDistribution(), PlainMultiLayerBySLDBuilder::PlainMultiLayerBySLDBuilder(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), ResonatorBuilder::ResonatorBuilder(), SquareLattice2D::SquareLattice2D(), TriangularRippleBuilder::TriangularRippleBuilder(), IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParametricComponent::registerVector(), ParticleLayout::registerWeight(), and Lattice2D::setRotationEnabled().

Here is the call graph for this function:

registerVector()

void IParametricComponent::registerVector ( const std::string &  base_name, kvector_t *  p_vec, const std::string &  units = "nm"  )

inherited

Definition at line 57 of file IParametricComponent.cpp.

{
    registerParameter(XComponentName(base_name), &((*p_vec)[0])).setUnit(units);
    registerParameter(YComponentName(base_name), &((*p_vec)[1])).setUnit(units);
    registerParameter(ZComponentName(base_name), &((*p_vec)[2])).setUnit(units);
}

References ModelView::Utils::base_name(), IParametricComponent::registerParameter(), RealParameter::setUnit(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice3D::initialize(), and IParticle::registerPosition().

Here is the call graph for this function:

removeParameter()

void IParametricComponent::removeParameter ( const std::string &  name )

inherited

Definition at line 91 of file IParametricComponent.cpp.

{
    m_pool->removeParameter(name);
}

References IParametricComponent::m_pool, and RealSpace::Particles::name().

Referenced by IParticle::registerAbundance(), ParticleLayout::registerParticleDensity(), Layer::registerThickness(), IParametricComponent::removeVector(), and Lattice2D::setRotationEnabled().

Here is the call graph for this function:

removeVector()

void IParametricComponent::removeVector ( const std::string &  base_name )

inherited

Definition at line 96 of file IParametricComponent.cpp.

{
    removeParameter(XComponentName(base_name));
    removeParameter(YComponentName(base_name));
    removeParameter(ZComponentName(base_name));
}

References ModelView::Utils::base_name(), IParametricComponent::removeParameter(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

setIntegrationOverXi()

void InterferenceFunction2DSuperLattice::setIntegrationOverXi

(

bool

integrate_xi

)

Definition at line 87 of file InterferenceFunction2DSuperLattice.cpp.

{
    m_integrate_xi = integrate_xi;
    m_lattice->setRotationEnabled(!m_integrate_xi); // deregister Xi in the case of integration
}

References m_integrate_xi, and m_lattice.

setName()

void IParametricComponent::setName ( const std::string &  name )

inlineinherited

Definition at line 69 of file IParametricComponent.h.

{ m_name = name; }

References IParametricComponent::m_name, and RealSpace::Particles::name().

Referenced by BasicLattice2D::BasicLattice2D(), Beam::Beam(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), Crystal::Crystal(), DetectionProperties::DetectionProperties(), DistributionHandler::DistributionHandler(), FormFactorCoreShell::FormFactorCoreShell(), FormFactorCrystal::FormFactorCrystal(), FormFactorDecoratorMaterial::FormFactorDecoratorMaterial(), FormFactorDecoratorPositionFactor::FormFactorDecoratorPositionFactor(), FormFactorDecoratorRotation::FormFactorDecoratorRotation(), FormFactorWeighted::FormFactorWeighted(), HexagonalLattice2D::HexagonalLattice2D(), IDetector::IDetector(), INode::INode(), Instrument::Instrument(), InterferenceFunction1DLattice::InterferenceFunction1DLattice(), InterferenceFunction2DLattice::InterferenceFunction2DLattice(), InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal(), InterferenceFunction2DSuperLattice(), InterferenceFunction3DLattice::InterferenceFunction3DLattice(), InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice(), InterferenceFunctionFinite3DLattice::InterferenceFunctionFinite3DLattice(), InterferenceFunctionHardDisk::InterferenceFunctionHardDisk(), InterferenceFunctionNone::InterferenceFunctionNone(), InterferenceFunctionRadialParaCrystal::InterferenceFunctionRadialParaCrystal(), InterferenceFunctionTwin::InterferenceFunctionTwin(), ISampleBuilder::ISampleBuilder(), IsGISAXSDetector::IsGISAXSDetector(), Lattice3D::Lattice3D(), Layer::Layer(), LayerInterface::LayerInterface(), LayerRoughness::LayerRoughness(), MultiLayer::MultiLayer(), ParticleCoreShell::ParticleCoreShell(), ParticleDistribution::ParticleDistribution(), ParticleLayout::ParticleLayout(), RectangularDetector::RectangularDetector(), ResolutionFunction2DGaussian::ResolutionFunction2DGaussian(), SampleBuilderNode::SampleBuilderNode(), SphericalDetector::SphericalDetector(), SquareLattice2D::SquareLattice2D(), Layer::clone(), LayersWithAbsorptionBuilder::createSampleByIndex(), Basic2DParaCrystalBuilder::createSampleByIndex(), ParticleInVacuumBuilder::createSampleByIndex(), SimpleMagneticRotationBuilder::createSampleByIndex(), DepthProbeSimulation::initialize(), GISASSimulation::initialize(), OffSpecularSimulation::initialize(), SpecularSimulation::initialize(), SpecularDetector1D::initialize(), MesoCrystal::initialize(), Particle::initialize(), ParticleComposition::initialize(), Beam::operator=(), SampleBuilderNode::operator=(), SampleBuilderNode::reset(), and SampleBuilderNode::setSBN().

Here is the call graph for this function:

setParameterValue()

void IParametricComponent::setParameterValue ( const std::string &  name, double  value  )

inherited

Definition at line 65 of file IParametricComponent.cpp.

{
    if (name.find('*') == std::string::npos && name.find('/') == std::string::npos) {
        m_pool->setParameterValue(name, value);
    } else {
        std::unique_ptr<ParameterPool> P_pool{createParameterTree()};
        if (name.find('*') != std::string::npos)
            P_pool->setMatchedParametersValue(name, value);
        else
            P_pool->setParameterValue(name, value);
    }
}

References IParametricComponent::createParameterTree(), IParametricComponent::m_pool, RealSpace::Particles::name(), and ParameterPool::setMatchedParametersValue().

Referenced by AsymRippleBuilder::buildSample(), and IParametricComponent::setVectorValue().

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 79 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

Referenced by INode::registerChild(), SampleProvider::setBuilder(), and SampleProvider::setParent().

setPositionVariance()

void IInterferenceFunction::setPositionVariance ( double  var )

inherited

Sets the variance of the position for the calculation of the DW factor It is defined as the variance in each relevant dimension.

Definition at line 40 of file IInterferenceFunction.cpp.

{
    if (var < 0.0)
        throw std::runtime_error("IInterferenceFunction::setPositionVariance: "
                                 "variance should be positive.");
    m_position_var = var;
}

References IInterferenceFunction::m_position_var.

Referenced by FiniteSquareLattice2DBuilder::buildSample(), SuperLatticeBuilder::buildSample(), and InterferenceFunctionItem::setPositionVariance().

setSubstructureIFF()

void InterferenceFunction2DSuperLattice::setSubstructureIFF

(

const IInterferenceFunction &

sub_iff

)

Definition at line 64 of file InterferenceFunction2DSuperLattice.cpp.

{
    m_substructure.reset(sub_iff.clone());
    registerChild(m_substructure.get());
}

References IInterferenceFunction::clone(), m_substructure, and INode::registerChild().

Referenced by InterferenceFunction2DSuperLattice(), and SuperLatticeBuilder::buildSample().

Here is the call graph for this function:

setVectorValue()

void IParametricComponent::setVectorValue ( const std::string &  base_name, kvector_t  value  )

inherited

Definition at line 78 of file IParametricComponent.cpp.

{
    setParameterValue(XComponentName(base_name), value.x());
    setParameterValue(YComponentName(base_name), value.y());
    setParameterValue(ZComponentName(base_name), value.z());
}

References ModelView::Utils::base_name(), IParametricComponent::setParameterValue(), BasicVector3D< T >::x(), IParametricComponent::XComponentName(), BasicVector3D< T >::y(), IParametricComponent::YComponentName(), BasicVector3D< T >::z(), and IParametricComponent::ZComponentName().

Here is the call graph for this function:

substructureIFF()

const IInterferenceFunction & InterferenceFunction2DSuperLattice::substructureIFF

(

)

const

Definition at line 70 of file InterferenceFunction2DSuperLattice.cpp.

{
    return *m_substructure;
}

References m_substructure.

supportsMultilayer()

virtual bool IInterferenceFunction::supportsMultilayer ( ) const

inlinevirtualinherited

Indicates if this interference function can be used with a multilayer (DWBA mode)

Reimplemented in InterferenceFunctionFinite3DLattice, and InterferenceFunction3DLattice.

Definition at line 46 of file IInterferenceFunction.h.

{ return true; }

Referenced by IInterferenceFunction::DWfactor().

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

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

Definition at line 34 of file ICloneable.h.

treeToString()

std::string INode::treeToString ( ) const

virtualinherited

Returns multiline string representing tree structure below the node.

Definition at line 52 of file INode.cpp.

{
    return NodeUtils::nodeToString(this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

XComponentName()

std::string IParametricComponent::XComponentName ( const std::string &  base_name )

staticinherited

Definition at line 103 of file IParametricComponent.cpp.

{
    return base_name + "X";
}

References ModelView::Utils::base_name().

Referenced by Lattice3D::initialize(), IParticle::registerPosition(), IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

YComponentName()

std::string IParametricComponent::YComponentName ( const std::string &  base_name )

staticinherited

Definition at line 108 of file IParametricComponent.cpp.

{
    return base_name + "Y";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

ZComponentName()

std::string IParametricComponent::ZComponentName ( const std::string &  base_name )

staticinherited

Definition at line 113 of file IParametricComponent.cpp.

{
    return base_name + "Z";
}

References ModelView::Utils::base_name().

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), and VectorParameterTranslator::translate().

Here is the call graph for this function:

Member Data Documentation

m_integrate_xi

bool InterferenceFunction2DSuperLattice::m_integrate_xi

private

Integrate over the orientation xi.

Definition at line 55 of file InterferenceFunction2DSuperLattice.h.

Referenced by evaluate(), integrationOverXi(), and setIntegrationOverXi().

m_lattice

std::unique_ptr<Lattice2D> InterferenceFunction2DSuperLattice::m_lattice

private

Definition at line 56 of file InterferenceFunction2DSuperLattice.h.

Referenced by InterferenceFunction2DSuperLattice(), clone(), evaluate(), getChildren(), iff_without_dw(), interferenceForXi(), lattice(), and setIntegrationOverXi().

m_name

std::string IParametricComponent::m_name

privateinherited

Definition at line 73 of file IParametricComponent.h.

Referenced by IParametricComponent::getName(), and IParametricComponent::setName().

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 88 of file INode.h.

Referenced by INode::INode().

m_outer_iff

double InterferenceFunction2DSuperLattice::m_outer_iff

mutableprivate

Definition at line 59 of file InterferenceFunction2DSuperLattice.h.

Referenced by evaluate(), and interferenceForXi().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 89 of file INode.h.

Referenced by INode::INode(), and IFootprintFactor::setWidthRatio().

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 83 of file INode.h.

Referenced by INode::displayName(), INode::parent(), and INode::setParent().

m_pool

std::unique_ptr<ParameterPool> IParametricComponent::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 74 of file IParametricComponent.h.

Referenced by IParametricComponent::createParameterTree(), IParametricComponent::parameter(), IParametricComponent::parameterPool(), IParametricComponent::registerParameter(), IParametricComponent::removeParameter(), and IParametricComponent::setParameterValue().

m_position_var

double IInterferenceFunction::m_position_var

protectedinherited

Definition at line 52 of file IInterferenceFunction.h.

Referenced by IInterferenceFunction::IInterferenceFunction(), InterferenceFunctionNone::clone(), InterferenceFunctionRadialParaCrystal::clone(), InterferenceFunctionTwin::clone(), InterferenceFunction1DLattice::clone(), InterferenceFunction2DLattice::clone(), InterferenceFunction2DParaCrystal::clone(), clone(), InterferenceFunction3DLattice::clone(), InterferenceFunctionFinite2DLattice::clone(), InterferenceFunctionFinite3DLattice::clone(), InterferenceFunctionHardDisk::clone(), IInterferenceFunction::DWfactor(), IInterferenceFunction::positionVariance(), and IInterferenceFunction::setPositionVariance().

m_qx

double InterferenceFunction2DSuperLattice::m_qx

mutableprivate

Definition at line 60 of file InterferenceFunction2DSuperLattice.h.

Referenced by evaluate(), and interferenceForXi().

m_qy

double InterferenceFunction2DSuperLattice::m_qy

mutableprivate

Definition at line 61 of file InterferenceFunction2DSuperLattice.h.

Referenced by evaluate(), and interferenceForXi().

m_size_1

unsigned InterferenceFunction2DSuperLattice::m_size_1

private

Definition at line 58 of file InterferenceFunction2DSuperLattice.h.

Referenced by clone(), domainSize1(), and iff_without_dw().

m_size_2

unsigned InterferenceFunction2DSuperLattice::m_size_2

private

Size of the finite lattice in lattice units.

Definition at line 58 of file InterferenceFunction2DSuperLattice.h.

Referenced by clone(), domainSize2(), and iff_without_dw().

m_substructure

std::unique_ptr<IInterferenceFunction> InterferenceFunction2DSuperLattice::m_substructure

private

IFF of substructure.

Definition at line 57 of file InterferenceFunction2DSuperLattice.h.

Referenced by clone(), getChildren(), interferenceForXi(), setSubstructureIFF(), and substructureIFF().

m_xi

double InterferenceFunction2DSuperLattice::m_xi

mutableprivate

Definition at line 62 of file InterferenceFunction2DSuperLattice.h.

Referenced by iff_without_dw(), and interferenceForXi().

---

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

• /home/www/ba/Sample/Aggregate/InterferenceFunction2DSuperLattice.h
• /home/www/ba/Sample/Aggregate/InterferenceFunction2DSuperLattice.cpp