InterferenceFunctionFinite2DLattice Class Reference

Inheritance diagram for InterferenceFunctionFinite2DLattice:

Collaboration diagram for InterferenceFunctionFinite2DLattice:

Public Member Functions
	InterferenceFunctionFinite2DLattice (const Lattice2D &lattice, unsigned N_1, unsigned N_2)
	InterferenceFunctionFinite2DLattice (double length_1, double length_2, double alpha, double xi, unsigned N_1, unsigned N_2)
	~InterferenceFunctionFinite2DLattice () final
InterferenceFunctionFinite2DLattice *	clone () const override final
void	accept (INodeVisitor *visitor) const override final
unsigned	numberUnitCells1 () const
unsigned	numberUnitCells2 () const
void	setIntegrationOverXi (bool integrate_xi)
bool	integrationOverXi () const
const Lattice2D &	lattice () const
double	getParticleDensity () const override final
std::vector< const INode * >	getChildren () const override final
virtual double	evaluate (const kvector_t q, double outer_iff=1.0) const
void	setPositionVariance (double var)
double	positionVariance () const
virtual bool	supportsMultilayer () const
double	DWfactor (kvector_t q) const
virtual const Material *	material () const
std::vector< const Material * >	containedMaterials () const
virtual void	transferToCPP ()
virtual std::string	treeToString () const
void	registerChild (INode *node)
virtual void	setParent (const INode *newParent)
const INode *	parent () const
INode *	parent ()
int	copyNumber (const INode *node) const
std::string	displayName () const
ParameterPool *	createParameterTree () const
ParameterPool *	parameterPool () const
std::string	parametersToString () const
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	setParameterValue (const std::string &name, double value)
void	setVectorValue (const std::string &base_name, kvector_t value)
RealParameter *	parameter (const std::string &name) const
virtual void	onChange ()
void	removeParameter (const std::string &name)
void	removeVector (const std::string &base_name)
void	setName (const std::string &name)
const std::string &	getName () const

Static Public Member Functions
static InterferenceFunctionFinite2DLattice *	createSquare (double lattice_length, double xi, unsigned N_1, unsigned N_2)
static InterferenceFunctionFinite2DLattice *	createHexagonal (double lattice_length, double xi, unsigned N_1, unsigned N_2)
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

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

Private Member Functions
double	iff_without_dw (const kvector_t q) const override final
void	setLattice (const Lattice2D &lattice)
double	interferenceForXi (double xi) const

Private Attributes
bool	m_integrate_xi
std::unique_ptr< Lattice2D >	mP_lattice
unsigned	m_N_1
unsigned	m_N_2
double	m_qx
double	m_qy
const INode *	m_parent {nullptr}
std::string	m_name
std::unique_ptr< ParameterPool >	m_pool

Detailed Description

Interference function of a finite 2D lattice.

Definition at line 24 of file InterferenceFunctionFinite2DLattice.h.

Constructor & Destructor Documentation

InterferenceFunctionFinite2DLattice() [1/2]

InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice	(	const Lattice2D &	lattice,
		unsigned	N_1,
		unsigned	N_2
	)

Constructor of two-dimensional finite lattice interference function.

Parameters

lattice	object specifying a 2d lattice structure
N_1	number of lattice cells in the first lattice direction
N_2	number of lattice cells in the second lattice direction

Definition at line 30 of file InterferenceFunctionFinite2DLattice.cpp.

    : IInterferenceFunction(0), m_integrate_xi(false), m_N_1(N_1), m_N_2(N_2)
{
    setName("InterferenceFinite2DLattice");
    setLattice(lattice);
}

References lattice(), setLattice(), and IParameterized::setName().

Referenced by clone(), createHexagonal(), and createSquare().

Here is the call graph for this function:

InterferenceFunctionFinite2DLattice() [2/2]

InterferenceFunctionFinite2DLattice::InterferenceFunctionFinite2DLattice	(	double	length_1,
		double	length_2,
		double	alpha,
		double	xi,
		unsigned	N_1,
		unsigned	N_2
	)

Constructor of two-dimensional finite lattice 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
N_1	number of lattice cells in the first lattice direction
N_2	number of lattice cells in the second lattice direction

Definition at line 45 of file InterferenceFunctionFinite2DLattice.cpp.

    : InterferenceFunctionFinite2DLattice(BasicLattice(length_1, length_2, alpha, xi), N_1, N_2)
{
}

