Inheritance diagram for InterferenceFunction2DParaCrystal:

Collaboration diagram for InterferenceFunction2DParaCrystal:

Public Member Functions
	InterferenceFunction2DParaCrystal (const Lattice2D &lattice, double damping_length, double domain_size_1, double domain_size_2)

	InterferenceFunction2DParaCrystal (double length_1, double length_2, double alpha, double xi, double damping_length)

	~InterferenceFunction2DParaCrystal () final

InterferenceFunction2DParaCrystal *	clone () const override final

void	accept (INodeVisitor *visitor) const override final

void	setDomainSizes (double size_1, double size_2)

void	setProbabilityDistributions (const IFTDistribution2D &pdf_1, const IFTDistribution2D &pdf_2)

void	setDampingLength (double damping_length)

std::vector< double >	domainSizes () const

void	setIntegrationOverXi (bool integrate_xi)

bool	integrationOverXi () const

double	dampingLength () const

const Lattice2D &	lattice () const

double	getParticleDensity () const override final

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

const IFTDistribution2D *	pdf1 () const

const IFTDistribution2D *	pdf2 () const

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 InterferenceFunction2DParaCrystal *	createSquare (double lattice_length, double damping_length, double domain_size_1, double domain_size_2)

static InterferenceFunction2DParaCrystal *	createHexagonal (double lattice_length, double damping_length, double domain_size_1, double domain_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

double	interference1D (double qx, double qy, double xi, size_t index) const

complex_t	FTPDF (double qx, double qy, double xi, size_t index) const

void	transformToPrincipalAxes (double qx, double qy, double gamma, double delta, double &q_pa_1, double &q_pa_2) const

Private Attributes
bool	m_integrate_xi

std::unique_ptr< IFTDistribution2D >	m_pdf1

std::unique_ptr< IFTDistribution2D >	m_pdf2

std::unique_ptr< Lattice2D >	m_lattice

double	m_damping_length

double	m_domain_sizes [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 2D paracrystal.

Definition at line 29 of file InterferenceFunction2DParaCrystal.h.

Constructor & Destructor Documentation

◆ InterferenceFunction2DParaCrystal() [1/2]

InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal	(	const Lattice2D &	lattice,
		double	damping_length,
		double	domain_size_1,
		double	domain_size_2
	)

Definition at line 22 of file InterferenceFunction2DParaCrystal.cpp.

     : IInterferenceFunction(0), m_integrate_xi(false), m_damping_length(damping_length)
 {
     setName("Interference2DParaCrystal");
     setLattice(lattice);
     setDomainSizes(domain_size_1, domain_size_2);
     registerParameter("DampingLength", &m_damping_length).setUnit("nm").setNonnegative();
     registerParameter("DomainSize1", &m_domain_sizes[0]).setUnit("nm").setNonnegative();
     registerParameter("DomainSize2", &m_domain_sizes[1]).setUnit("nm").setNonnegative();
 }

References lattice(), m_damping_length, m_domain_sizes, IParameterized::registerParameter(), setDomainSizes(), setLattice(), IParameterized::setName(), RealParameter::setNonnegative(), and RealParameter::setUnit().

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

Here is the call graph for this function:

◆ InterferenceFunction2DParaCrystal() [2/2]

InterferenceFunction2DParaCrystal::InterferenceFunction2DParaCrystal	(	double	length_1,
		double	length_2,
		double	alpha,
		double	xi,
		double	damping_length
	)

Constructor of interference function of two-dimensional paracrystal.

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
damping_length	the damping (coherence) length of the paracrystal in nanometers

Definition at line 43 of file InterferenceFunction2DParaCrystal.cpp.

     : InterferenceFunction2DParaCrystal(BasicLattice(length_1, length_2, alpha, xi), damping_length,
                                         0, 0)
 {
 }

◆ ~InterferenceFunction2DParaCrystal()

InterferenceFunction2DParaCrystal::~InterferenceFunction2DParaCrystal ( )

finaldefault

Member Function Documentation

◆ clone()

InterferenceFunction2DParaCrystal * InterferenceFunction2DParaCrystal::clone ( ) const

finaloverridevirtual

Returns a clone of this ISample object.

Implements IInterferenceFunction.

Definition at line 54 of file InterferenceFunction2DParaCrystal.cpp.

 {
     auto* ret = new InterferenceFunction2DParaCrystal(*m_lattice, m_damping_length,
                                                       m_domain_sizes[0], m_domain_sizes[1]);
     ret->setPositionVariance(m_position_var);
     if (m_pdf1 && m_pdf2)
         ret->setProbabilityDistributions(*m_pdf1, *m_pdf2);
     ret->setIntegrationOverXi(m_integrate_xi);
     return ret;
 }

References InterferenceFunction2DParaCrystal(), m_damping_length, m_domain_sizes, m_integrate_xi, m_lattice, m_pdf1, m_pdf2, and IInterferenceFunction::m_position_var.

Here is the call graph for this function:

◆ accept()

void InterferenceFunction2DParaCrystal::accept ( INodeVisitor * visitor ) const

inlinefinaloverridevirtual

Calls the INodeVisitor's visit method.

Implements INode.

Definition at line 42 of file InterferenceFunction2DParaCrystal.h.

42 { visitor->visit(this); }

INodeVisitor::visit

virtual void visit(const BasicLattice *)

Definition: INodeVisitor.h:154

◆ createSquare()

InterferenceFunction2DParaCrystal * InterferenceFunction2DParaCrystal::createSquare	(	double	lattice_length,
		double	damping_length,
		double	domain_size_1,
		double	domain_size_2
	)

static

Creates square lattice.

Parameters

lattice_length	length of first and second lattice vectors in nanometers
damping_length	the damping (coherence) length of the paracrystal in nanometers
domain_size_1	size of the coherent domain along the first basis vector in nanometers
domain_size_2	size of the coherent domain along the second basis vector in nanometers

Definition at line 121 of file InterferenceFunction2DParaCrystal.cpp.

 {
     auto result = new InterferenceFunction2DParaCrystal(
         SquareLattice(lattice_length), damping_length, domain_size_1, domain_size_2);
     result->setIntegrationOverXi(true);
     return result;
 }

References InterferenceFunction2DParaCrystal().

Referenced by RectParaCrystalBuilder::buildSample().

Here is the call graph for this function:

◆ createHexagonal()

InterferenceFunction2DParaCrystal * InterferenceFunction2DParaCrystal::createHexagonal	(	double	lattice_length,
		double	damping_length,
		double	domain_size_1,
		double	domain_size_2
	)

static

Creates hexagonal lattice.

Parameters

lattice_length	length of first and second lattice vectors in nanometers
damping_length	the damping (coherence) length of the paracrystal in nanometers
domain_size_1	size of the coherent domain along the first basis vector in nanometers
domain_size_2	size of the coherent domain along the second basis vector in nanometers

Definition at line 137 of file InterferenceFunction2DParaCrystal.cpp.

 {
     auto result = new InterferenceFunction2DParaCrystal(
         HexagonalLattice(lattice_length, 0.), damping_length, domain_size_1, domain_size_2);
     result->setIntegrationOverXi(true);
     return result;
 }

References InterferenceFunction2DParaCrystal().

Referenced by HexParaCrystalBuilder::buildSample().

Here is the call graph for this function:

◆ setDomainSizes()

void InterferenceFunction2DParaCrystal::setDomainSizes	(	double	size_1,
		double	size_2
	)

Sets the sizes of coherence domains.

Parameters

size_1	coherence domain size along the first basis vector in nanometers
size_2	coherence domain size along the second basis vector in nanometers

Definition at line 150 of file InterferenceFunction2DParaCrystal.cpp.

 {
     m_domain_sizes[0] = size_1;
     m_domain_sizes[1] = size_2;
 }

References m_domain_sizes.

Referenced by Basic2DParaCrystalBuilder::buildSample(), RectParaCrystalBuilder::buildSample(), and InterferenceFunction2DParaCrystal().

◆ setProbabilityDistributions()

void InterferenceFunction2DParaCrystal::setProbabilityDistributions	(	const IFTDistribution2D &	pdf_1,
		const IFTDistribution2D &	pdf_2
	)

Sets the probability distributions (Fourier transformed) for the two lattice directions.

Parameters

pdf_1	probability distribution in first lattice direction
pdf_2	probability distribution in second lattice direction

Definition at line 69 of file InterferenceFunction2DParaCrystal.cpp.

 {
     m_pdf1.reset(pdf_1.clone());
     registerChild(m_pdf1.get());
     m_pdf2.reset(pdf_2.clone());
     registerChild(m_pdf2.get());
 }

References IFTDistribution2D::clone(), m_pdf1, m_pdf2, and INode::registerChild().

Referenced by Basic2DParaCrystalBuilder::buildSample().

Here is the call graph for this function:

◆ setDampingLength()

void InterferenceFunction2DParaCrystal::setDampingLength ( double damping_length )

Sets the damping length.

Parameters

damping_length the damping (coherence) length of the paracrystal in nanometers

Definition at line 81 of file InterferenceFunction2DParaCrystal.cpp.

 {
     m_damping_length = damping_length;
 }

References m_damping_length.

◆ domainSizes()

std::vector< double > InterferenceFunction2DParaCrystal::domainSizes ( ) const

Definition at line 233 of file InterferenceFunction2DParaCrystal.cpp.

 {
     return {m_domain_sizes[0], m_domain_sizes[1]};
 }

References m_domain_sizes.

◆ setIntegrationOverXi()

void InterferenceFunction2DParaCrystal::setIntegrationOverXi ( bool integrate_xi )

Enables/disables averaging over the lattice rotation angle.

Parameters

integrate_xi integration flag

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

inline

Definition at line 63 of file InterferenceFunction2DParaCrystal.h.

63 { return m_integrate_xi; }

References m_integrate_xi.

◆ dampingLength()

double InterferenceFunction2DParaCrystal::dampingLength ( ) const

inline

Definition at line 64 of file InterferenceFunction2DParaCrystal.h.

64 { return m_damping_length; }

References m_damping_length.

◆ lattice()

const Lattice2D & InterferenceFunction2DParaCrystal::lattice ( ) const

Definition at line 247 of file InterferenceFunction2DParaCrystal.cpp.

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

References m_lattice.

Referenced by InterferenceFunction2DParaCrystal(), and setLattice().

◆ getParticleDensity()

double InterferenceFunction2DParaCrystal::getParticleDensity ( ) const

finaloverridevirtual

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

Otherwise, returns zero or a user-defined value

Reimplemented from IInterferenceFunction.

Definition at line 86 of file InterferenceFunction2DParaCrystal.cpp.

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

References m_lattice.

◆ getChildren()

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

finaloverridevirtual

Returns a vector of children (const).

Reimplemented from INode.

Definition at line 92 of file InterferenceFunction2DParaCrystal.cpp.

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

References m_lattice, m_pdf1, and m_pdf2.

◆ pdf1()

const IFTDistribution2D* InterferenceFunction2DParaCrystal::pdf1 ( ) const

inline

Definition at line 72 of file InterferenceFunction2DParaCrystal.h.

72 { return m_pdf1.get(); }

References m_pdf1.

◆ pdf2()

const IFTDistribution2D* InterferenceFunction2DParaCrystal::pdf2 ( ) const

inline

Definition at line 74 of file InterferenceFunction2DParaCrystal.h.

74 { return m_pdf2.get(); }

References m_pdf2.

◆ iff_without_dw()

double InterferenceFunction2DParaCrystal::iff_without_dw ( const kvector_t q ) const

finaloverrideprivatevirtual

Calculates the structure factor without Debye-Waller factor.

Implements IInterferenceFunction.

Definition at line 97 of file InterferenceFunction2DParaCrystal.cpp.

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

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

Here is the call graph for this function:

◆ setLattice()

void InterferenceFunction2DParaCrystal::setLattice ( const Lattice2D & lattice )

private

Definition at line 108 of file InterferenceFunction2DParaCrystal.cpp.

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

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

Referenced by InterferenceFunction2DParaCrystal().

Here is the call graph for this function:

◆ interferenceForXi()

double InterferenceFunction2DParaCrystal::interferenceForXi ( double xi ) const

private

Returns interference function for fixed angle xi.

Definition at line 165 of file InterferenceFunction2DParaCrystal.cpp.

 {
     // don't touch order of computation; problems under Windows
     double rx = interference1D(m_qx, m_qy, xi, 0);
     double ry = interference1D(m_qx, m_qy, xi + m_lattice->latticeAngle(), 1);
     return rx * ry;
 }

References interference1D(), m_lattice, m_qx, and m_qy.

Referenced by iff_without_dw().

Here is the call graph for this function:

◆ interference1D()

double InterferenceFunction2DParaCrystal::interference1D	(	double	qx,
		double	qy,
		double	xi,
		size_t	index
	)		const

private

Returns interference function for fixed xi in the dimension determined by the given index.

Definition at line 174 of file InterferenceFunction2DParaCrystal.cpp.

 {
     if (index > 1)
         throw Exceptions::OutOfBoundsException(
             "InterferenceFunction2DParaCrystal::"
             "interference1D() -> Error! Index of interference function "
             "probability must be < 2");
     if (!m_pdf1 || !m_pdf2)
         throw Exceptions::NullPointerException(
             "InterferenceFunction2DParaCrystal::"
             "interference1D() -> Error! Probability distributions for "
             "interference function not properly initialized");
  
     double length = index ? m_lattice->length2() : m_lattice->length1();
     int n = static_cast<int>(std::abs(m_domain_sizes[index] / length));
     double nd = static_cast<double>(n);
     complex_t fp = FTPDF(qx, qy, xi, index);
     if (n < 1)
         return ((1.0 + fp) / (1.0 - fp)).real();
     if (std::norm(1.0 - fp) < std::numeric_limits<double>::epsilon())
         return nd;
     // for (1-fp)*nd small, take the series expansion to second order in nd*(1-fp)
     if (std::abs(1.0 - fp) * nd < 2e-4) {
         complex_t intermediate =
             (nd - 1.0) / 2.0 + (nd * nd - 1.0) * (fp - 1.0) / 6.0
             + (nd * nd * nd - 2.0 * nd * nd - nd + 2.0) * (fp - 1.0) * (fp - 1.0) / 24.0;
         return 1.0 + 2.0 * intermediate.real();
     }
     complex_t tmp;
     if (std::abs(fp) == 0.0
         || std::log(std::abs(fp)) * nd < std::log(std::numeric_limits<double>::min()))
         tmp = 0.0;
     else
         tmp = std::pow(fp, n);
     complex_t intermediate = fp / (1.0 - fp) - fp * (1.0 - tmp) / nd / (1.0 - fp) / (1.0 - fp);
     return 1.0 + 2.0 * intermediate.real();
 }

References FTPDF(), anonymous_namespace{BoxCompositionBuilder.cpp}::length, m_domain_sizes, m_lattice, m_pdf1, and m_pdf2.

Referenced by interferenceForXi().

Here is the call graph for this function:

◆ FTPDF()

complex_t InterferenceFunction2DParaCrystal::FTPDF	(	double	qx,
		double	qy,
		double	xi,
		size_t	index
	)		const

private

Definition at line 213 of file InterferenceFunction2DParaCrystal.cpp.

 {
     double length = (index ? m_lattice->length2() : m_lattice->length1());
  
     const IFTDistribution2D* pdf = (index ? m_pdf2.get() : m_pdf1.get());
     double qa = qx * length * std::cos(xi) + qy * length * std::sin(xi);
     complex_t phase = exp_I(qa);
     // transform q to principal axes:
     double qp1, qp2;
     double gamma = xi + pdf->gamma();
     double delta = pdf->delta();
     transformToPrincipalAxes(qx, qy, gamma, delta, qp1, qp2);
     double amplitude = pdf->evaluate(qp1, qp2);
     complex_t result = phase * amplitude;
     if (m_damping_length != 0.0)
         result *= std::exp(-length / m_damping_length);
     return result;
 }

References IFTDistribution2D::delta(), IFTDistribution2D::evaluate(), exp_I(), IFTDistribution2D::gamma(), anonymous_namespace{BoxCompositionBuilder.cpp}::length, m_damping_length, m_lattice, m_pdf1, m_pdf2, and transformToPrincipalAxes().

Referenced by interference1D().

Here is the call graph for this function:

◆ transformToPrincipalAxes()

void InterferenceFunction2DParaCrystal::transformToPrincipalAxes	(	double	qx,
		double	qy,
		double	gamma,
		double	delta,
		double &	q_pa_1,
		double &	q_pa_2
	)		const

private

Definition at line 156 of file InterferenceFunction2DParaCrystal.cpp.

 {
     q_pa_1 = qx * std::cos(gamma) + qy * std::sin(gamma);
     q_pa_2 = qx * std::cos(gamma + delta) + qy * std::sin(gamma + delta);
 }

Referenced by FTPDF().

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

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(), setLattice(), InterferenceFunction2DSuperLattice::setLattice(), InterferenceFunctionFinite2DLattice::setLattice(), InterferenceFunctionRadialParaCrystal::setProbabilityDistribution(), 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.

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