Inheritance diagram for InterferenceFunction2DLattice:

Collaboration diagram for InterferenceFunction2DLattice:

Public Member Functions
	InterferenceFunction2DLattice (double length_1, double length_2, double alpha, double xi)

	InterferenceFunction2DLattice (const Lattice2D &lattice)

	~InterferenceFunction2DLattice () final

InterferenceFunction2DLattice *	clone () const override final

void	accept (INodeVisitor *visitor) const override final

void	setDecayFunction (const IFTDecayFunction2D &decay)

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

void	onChange () 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

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 InterferenceFunction2DLattice *	createSquare (double lattice_length, double xi)

static InterferenceFunction2DLattice *	createHexagonal (double lattice_length, double xi)

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

double	interferenceAtOneRecLatticePoint (double qx, double qy) const

std::pair< double, double >	rotateOrthonormal (double qx, double qy, double gamma) const

std::pair< double, double >	calculateReciprocalVectorFraction (double qx, double qy, double xi) const

void	initialize_rec_vectors ()

void	initialize_calc_factors ()

Private Attributes
bool	m_integrate_xi

std::unique_ptr< IFTDecayFunction2D >	m_decay

std::unique_ptr< Lattice2D >	m_lattice

Lattice2D::ReciprocalBases	m_sbase

int	m_na

int	m_nb

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 2D lattice.

Definition at line 26 of file InterferenceFunction2DLattice.h.

Constructor & Destructor Documentation

◆ InterferenceFunction2DLattice() [1/2]

InterferenceFunction2DLattice::InterferenceFunction2DLattice	(	double	length_1,
		double	length_2,
		double	alpha,
		double	xi
	)

Constructor of two-dimensional interference function.

Parameters

length_1	length of the first basis vector in nanometers
length_2	length of the second basis vector in nanometers
alpha	angle between the basis vectors in radians
xi	rotation of the lattice with respect to the x-axis (beam direction) in radians

Definition at line 41 of file InterferenceFunction2DLattice.cpp.

     : InterferenceFunction2DLattice(BasicLattice(length_1, length_2, alpha, xi))
 {
 }

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

◆ InterferenceFunction2DLattice() [2/2]

InterferenceFunction2DLattice::InterferenceFunction2DLattice ( const Lattice2D & lattice )

Definition at line 29 of file InterferenceFunction2DLattice.cpp.

     : IInterferenceFunction(0), m_integrate_xi(false)
 {
     setName("Interference2DLattice");
     setLattice(lattice);
 }

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

Here is the call graph for this function:

◆ ~InterferenceFunction2DLattice()

InterferenceFunction2DLattice::~InterferenceFunction2DLattice ( )

finaldefault

Member Function Documentation

◆ clone()

InterferenceFunction2DLattice * InterferenceFunction2DLattice::clone ( ) const

finaloverridevirtual

Returns a clone of this ISample object.

Implements IInterferenceFunction.

Definition at line 49 of file InterferenceFunction2DLattice.cpp.

 {
     auto* ret = new InterferenceFunction2DLattice(*m_lattice);
     ret->setPositionVariance(m_position_var);
     ret->setIntegrationOverXi(integrationOverXi());
     if (m_decay)
         ret->setDecayFunction(*m_decay);
     return ret;
 }

References integrationOverXi(), InterferenceFunction2DLattice(), m_decay, m_lattice, and IInterferenceFunction::m_position_var.

Here is the call graph for this function:

◆ accept()