~InterferenceFunctionFinite2DLattice()

InterferenceFunctionFinite2DLattice::~InterferenceFunctionFinite2DLattice ( )

finaldefault

Member Function Documentation

clone()

InterferenceFunctionFinite2DLattice * InterferenceFunctionFinite2DLattice::clone ( ) const

finaloverridevirtual

Returns a clone of this ISample object.

Implements IInterferenceFunction.

Definition at line 55 of file InterferenceFunctionFinite2DLattice.cpp.

{
    auto* ret = new InterferenceFunctionFinite2DLattice(*mP_lattice, m_N_1, m_N_2);
    ret->setPositionVariance(m_position_var);
    ret->setIntegrationOverXi(integrationOverXi());
    return ret;
}

References integrationOverXi(), InterferenceFunctionFinite2DLattice(), m_N_1, m_N_2, IInterferenceFunction::m_position_var, and mP_lattice.

Here is the call graph for this function:

accept()

void InterferenceFunctionFinite2DLattice::accept ( INodeVisitor *  visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 34 of file InterferenceFunctionFinite2DLattice.h.

{ visitor->visit(this); }

createSquare()

InterferenceFunctionFinite2DLattice * InterferenceFunctionFinite2DLattice::createSquare ( double  lattice_length, double  xi, unsigned  N_1, unsigned  N_2  )

static

Creates square lattice.

Parameters

lattice_length	length of first and second lattice vectors in nanometers
xi	rotation of lattice with respect to x-axis in radians
N_1	number of lattice cells in the first lattice direction
N_2	number of lattice cells in the second lattice direction

Definition at line 69 of file InterferenceFunctionFinite2DLattice.cpp.

{
    return new InterferenceFunctionFinite2DLattice(SquareLattice(lattice_length, xi), N_1, N_2);
}

References InterferenceFunctionFinite2DLattice().

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

Here is the call graph for this function:

createHexagonal()

InterferenceFunctionFinite2DLattice * InterferenceFunctionFinite2DLattice::createHexagonal ( double  lattice_length, double  xi, unsigned  N_1, unsigned  N_2  )

static

Creates hexagonal lattice.

Parameters

lattice_length	length of first and second lattice vectors in nanometers
xi	rotation of lattice with respect to x-axis in radians
N_1	number of lattice cells in the first lattice direction
N_2	number of lattice cells in the second lattice direction

Definition at line 81 of file InterferenceFunctionFinite2DLattice.cpp.

{
    return new InterferenceFunctionFinite2DLattice(HexagonalLattice(lattice_length, xi), N_1, N_2);
}

References InterferenceFunctionFinite2DLattice().

Here is the call graph for this function:

numberUnitCells1()

unsigned InterferenceFunctionFinite2DLattice::numberUnitCells1 ( ) const

inline

Definition at line 41 of file InterferenceFunctionFinite2DLattice.h.

{ return m_N_1; }

References m_N_1.

numberUnitCells2()

unsigned InterferenceFunctionFinite2DLattice::numberUnitCells2 ( ) const

inline

Definition at line 42 of file InterferenceFunctionFinite2DLattice.h.

{ return m_N_2; }

References m_N_2.

setIntegrationOverXi()

void InterferenceFunctionFinite2DLattice::setIntegrationOverXi

(

bool

integrate_xi

)

Definition at line 87 of file InterferenceFunctionFinite2DLattice.cpp.

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

References m_integrate_xi, and mP_lattice.

integrationOverXi()

bool InterferenceFunctionFinite2DLattice::integrationOverXi ( ) const

inline

Definition at line 45 of file InterferenceFunctionFinite2DLattice.h.

{ return m_integrate_xi; }

References m_integrate_xi.

Referenced by clone().

lattice()

const Lattice2D & InterferenceFunctionFinite2DLattice::lattice

(

)

const

Definition at line 93 of file InterferenceFunctionFinite2DLattice.cpp.

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

References mP_lattice.

Referenced by InterferenceFunctionFinite2DLattice(), and setLattice().

getParticleDensity()

double InterferenceFunctionFinite2DLattice::getParticleDensity ( ) const

finaloverridevirtual

Returns the particle density associated with this 2d lattice.

Reimplemented from IInterferenceFunction.

Definition at line 101 of file InterferenceFunctionFinite2DLattice.cpp.

{
    double area = mP_lattice->unitCellArea();
    return area == 0.0 ? 0.0 : 1.0 / area;
}

References mP_lattice.

getChildren()

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

finaloverridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 107 of file InterferenceFunctionFinite2DLattice.cpp.

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

References mP_lattice.

iff_without_dw()

double InterferenceFunctionFinite2DLattice::iff_without_dw ( const kvector_t  q ) const

finaloverrideprivatevirtual

Calculates the structure factor without Debye-Waller factor.

Implements IInterferenceFunction.

Definition at line 112 of file InterferenceFunctionFinite2DLattice.cpp.

{
    m_qx = q.x();
    m_qy = q.y();
    if (!m_integrate_xi)
        return interferenceForXi(mP_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_qx, m_qy, M_TWOPI, mP_lattice, BasicVector3D< T >::x(), and BasicVector3D< T >::y().

Here is the call graph for this function:

setLattice()

void InterferenceFunctionFinite2DLattice::setLattice ( const Lattice2D &  lattice )

private

Definition at line 123 of file InterferenceFunctionFinite2DLattice.cpp.

{
    mP_lattice.reset(lattice.clone());
    registerChild(mP_lattice.get());
}

References Lattice2D::clone(), lattice(), mP_lattice, and INode::registerChild().

Referenced by InterferenceFunctionFinite2DLattice().

Here is the call graph for this function:

interferenceForXi()

double InterferenceFunctionFinite2DLattice::interferenceForXi ( double  xi ) const

private

Definition at line 129 of file InterferenceFunctionFinite2DLattice.cpp.

{
    double a = mP_lattice->length1();
    double b = mP_lattice->length2();
    double xialpha = xi + mP_lattice->latticeAngle();
 
    double qadiv2 = (m_qx * a * std::cos(xi) + m_qy * a * std::sin(xi)) / 2.0;
    double qbdiv2 = (m_qx * b * std::cos(xialpha) + m_qy * b * std::sin(xialpha)) / 2.0;
    double ampl = Laue(qadiv2, m_N_1) * Laue(qbdiv2, m_N_2);
    double lattice_factor = ampl * ampl / (m_N_1 * m_N_2);
 
    return lattice_factor;
}

References MathFunctions::Laue(), m_N_1, m_N_2, m_qx, m_qy, and mP_lattice.

Referenced by iff_without_dw().

Here is the call graph for this function:

evaluate()

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

virtualinherited

Evaluates the interference function for a given wavevector transfer.

Reimplemented in InterferenceFunction2DSuperLattice.

Definition at line 35 of file IInterferenceFunction.cpp.

{
    return iff_no_inner(q, outer_iff);
}

References IInterferenceFunction::iff_no_inner().

Here is the call graph for this function:

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 FiniteSquareLatticeBuilder::buildSample(), and SuperLatticeBuilder::buildSample().

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 SampleToPython::defineInterferenceFunctions().

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 LayoutStrategyBuilder::createStrategy(), and IInterferenceFunction::DWfactor().

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:

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 InterferenceFunction2DSuperLattice::interferenceForXi().

Here is the call graph for this function:

material()

virtual const Material* ISample::material ( ) const

inlinevirtualinherited

Returns nullptr, unless overwritten to return a specific material.

Reimplemented in Particle, and Layer.

Definition at line 37 of file ISample.h.

{ return nullptr; }

Referenced by ISample::containedMaterials(), FormFactorCrystal::setAmbientMaterial(), FormFactorBAPol::setAmbientMaterial(), FormFactorDecoratorMaterial::setAmbientMaterial(), FormFactorDWBA::setAmbientMaterial(), FormFactorDWBAPol::setAmbientMaterial(), IFormFactorDecorator::setAmbientMaterial(), FormFactorCoreShell::setAmbientMaterial(), FormFactorWeighted::setAmbientMaterial(), and FormFactorDecoratorMaterial::setMaterial().

containedMaterials()

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

inherited

Returns set of unique materials contained in this ISample.

Definition at line 23 of file ISample.cpp.

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

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

Referenced by MultiLayerUtils::ContainsCompatibleMaterials(), anonymous_namespace{ProcessedSample.cpp}::ContainsMagneticMaterial(), and SampleToPython::initLabels().

Here is the call graph for this function:

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 53 of file INode.cpp.

{
    return NodeUtils::nodeToString(*this);
}

References NodeUtils::nodeToString().

Here is the call graph for this function:

registerChild()

void INode::registerChild ( INode *  node )

inherited

Definition at line 58 of file INode.cpp.

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

References ASSERT, and INode::setParent().

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

Here is the call graph for this function:

setParent()

void INode::setParent ( const INode *  newParent )

virtualinherited

Reimplemented in SampleProvider.

Definition at line 69 of file INode.cpp.

{
    m_parent = newParent;
}

References INode::m_parent.

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

parent() [1/2]

const INode * INode::parent ( ) const

inherited

Definition at line 74 of file INode.cpp.

{
    return m_parent;
}

References INode::m_parent.

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

parent() [2/2]

INode * INode::parent ( )

inherited

Definition at line 79 of file INode.cpp.

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

References INode::m_parent.

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 84 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(), IParameterized::getName(), and INode::parent().

Referenced by INode::displayName().

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 105 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(), IParameterized::getName(), and INode::m_parent.

Referenced by NodeUtils::nodePath(), and anonymous_namespace{NodeUtils.cpp}::nodeString().

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 IParameterized.

Definition at line 116 of file INode.cpp.

{
    std::unique_ptr<ParameterPool> result(new ParameterPool);
 
    NodeIterator<PreorderStrategy> it(this);
    it.first();
    while (!it.isDone()) {
        const INode* child = it.getCurrent();
        const std::string path = NodeUtils::nodePath(*child, this->parent()) + "/";
        child->parameterPool()->copyToExternalPool(path, result.get());
        it.next();
    }
 
    return result.release();
}

References ParameterPool::copyToExternalPool(), NodeIterator< Strategy >::first(), NodeIterator< Strategy >::getCurrent(), NodeIterator< Strategy >::isDone(), NodeIterator< Strategy >::next(), NodeUtils::nodePath(), IParameterized::parameterPool(), and INode::parent().

Referenced by ParticleDistribution::generateParticles(), Simulation::runSimulation(), DepthProbeSimulation::validateParametrization(), OffSpecSimulation::validateParametrization(), and SpecularSimulation::validateParametrization().

Here is the call graph for this function:

parameterPool()

ParameterPool* IParameterized::parameterPool ( ) const

inlineinherited

Returns pointer to the parameter pool.

Definition at line 38 of file IParameterized.h.

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

References IParameterized::m_pool.

Referenced by pyfmt2::argumentList(), SampleBuilderNode::borrow_builder_parameters(), INode::createParameterTree(), INode::INode(), IParameterized::IParameterized(), anonymous_namespace{NodeUtils.cpp}::poolToString(), SampleBuilderNode::reset(), and IDistribution1D::setUnits().

parametersToString()

std::string IParameterized::parametersToString ( ) const

inherited

Returns multiline string representing available parameters.

Definition at line 40 of file IParameterized.cpp.

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

References IParameterized::createParameterTree().

Here is the call graph for this function:

registerParameter()

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

inherited

Definition at line 48 of file IParameterized.cpp.

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

References IParameterized::getName(), IParameterized::m_pool, and IParameterized::onChange().

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

Here is the call graph for this function:

registerVector()

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

inherited

Definition at line 54 of file IParameterized.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 IParameterized::registerParameter(), RealParameter::setUnit(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by Beam::Beam(), DetectionProperties::DetectionProperties(), InterferenceFunctionTwin::InterferenceFunctionTwin(), MultiLayer::MultiLayer(), Lattice::registerBasisVectors(), and IParticle::registerPosition().

Here is the call graph for this function:

setParameterValue()

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

inherited

Definition at line 62 of file IParameterized.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 IParameterized::createParameterTree(), IParameterized::m_pool, and ParameterPool::setMatchedParametersValue().

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

Here is the call graph for this function:

setVectorValue()

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

inherited

Definition at line 75 of file IParameterized.cpp.

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

References IParameterized::setParameterValue(), BasicVector3D< T >::x(), IParameterized::XComponentName(), BasicVector3D< T >::y(), IParameterized::YComponentName(), BasicVector3D< T >::z(), and IParameterized::ZComponentName().

Here is the call graph for this function:

parameter()

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

inherited

Returns parameter with given 'name'.

Definition at line 83 of file IParameterized.cpp.

{
    return m_pool->parameter(name);
}

References IParameterized::m_pool.

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

onChange()

virtual void IParameterized::onChange ( )

inlinevirtualinherited

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

Reimplemented in IProfileRipple, 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, InterferenceFunction3DLattice, InterferenceFunction2DLattice, Lattice, and Lattice2D.

Definition at line 58 of file IParameterized.h.

{}

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

removeParameter()

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

inherited

Definition at line 88 of file IParameterized.cpp.

{
    m_pool->removeParameter(name);
}

References IParameterized::m_pool.

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

removeVector()

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

inherited

Definition at line 93 of file IParameterized.cpp.

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

References IParameterized::removeParameter(), IParameterized::XComponentName(), IParameterized::YComponentName(), and IParameterized::ZComponentName().

Referenced by IParticle::registerPosition().

Here is the call graph for this function:

XComponentName()

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

staticinherited

Definition at line 100 of file IParameterized.cpp.

{
    return base_name + "X";
}

Referenced by Lattice::registerBasisVectors(), IParticle::registerPosition(), IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

YComponentName()

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

staticinherited

Definition at line 105 of file IParameterized.cpp.

{
    return base_name + "Y";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

ZComponentName()

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

staticinherited

Definition at line 110 of file IParameterized.cpp.

{
    return base_name + "Z";
}

Referenced by IParameterized::registerVector(), IParameterized::removeVector(), and IParameterized::setVectorValue().

setName()

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

inlineinherited

Definition at line 68 of file IParameterized.h.

{ m_name = name; }

References IParameterized::m_name.

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

getName()

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

inlineinherited

Definition at line 69 of file IParameterized.h.

{ return m_name; }

References IParameterized::m_name.

Referenced by Beam::Beam(), Layer::clone(), IFormFactorBorn::computeSlicingEffects(), ConvolutionDetectorResolution::ConvolutionDetectorResolution(), INode::copyNumber(), IParameterized::createParameterTree(), IFormFactor::createSlicedFormFactor(), SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), INode::displayName(), IDetector::IDetector(), Instrument::Instrument(), IParameterized::IParameterized(), Beam::operator=(), SampleBuilderNode::operator=(), anonymous_namespace{ParticleLayout.cpp}::particleDensityIsProvidedByInterference(), IParameterized::registerParameter(), SampleBuilderNode::SampleBuilderNode(), and IFormFactor::sliceFormFactor().

Member Data Documentation

m_integrate_xi

bool InterferenceFunctionFinite2DLattice::m_integrate_xi

private

Integrate over the orientation xi.

Definition at line 60 of file InterferenceFunctionFinite2DLattice.h.

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

mP_lattice

std::unique_ptr<Lattice2D> InterferenceFunctionFinite2DLattice::mP_lattice

private

Definition at line 61 of file InterferenceFunctionFinite2DLattice.h.

Referenced by clone(), getChildren(), getParticleDensity(), iff_without_dw(), interferenceForXi(), lattice(), setIntegrationOverXi(), and setLattice().

m_N_1

unsigned InterferenceFunctionFinite2DLattice::m_N_1

private

Definition at line 62 of file InterferenceFunctionFinite2DLattice.h.

Referenced by clone(), interferenceForXi(), and numberUnitCells1().

m_N_2

unsigned InterferenceFunctionFinite2DLattice::m_N_2

private

Size of the finite lattice in lattice units.

Definition at line 62 of file InterferenceFunctionFinite2DLattice.h.

Referenced by clone(), interferenceForXi(), and numberUnitCells2().

m_qx

double InterferenceFunctionFinite2DLattice::m_qx

mutableprivate

Definition at line 63 of file InterferenceFunctionFinite2DLattice.h.

Referenced by iff_without_dw(), and interferenceForXi().

m_qy

double InterferenceFunctionFinite2DLattice::m_qy

mutableprivate

Definition at line 64 of file InterferenceFunctionFinite2DLattice.h.

Referenced by iff_without_dw(), and interferenceForXi().

m_position_var

double IInterferenceFunction::m_position_var

protectedinherited

Definition at line 52 of file IInterferenceFunction.h.

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

m_parent

const INode* INode::m_parent {nullptr}

privateinherited

Definition at line 81 of file INode.h.

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

m_NP

const size_t INode::m_NP

protectedinherited

Definition at line 86 of file INode.h.

Referenced by INode::INode().

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 87 of file INode.h.

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

m_name

std::string IParameterized::m_name

privateinherited

Definition at line 72 of file IParameterized.h.

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

m_pool

std::unique_ptr<ParameterPool> IParameterized::m_pool

privateinherited

parameter pool (kind of pointer-to-implementation)

Definition at line 73 of file IParameterized.h.

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

---

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

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