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)

	~InterferenceFunction2DSuperLattice () final

InterferenceFunction2DSuperLattice *	clone () const override final

void	accept (INodeVisitor *visitor) const override final

void	setSubstructureIFF (const IInterferenceFunction &sub_iff)

const IInterferenceFunction &	substructureIFF () const

double	evaluate (const kvector_t q, double outer_iff=1.0) const override final

unsigned	domainSize1 () const

unsigned	domainSize2 () const

void	setIntegrationOverXi (bool integrate_xi)

bool	integrationOverXi () const

const Lattice2D &	lattice () const

std::vector< const INode * >	getChildren () const override final

void	setPositionVariance (double var)

double	positionVariance () const

virtual double	getParticleDensity () 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 InterferenceFunction2DSuperLattice *	createSquare (double lattice_length, double xi, unsigned size_1, unsigned size_2)

static InterferenceFunction2DSuperLattice *	createHexagonal (double lattice_length, double xi, unsigned size_1, unsigned size_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

std::unique_ptr< IInterferenceFunction >	mP_substructure

unsigned	m_size_1

unsigned	m_size_2

double	m_outer_iff

double	m_qx

double	m_qy

double	m_xi

const INode *	m_parent {nullptr}

std::string	m_name

std::unique_ptr< ParameterPool >	m_pool

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 25 of file InterferenceFunction2DSuperLattice.cpp.

     : IInterferenceFunction(0), m_integrate_xi(false), mP_substructure(nullptr), m_size_1(size_1),
       m_size_2(size_2)
 {
     setName("Interference2DSuperLattice");
     setLattice(lattice);
     setSubstructureIFF(InterferenceFunctionNone());
 }

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

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

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 43 of file InterferenceFunction2DSuperLattice.cpp.

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

◆ ~InterferenceFunction2DSuperLattice()

InterferenceFunction2DSuperLattice::~InterferenceFunction2DSuperLattice ( )

finaldefault

Member Function Documentation

◆ clone()

InterferenceFunction2DSuperLattice * InterferenceFunction2DSuperLattice::clone ( ) const

finaloverridevirtual

Returns a clone of this ISample object.

Implements IInterferenceFunction.

Definition at line 52 of file InterferenceFunction2DSuperLattice.cpp.

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

References integrationOverXi(), InterferenceFunction2DSuperLattice(), IInterferenceFunction::m_position_var, m_size_1, m_size_2, mP_lattice, and mP_substructure.

Here is the call graph for this function:

◆ accept()

void InterferenceFunction2DSuperLattice::accept ( INodeVisitor * visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 35 of file InterferenceFunction2DSuperLattice.h.

35 { visitor->visit(this); }

INodeVisitor::visit

virtual void visit(const BasicLattice *)

Definition: INodeVisitor.h:154

◆ setSubstructureIFF()

void InterferenceFunction2DSuperLattice::setSubstructureIFF ( const IInterferenceFunction & sub_iff )

Definition at line 61 of file InterferenceFunction2DSuperLattice.cpp.

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

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

Referenced by InterferenceFunction2DSuperLattice().

Here is the call graph for this function:

◆ substructureIFF()

const IInterferenceFunction & InterferenceFunction2DSuperLattice::substructureIFF ( ) const

Definition at line 67 of file InterferenceFunction2DSuperLattice.cpp.

 {
     return *mP_substructure;
 }

References mP_substructure.

◆ createSquare()

InterferenceFunction2DSuperLattice * InterferenceFunction2DSuperLattice::createSquare	(	double	lattice_length,
		double	xi,
		unsigned	size_1,
		unsigned	size_2
	)

static

Creates square lattice.

Definition at line 76 of file InterferenceFunction2DSuperLattice.cpp.

 {
     return new InterferenceFunction2DSuperLattice(SquareLattice(lattice_length, xi), size_1,
                                                   size_2);
 }

References InterferenceFunction2DSuperLattice().

Referenced by SuperLatticeBuilder::buildSample().

Here is the call graph for this function:

◆ createHexagonal()

InterferenceFunction2DSuperLattice * InterferenceFunction2DSuperLattice::createHexagonal	(	double	lattice_length,
		double	xi,
		unsigned	size_1,
		unsigned	size_2
	)

static

Creates hexagonal lattice.

Definition at line 87 of file InterferenceFunction2DSuperLattice.cpp.

 {
     return new InterferenceFunction2DSuperLattice(HexagonalLattice(lattice_length, xi), size_1,
                                                   size_2);
 }

References InterferenceFunction2DSuperLattice().

Here is the call graph for this function:

◆ evaluate()

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

finaloverridevirtual

Evaluates the interference function for a given wavevector transfer.

Reimplemented from IInterferenceFunction.

Definition at line 94 of file InterferenceFunction2DSuperLattice.cpp.

 {
     m_outer_iff = outer_iff;
     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_outer_iff, m_qx, m_qy, M_TWOPI, mP_lattice, BasicVector3D< T >::x(), and BasicVector3D< T >::y().

Here is the call graph for this function:

◆ domainSize1()

unsigned InterferenceFunction2DSuperLattice::domainSize1 ( ) const

inline

Definition at line 46 of file InterferenceFunction2DSuperLattice.h.

46 { return m_size_1; }

References m_size_1.

◆ domainSize2()

unsigned InterferenceFunction2DSuperLattice::domainSize2 ( ) const

inline

Definition at line 47 of file InterferenceFunction2DSuperLattice.h.

47 { return m_size_2; }

References m_size_2.

◆ setIntegrationOverXi()

void InterferenceFunction2DSuperLattice::setIntegrationOverXi ( bool integrate_xi )

Definition at line 106 of file InterferenceFunction2DSuperLattice.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 InterferenceFunction2DSuperLattice::integrationOverXi ( ) const

inline

Definition at line 50 of file InterferenceFunction2DSuperLattice.h.

50 { return m_integrate_xi; }

References m_integrate_xi.

Referenced by clone().

◆ lattice()

const Lattice2D & InterferenceFunction2DSuperLattice::lattice ( ) const

Definition at line 112 of file InterferenceFunction2DSuperLattice.cpp.

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

References mP_lattice.

Referenced by InterferenceFunction2DSuperLattice(), and setLattice().

◆ getChildren()

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

finaloverridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 120 of file InterferenceFunction2DSuperLattice.cpp.

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

References mP_lattice, and mP_substructure.

◆ iff_without_dw()

double InterferenceFunction2DSuperLattice::iff_without_dw ( const kvector_t q ) const

finaloverrideprivatevirtual

Calculates the structure factor without Debye-Waller factor.

Implements IInterferenceFunction.

Definition at line 125 of file InterferenceFunction2DSuperLattice.cpp.

 {
     using MathFunctions::Laue;
  
     const double a = mP_lattice->length1();
     const double b = mP_lattice->length2();
     const double xialpha = m_xi + mP_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 MathFunctions::Laue(), m_size_1, m_size_2, m_xi, mP_lattice, BasicVector3D< T >::x(), and BasicVector3D< T >::y().

Here is the call graph for this function:

◆ setLattice()

void InterferenceFunction2DSuperLattice::setLattice ( const Lattice2D & lattice )

private

Definition at line 139 of file InterferenceFunction2DSuperLattice.cpp.

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

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

Referenced by InterferenceFunction2DSuperLattice().

Here is the call graph for this function:

◆ interferenceForXi()

double InterferenceFunction2DSuperLattice::interferenceForXi ( double xi ) const

private

Definition at line 145 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 - mP_lattice->rotationAngle();
     return mP_substructure->evaluate(q.rotatedZ(-delta_xi), outer_iff);
 }

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

Referenced by evaluate().

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.

39 { return m_position_var; }

References IInterferenceFunction::m_position_var.

Referenced by SampleToPython::defineInterferenceFunctions().

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

43 { return 0.0; }

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

46 { 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 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.

37 { 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().

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.

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

IParameterized::m_pool

std::unique_ptr< ParameterPool > m_pool

parameter pool (kind of pointer-to-implementation)

Definition: IParameterized.h:73

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.

58 {}

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));
 }