void InterferenceFunction2DLattice::accept ( INodeVisitor * visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 35 of file InterferenceFunction2DLattice.h.

35 { visitor->visit(this); }

INodeVisitor::visit

virtual void visit(const BasicLattice *)

Definition: INodeVisitor.h:154

◆ createSquare()

InterferenceFunction2DLattice * InterferenceFunction2DLattice::createSquare	(	double	lattice_length,
		double	xi
	)

static

Creates square lattice.

Parameters

lattice_length	length of the first and second basis vectors in nanometers
xi	rotation of the lattice with respect to the x-axis in radians

Definition at line 62 of file InterferenceFunction2DLattice.cpp.

 {
     return new InterferenceFunction2DLattice(SquareLattice(lattice_length, xi));
 }

References InterferenceFunction2DLattice().

Referenced by BoxesSquareLatticeBuilder::buildSample(), SquareLatticeBuilder::buildSample(), and RotatedSquareLatticeBuilder::buildSample().

Here is the call graph for this function:

◆ createHexagonal()

InterferenceFunction2DLattice * InterferenceFunction2DLattice::createHexagonal	(	double	lattice_length,
		double	xi
	)

static

Creates hexagonal lattice.

Parameters

lattice_length	length of the first and second basis vectors in nanometers
xi	rotation of the lattice with respect to the x-axis in radians

Definition at line 71 of file InterferenceFunction2DLattice.cpp.

 {
     return new InterferenceFunction2DLattice(HexagonalLattice(lattice_length, xi));
 }

References InterferenceFunction2DLattice().

Referenced by ParticleCompositionBuilder::buildSample().

Here is the call graph for this function:

◆ setDecayFunction()

void InterferenceFunction2DLattice::setDecayFunction ( const IFTDecayFunction2D & decay )

Sets two-dimensional decay function.

Parameters

decay two-dimensional decay function in reciprocal space

Definition at line 79 of file InterferenceFunction2DLattice.cpp.

 {
     m_decay.reset(decay.clone());
     registerChild(m_decay.get());
     initialize_calc_factors();
 }

References IFTDecayFunction2D::clone(), initialize_calc_factors(), m_decay, and INode::registerChild().

Referenced by CenteredSquareLatticeBuilder::buildSample().

Here is the call graph for this function:

◆ setIntegrationOverXi()

void InterferenceFunction2DLattice::setIntegrationOverXi ( bool integrate_xi )

Definition at line 86 of file InterferenceFunction2DLattice.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.

◆ integrationOverXi()

bool InterferenceFunction2DLattice::integrationOverXi ( ) const

inline

Definition at line 43 of file InterferenceFunction2DLattice.h.

43 { return m_integrate_xi; }

References m_integrate_xi.

Referenced by clone().

◆ lattice()

const Lattice2D & InterferenceFunction2DLattice::lattice ( ) const

Definition at line 92 of file InterferenceFunction2DLattice.cpp.

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

References m_lattice.

Referenced by InterferenceFunction2DLattice(), and setLattice().

◆ getParticleDensity()

double InterferenceFunction2DLattice::getParticleDensity ( ) const

finaloverridevirtual

Returns the particle density associated with this 2d lattice.

Reimplemented from IInterferenceFunction.

Definition at line 100 of file InterferenceFunction2DLattice.cpp.

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

References m_lattice.

Referenced by interferenceForXi().

◆ getChildren()

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

finaloverridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 106 of file InterferenceFunction2DLattice.cpp.

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

References m_decay, and m_lattice.

◆ onChange()

void InterferenceFunction2DLattice::onChange ( )

finaloverridevirtual

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

Reimplemented from IParameterized.

Definition at line 111 of file InterferenceFunction2DLattice.cpp.

 {
     initialize_rec_vectors();
     initialize_calc_factors();
 }

References initialize_calc_factors(), and initialize_rec_vectors().

Here is the call graph for this function:

◆ iff_without_dw()

double InterferenceFunction2DLattice::iff_without_dw ( const kvector_t q ) const

finaloverrideprivatevirtual

Calculates the structure factor without Debye-Waller factor.

Implements IInterferenceFunction.

Definition at line 117 of file InterferenceFunction2DLattice.cpp.

 {
     if (!m_decay)
         throw Exceptions::NullPointerException("InterferenceFunction2DLattice::evaluate"
                                                " -> Error! No decay function defined.");
     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_decay, m_integrate_xi, m_lattice, m_qx, m_qy, M_TWOPI, BasicVector3D< T >::x(), and BasicVector3D< T >::y().

Here is the call graph for this function:

◆ setLattice()

void InterferenceFunction2DLattice::setLattice ( const Lattice2D & lattice )

private

Definition at line 131 of file InterferenceFunction2DLattice.cpp.

 {
     m_lattice.reset(lattice.clone());
     registerChild(m_lattice.get());
     initialize_rec_vectors();
 }

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

Referenced by InterferenceFunction2DLattice().

Here is the call graph for this function:

◆ interferenceForXi()

double InterferenceFunction2DLattice::interferenceForXi ( double xi ) const

private

Definition at line 138 of file InterferenceFunction2DLattice.cpp.

 {
     double result = 0.0;
     auto q_frac = calculateReciprocalVectorFraction(m_qx, m_qy, xi);
  
     for (int i = -m_na - 1; i < m_na + 2; ++i) {
         for (int j = -m_nb - 1; j < m_nb + 2; ++j) {
             double qx = q_frac.first + i * m_sbase.m_asx + j * m_sbase.m_bsx;
             double qy = q_frac.second + i * m_sbase.m_asy + j * m_sbase.m_bsy;
             result += interferenceAtOneRecLatticePoint(qx, qy);
         }
     }
     return getParticleDensity() * result;
 }

References calculateReciprocalVectorFraction(), getParticleDensity(), interferenceAtOneRecLatticePoint(), Lattice2D::ReciprocalBases::m_asx, Lattice2D::ReciprocalBases::m_asy, Lattice2D::ReciprocalBases::m_bsx, Lattice2D::ReciprocalBases::m_bsy, m_na, m_nb, m_qx, m_qy, and m_sbase.

Referenced by iff_without_dw().

Here is the call graph for this function:

◆ interferenceAtOneRecLatticePoint()

double InterferenceFunction2DLattice::interferenceAtOneRecLatticePoint	(	double	qx,
		double	qy
	)		const

private

Returns interference from a single reciprocal lattice vector.

Definition at line 153 of file InterferenceFunction2DLattice.cpp.

 {
     if (!m_decay)
         throw Exceptions::NullPointerException(
             "InterferenceFunction2DLattice::interferenceAtOneRecLatticePoint"
             " -> Error! No decay function defined.");
     double gamma = m_decay->gamma();
     auto qXY = rotateOrthonormal(qx, qy, gamma);
     return m_decay->evaluate(qXY.first, qXY.second);
 }

References m_decay, and rotateOrthonormal().

Referenced by interferenceForXi().

Here is the call graph for this function:

◆ rotateOrthonormal()

std::pair< double, double > InterferenceFunction2DLattice::rotateOrthonormal	(	double	qx,
		double	qy,
		double	gamma
	)		const

private

Returns reciprocal coordinates in the coordinate system rotated by the angle gamma.

Definition at line 165 of file InterferenceFunction2DLattice.cpp.

 {
     double q_X = qx * std::cos(gamma) + qy * std::sin(gamma);
     double q_Y = -qx * std::sin(gamma) + qy * std::cos(gamma);
     return {q_X, q_Y};
 }

Referenced by interferenceAtOneRecLatticePoint().

◆ calculateReciprocalVectorFraction()

std::pair< double, double > InterferenceFunction2DLattice::calculateReciprocalVectorFraction	(	double	qx,
		double	qy,
		double	xi
	)		const

private

Returns qx,qy coordinates of q - qint, where qint is a reciprocal lattice vector bounding the reciprocal unit cell to which q belongs.

Definition at line 177 of file InterferenceFunction2DLattice.cpp.

 {
     double a = m_lattice->length1();
     double b = m_lattice->length2();
     double alpha = m_lattice->latticeAngle();
     // first rotate the input to the system of m_sbase:
     double qx_rot = qx * std::cos(xi) + qy * std::sin(xi);
     double qy_rot = -qx * std::sin(xi) + qy * std::cos(xi);
  
     // find the reciprocal lattice coordinates of (qx_rot, qy_rot):
     int qa_int = static_cast<int>(std::lround(a * qx_rot / M_TWOPI));
     int qb_int = static_cast<int>(
         std::lround(b * (qx_rot * std::cos(alpha) + qy_rot * std::sin(alpha)) / M_TWOPI));
     // take the fractional part only (in m_sbase coordinates)
     double qx_frac = qx_rot - qa_int * m_sbase.m_asx - qb_int * m_sbase.m_bsx;
     double qy_frac = qy_rot - qa_int * m_sbase.m_asy - qb_int * m_sbase.m_bsy;
     return {qx_frac, qy_frac};
 }

References Lattice2D::ReciprocalBases::m_asx, Lattice2D::ReciprocalBases::m_asy, Lattice2D::ReciprocalBases::m_bsx, Lattice2D::ReciprocalBases::m_bsy, m_lattice, m_sbase, and M_TWOPI.

Referenced by interferenceForXi().

◆ initialize_rec_vectors()

void InterferenceFunction2DLattice::initialize_rec_vectors ( )

private

Initializes the x,y coordinates of the a*,b* reciprocal bases.

Definition at line 198 of file InterferenceFunction2DLattice.cpp.

 {
     if (!m_lattice)
         throw std::runtime_error("InterferenceFunction2DLattice::initialize_rec_vectors() -> "
                                  "Error. No lattice defined yet");
  
     BasicLattice base_lattice(m_lattice->length1(), m_lattice->length2(), m_lattice->latticeAngle(),
                               0.);
     m_sbase = base_lattice.reciprocalBases();
 }

References m_lattice, m_sbase, and Lattice2D::reciprocalBases().

Referenced by onChange(), and setLattice().

Here is the call graph for this function:

◆ initialize_calc_factors()

void InterferenceFunction2DLattice::initialize_calc_factors ( )

private

Initializes factors needed in each calculation.

Definition at line 209 of file InterferenceFunction2DLattice.cpp.

 {
     if (!m_decay)
         throw Exceptions::NullPointerException(
             "InterferenceFunction2DLattice::initialize_calc_factors"
             " -> Error! No decay function defined.");
  
     // number of reciprocal lattice points to use
     auto q_bounds = m_decay->boundingReciprocalLatticeCoordinates(
         nmax / m_decay->decayLengthX(), nmax / m_decay->decayLengthY(), m_lattice->length1(),
         m_lattice->length2(), m_lattice->latticeAngle());
     m_na = static_cast<int>(std::lround(q_bounds.first + 0.5));
     m_nb = static_cast<int>(std::lround(q_bounds.second + 0.5));
     m_na = std::max(m_na, min_points);
     m_nb = std::max(m_nb, min_points);
 }

References m_decay, m_lattice, m_na, m_nb, anonymous_namespace{InterferenceFunction2DLattice.cpp}::min_points, and anonymous_namespace{InterferenceFunction2DLattice.cpp}::nmax.

Referenced by onChange(), and setDecayFunction().

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

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

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

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

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